From c489bcaa45e689c55b18f8b67d61a15fe3698cbd Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Mon, 7 Jun 2021 17:55:35 -0400 Subject: [PATCH] update api docs (#101528) --- api_docs/actions.json | 94 +- api_docs/advanced_settings.json | 108 +- api_docs/alerting.json | 472 +- api_docs/apm.json | 3191 +++- api_docs/apm_oss.json | 2 +- api_docs/banners.json | 8 +- api_docs/bfetch.json | 449 +- api_docs/cases.json | 15105 +++++++++++++++++-- api_docs/charts.json | 258 +- api_docs/core.json | 4036 ++++- api_docs/core_application.json | 242 +- api_docs/core_chrome.json | 142 +- api_docs/core_http.json | 10108 ++++++++++--- api_docs/core_saved_objects.json | 10009 +++++++----- api_docs/dashboard.json | 660 +- api_docs/dashboard_enhanced.json | 62 +- api_docs/data.json | 10638 ++++++++++++- api_docs/data_autocomplete.json | 12 +- api_docs/data_field_formats.json | 605 +- api_docs/data_index_patterns.json | 945 +- api_docs/data_query.json | 824 +- api_docs/data_search.json | 5794 ++++++- api_docs/data_ui.json | 40 +- api_docs/deprecations.mdx | 149 +- api_docs/dev_tools.json | 25 +- api_docs/discover.json | 75 +- api_docs/discover_enhanced.json | 109 +- api_docs/embeddable.json | 1344 +- api_docs/embeddable_enhanced.json | 38 +- api_docs/encrypted_saved_objects.json | 292 +- api_docs/enterprise_search.json | 9 +- api_docs/es_ui_shared.json | 102 +- api_docs/event_log.json | 22 +- api_docs/expressions.json | 5418 ++++++- api_docs/features.json | 138 +- api_docs/file_data_visualizer.json | 4 +- api_docs/file_upload.json | 349 +- api_docs/fleet.json | 3200 +++- api_docs/global_search.json | 101 +- api_docs/home.json | 36 +- api_docs/index_management.json | 4 +- api_docs/index_pattern_field_editor.json | 55 +- api_docs/index_pattern_management.json | 49 +- api_docs/infra.json | 146 +- api_docs/inspector.json | 150 +- api_docs/kibana_legacy.json | 31 +- api_docs/kibana_react.json | 578 +- api_docs/kibana_utils.json | 2779 +++- api_docs/lens.json | 310 +- api_docs/license_api_guard.json | 524 +- api_docs/licensing.json | 688 +- api_docs/lists.json | 525 +- api_docs/management.json | 104 +- api_docs/maps.json | 240 +- api_docs/maps_ems.json | 18 +- api_docs/metrics_entities.json | 42 +- api_docs/ml.json | 161 +- api_docs/monitoring.json | 63 +- api_docs/navigation.json | 153 +- api_docs/newsfeed.json | 12 +- api_docs/observability.json | 541 +- api_docs/plugin_directory.mdx | 140 - api_docs/presentation_util.json | 465 +- api_docs/reporting.json | 68 +- api_docs/rule_registry.json | 90 +- api_docs/runtime_fields.json | 58 +- api_docs/saved_objects.json | 820 +- api_docs/saved_objects_management.json | 219 +- api_docs/saved_objects_tagging.json | 30 +- api_docs/saved_objects_tagging_oss.json | 171 +- api_docs/screenshot_mode.json | 80 +- api_docs/security.json | 139 +- api_docs/security_oss.json | 22 +- api_docs/security_solution.json | 18 +- api_docs/share.json | 47 +- api_docs/spaces.json | 38 +- api_docs/spaces_oss.json | 208 +- api_docs/task_manager.json | 18 +- api_docs/telemetry.json | 65 +- api_docs/telemetry_collection_manager.json | 420 +- api_docs/telemetry_collection_xpack.json | 2 +- api_docs/telemetry_management_section.json | 18 +- api_docs/triggers_actions_ui.json | 676 +- api_docs/ui_actions.json | 123 +- api_docs/ui_actions_enhanced.json | 455 +- api_docs/uptime.json | 21 +- api_docs/url_forwarding.json | 28 +- api_docs/usage_collection.json | 494 +- api_docs/vis_type_timeseries.json | 60 +- api_docs/visualizations.json | 786 +- 90 files changed, 76342 insertions(+), 11825 deletions(-) delete mode 100644 api_docs/plugin_directory.mdx diff --git a/api_docs/actions.json b/api_docs/actions.json index 3b699247125041..d7c5e63434c078 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -252,7 +252,9 @@ "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 40 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "actions", @@ -276,7 +278,9 @@ "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 41 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -516,14 +520,55 @@ "label": "executor", "description": [], "signature": [ - "ExecutorType", - "" + "(options: ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionTypeExecutorOptions", + "text": "ActionTypeExecutorOptions" + }, + ") => Promise<", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionTypeExecutorResult", + "text": "ActionTypeExecutorResult" + }, + ">" ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 116 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionTypeExecutorOptions", + "text": "ActionTypeExecutorOptions" + }, + "" + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 84 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -743,7 +788,7 @@ "label": "ActionParamsType", "description": [], "signature": [ - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }" + "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"error\" | \"info\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }" ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", @@ -760,7 +805,7 @@ "label": "ActionParamsType", "description": [], "signature": [ - "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" + "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", @@ -923,7 +968,38 @@ "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" - } + }, + ">>; execute: ({ actionId, params, source, }: Pick<", + "ExecuteOptions", + ", \"source\" | \"params\" | \"actionId\">) => Promise<", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionTypeExecutorResult", + "text": "ActionTypeExecutorResult" + }, + ">; getAll: () => Promise<", + "FindActionResult", + "[]>; getBulk: (ids: string[]) => Promise<", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + ">[]>; enqueueExecution: (options: ", + "ExecuteOptions", + ") => Promise; listTypes: () => Promise<", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionType", + "text": "ActionType" + }, + "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; }" ], "source": { "path": "x-pack/plugins/actions/server/index.ts", @@ -1719,7 +1795,7 @@ "label": "config", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "x-pack/plugins/actions/common/types.ts", diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json index 791915c9fcd617..a87967f0970e92 100644 --- a/api_docs/advanced_settings.json +++ b/api_docs/advanced_settings.json @@ -58,7 +58,9 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "advancedSettings", @@ -74,7 +76,9 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "advancedSettings", @@ -90,7 +94,9 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 32 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ] }, @@ -151,7 +157,55 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 73 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.id", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\"" + ], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.component", + "type": "CompoundType", + "tags": [], + "label": "component", + "description": [], + "signature": [ + "React.ComponentClass | undefined, any> | React.FunctionComponent | undefined>" + ], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.allowOverride", + "type": "boolean", + "tags": [], + "label": "allowOverride", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 47 + }, + "deprecated": false + } + ] } ] }, @@ -198,7 +252,26 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 78 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.id", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\"" + ], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] } ] } @@ -217,15 +290,36 @@ "\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context." ], "signature": [ - "React.LazyExoticComponent" + ">> & { readonly _result: typeof ", + "Field", + "; }" ], "source": { "path": "src/plugins/advanced_settings/public/index.ts", "lineNumber": 20 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.props", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 359 + }, + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/alerting.json b/api_docs/alerting.json index 3a6c541f29d176..13a150d0af00da 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -36,7 +36,75 @@ "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-public.consumer", + "type": "string", + "tags": [], + "label": "consumer", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 16 + }, + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-public.alertType", + "type": "string", + "tags": [], + "label": "alertType", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-public.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(alert: Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertType", + "text": "AlertType" + }, + "<\"default\", \"recovered\">) => string | ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + } + ], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ] }, { "parentPluginId": "alerting", @@ -54,7 +122,62 @@ "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 20 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-public.consumer", + "type": "string", + "tags": [], + "label": "consumer", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-public.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(alert: Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertType", + "text": "AlertType" + }, + "<\"default\", \"recovered\">) => string | ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + } + ], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", @@ -103,7 +226,23 @@ "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 23 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-public.alertId", + "type": "string", + "tags": [], + "label": "alertId", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/public/plugin.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -377,13 +516,15 @@ "label": "rule", "description": [], "signature": [ + "Pick, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"actions\" | \"tags\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", @@ -518,7 +659,9 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 47 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "alerting", @@ -536,7 +679,9 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 48 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "alerting", @@ -560,7 +705,9 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "alerting", @@ -576,7 +723,9 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 50 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -681,7 +830,23 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 75 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 76 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -823,7 +988,14 @@ "label": "executor", "description": [], "signature": [ - "ExecutorType", + "(options: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertExecutorOptions", + "text": "AlertExecutorOptions" + }, ">" + ">) => Promise" ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 131 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertExecutorOptions", + "text": "AlertExecutorOptions" + }, + "" + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 109 + }, + "deprecated": false + } + ] }, { "parentPluginId": "alerting", @@ -990,7 +1188,7 @@ "section": "def-common.Alert", "text": "Alert" }, - ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]" ], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", @@ -1097,7 +1295,9 @@ "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 106 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "alerting", @@ -1123,7 +1323,7 @@ "section": "def-server.AlertsClient", "text": "AlertsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" ], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -1233,7 +1433,9 @@ "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 111 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1249,7 +1451,23 @@ "label": "ActionGroupIdsOf", "description": [], "signature": [ - "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + "T extends ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " ? groups : T extends Readonly<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "> ? groups : never" ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", @@ -1317,7 +1535,7 @@ "label": "AlertsClient", "description": [], "signature": [ - "{ get: ({ id, }: { id: string; }) => Promise = never>({ id, }: { id: string; }) => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ", + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ", "CreateOptions", ") => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: ({ options: { fields, ...options }, }?: { options?: ", + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: = never>({ options: { fields, ...options }, }?: { options?: ", "FindOptions", " | undefined; }) => Promise<", { @@ -1344,7 +1562,38 @@ "docId": "kibAlertingPluginApi", "section": "def-server.FindResult", "text": "FindResult" - } + }, + ">; update: = never>({ id, data, }: ", + "UpdateOptions", + ") => Promise<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.PartialAlert", + "text": "PartialAlert" + }, + ">; aggregate: ({ options: { fields, ...options }, }?: { options?: ", + "AggregateOptions", + " | undefined; }) => Promise<", + "AggregateResult", + ">; enable: ({ id }: { id: string; }) => Promise; disable: ({ id }: { id: string; }) => Promise; muteAll: ({ id }: { id: string; }) => Promise; getAlertState: ({ id }: { id: string; }) => Promise; getAlertInstanceSummary: ({ id, dateStart, }: ", + "GetAlertInstanceSummaryParams", + ") => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertInstanceSummary", + "text": "AlertInstanceSummary" + }, + ">; updateApiKey: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + "MuteOptions", + ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", + "MuteOptions", + ") => Promise; listAlertTypes: () => Promise>; }" ], "source": { "path": "x-pack/plugins/alerting/server/index.ts", @@ -1395,7 +1644,23 @@ "label": "PartialAlert", "description": [], "signature": [ - "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" + "Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + ", \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>" ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", @@ -1412,7 +1677,13 @@ "label": "PublicAlertInstance", "description": [], "signature": [ - "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }" + "{ getState: () => State; replaceState: (state: State) => ", + "AlertInstance", + "; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ", + "AlertInstance", + "; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => ", + "AlertInstance", + "; }" ], "source": { "path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts", @@ -2488,13 +2759,7 @@ "label": "status", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertInstanceStatusValues", - "text": "AlertInstanceStatusValues" - } + "\"OK\" | \"Active\"" ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", @@ -2723,13 +2988,7 @@ "label": "status", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertStatusValues", - "text": "AlertStatusValues" - } + "\"OK\" | \"Active\" | \"Error\"" ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", @@ -2777,7 +3036,7 @@ "label": "instances", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", @@ -3190,7 +3449,23 @@ "label": "ActionGroupIdsOf", "description": [], "signature": [ - "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + "T extends ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " ? groups : T extends Readonly<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "> ? groups : never" ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", @@ -3207,11 +3482,11 @@ "label": "AlertActionParam", "description": [], "signature": [ - "undefined | null | string | number | false | true | ", + "string | number | boolean | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", - "[]" + "[] | null | undefined" ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", @@ -3582,7 +3857,7 @@ "label": "ReservedActionGroups", "description": [], "signature": [ - "RecoveryActionGroupId | \"recovered\"" + "\"recovered\" | RecoveryActionGroupId" ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", @@ -3599,7 +3874,31 @@ "label": "SanitizedAlert", "description": [], "signature": [ - "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }" + "{ enabled: boolean; id: string; name: string; params: Params; actions: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertAction", + "text": "AlertAction" + }, + "[]; tags: string[]; alertTypeId: string; consumer: string; schedule: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" + }, + "; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertExecutionStatus", + "text": "AlertExecutionStatus" + }, + "; }" ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", @@ -3616,7 +3915,15 @@ "label": "SanitizedRuleConfig", "description": [], "signature": [ - "Pick, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"actions\" | \"tags\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" + "Pick, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"actions\" | \"tags\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", @@ -3633,7 +3940,15 @@ "label": "WithoutReservedActionGroups", "description": [], "signature": [ - "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" + "ActionGroupIds extends ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ReservedActionGroups", + "text": "ReservedActionGroups" + }, + " ? never : ActionGroupIds" ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", @@ -3677,7 +3992,8 @@ "; }>, ", "PartialC", "<{ spaceId: ", - "StringC" + "StringC", + "; }>]>" ], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", @@ -3702,7 +4018,38 @@ ", ", "UnknownC", ">; alertInstances: ", - "RecordC" + "RecordC", + "<", + "StringC", + ", ", + "PartialC", + "<{ state: ", + "RecordC", + "<", + "StringC", + ", ", + "UnknownC", + ">; meta: ", + "PartialC", + "<{ lastScheduledActions: ", + "IntersectionC", + "<[", + "PartialC", + "<{ subgroup: ", + "StringC", + "; }>, ", + "TypeC", + "<{ group: ", + "StringC", + "; date: ", + "Type", + "; }>]>; }>; }>>; previousStartedAt: ", + "UnionC", + "<[", + "NullC", + ", ", + "Type", + "]>; }>" ], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", @@ -3744,7 +4091,20 @@ ", ", "UnknownC", ">; meta: ", - "PartialC" + "PartialC", + "<{ lastScheduledActions: ", + "IntersectionC", + "<[", + "PartialC", + "<{ subgroup: ", + "StringC", + "; }>, ", + "TypeC", + "<{ group: ", + "StringC", + "; date: ", + "Type", + "; }>]>; }>; }>" ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", @@ -3761,15 +4121,7 @@ "label": "RecoveredActionGroup", "description": [], "signature": [ - "Readonly<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - "<\"recovered\">>" + "{ readonly id: \"recovered\"; readonly name: string; }" ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", diff --git a/api_docs/apm.json b/api_docs/apm.json index 20c3eb20e5851a..84f5a87f404ae9 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -139,7 +139,8 @@ ", void, ", "APMPluginSetupDependencies", ", ", - "APMPluginStartDependencies" + "APMPluginStartDependencies", + ">" ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", @@ -213,7 +214,26 @@ ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"ruleRegistry\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">) => { config$: ", "Observable", "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", - "SearchAggregatedTransactionSetting" + "SearchAggregatedTransactionSetting", + "; 'xpack.apm.metricsInterval': number; }>; getApmIndices: () => Promise<", + "ApmIndicesConfig", + ">; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "; context: ", + "ApmPluginRequestHandlerContext", + "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<", + "InferSearchResponseOf", + ">, ESSearchRequestOf, {}>>; }>; }" ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", @@ -585,7 +605,176 @@ "docId": "kibApmOssPluginApi", "section": "def-server.APMOSSPluginSetup", "text": "APMOSSPluginSetup" - } + }, + "; start: () => Promise; }; licensing: { setup: ", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingPluginSetup", + "text": "LicensingPluginSetup" + }, + "; start: () => Promise<", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingPluginStart", + "text": "LicensingPluginStart" + }, + ">; }; observability: { setup: { getScopedAnnotationsClient: (requestContext: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { licensing: ", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingApiRequestHandlerContext", + "text": "LicensingApiRequestHandlerContext" + }, + "; }, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", + "Annotation", + "; }>; getById: (getByIdParams: { id: string; }) => Promise<", + "GetResponse", + ">; delete: (deleteParams: { id: string; }) => Promise<", + "DeleteResponse", + ">; } | undefined>; }; start: () => Promise; }; ruleRegistry: { setup: ", + { + "pluginId": "ruleRegistry", + "scope": "server", + "docId": "kibRuleRegistryPluginApi", + "section": "def-server.RuleRegistryPluginSetupContract", + "text": "RuleRegistryPluginSetupContract" + }, + "; start: () => Promise; }; security?: { setup: ", + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.SecurityPluginSetup", + "text": "SecurityPluginSetup" + }, + "; start: () => Promise<", + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.SecurityPluginStart", + "text": "SecurityPluginStart" + }, + ">; } | undefined; home?: { setup: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.HomeServerPluginSetup", + "text": "HomeServerPluginSetup" + }, + "; start: () => Promise<", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.HomeServerPluginStart", + "text": "HomeServerPluginStart" + }, + ">; } | undefined; ml?: { setup: ", + "SharedServices", + "; start: () => Promise; } | undefined; actions?: { setup: ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + }, + "; start: () => Promise<", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + }, + ">; } | undefined; usageCollection?: { setup: ", + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + }, + "; start: () => Promise; } | undefined; spaces?: { setup: ", + { + "pluginId": "spaces", + "scope": "server", + "docId": "kibSpacesPluginApi", + "section": "def-server.SpacesPluginSetup", + "text": "SpacesPluginSetup" + }, + "; start: () => Promise<", + { + "pluginId": "spaces", + "scope": "server", + "docId": "kibSpacesPluginApi", + "section": "def-server.SpacesPluginStart", + "text": "SpacesPluginStart" + }, + ">; } | undefined; cloud?: { setup: ", + { + "pluginId": "cloud", + "scope": "server", + "docId": "kibCloudPluginApi", + "section": "def-server.CloudSetup", + "text": "CloudSetup" + }, + "; start: () => Promise; } | undefined; taskManager?: { setup: ", + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.TaskManagerSetupContract", + "text": "TaskManagerSetupContract" + }, + "; start: () => Promise<", + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.TaskManagerStartContract", + "text": "TaskManagerStartContract" + }, + ">; } | undefined; alerting?: { setup: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + }, + "; start: () => Promise<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + }, + ">; } | undefined; }" ], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", @@ -644,7 +833,9 @@ "label": "APMConfig", "description": [], "signature": [ - "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }" + "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", + "SearchAggregatedTransactionSetting", + "; 'xpack.apm.metricsInterval': number; }" ], "source": { "path": "x-pack/plugins/apm/server/index.ts", @@ -661,140 +852,2882 @@ "label": "APMServerRouteRepository", "description": [], "signature": [ - "ServerRouteRepository; } & { \"GET /api/apm/index_pattern/dynamic\": ", "ServerRoute", - "<\"GET /api/apm/index_pattern/dynamic\", undefined, APMRouteHandlerResources, { dynamicIndexPattern: ", - "IndexPatternTitleAndFields" - ], - "source": { - "path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts", - "lineNumber": 60 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "apm", - "id": "def-server.APMXPackConfig", - "type": "Type", - "tags": [], - "label": "APMXPackConfig", - "description": [], - "signature": [ - "{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }" - ], - "source": { - "path": "x-pack/plugins/apm/server/index.ts", - "lineNumber": 55 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "apm", - "id": "def-server.InspectResponse", - "type": "Type", - "tags": [], - "label": "InspectResponse", - "description": [], - "signature": [ - "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" - ], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 26 - }, - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [], - "setup": { - "parentPluginId": "apm", - "id": "def-server.APMPluginSetup", - "type": "Interface", - "tags": [], - "label": "APMPluginSetup", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/types.ts", - "lineNumber": 51 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apm", - "id": "def-server.APMPluginSetup.config$", - "type": "Object", - "tags": [], - "label": "config$", - "description": [], - "signature": [ - "Observable", - "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", - "SearchAggregatedTransactionSetting", - "; 'xpack.apm.metricsInterval': number; }>" - ], - "source": { - "path": "x-pack/plugins/apm/server/types.ts", - "lineNumber": 52 + "<\"GET /api/apm/index_pattern/dynamic\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" }, - "deprecated": false - }, - { - "parentPluginId": "apm", - "id": "def-server.APMPluginSetup.getApmIndices", - "type": "Function", - "tags": [], - "label": "getApmIndices", - "description": [], - "signature": [ - "() => Promise<", - "ApmIndicesConfig", - ">" - ], - "source": { - "path": "x-pack/plugins/apm/server/types.ts", - "lineNumber": 53 + ", { dynamicIndexPattern: ", + "IndexPatternTitleAndFields", + " | undefined; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/index_pattern/title\": ", + "ServerRoute", + "<\"GET /api/apm/index_pattern/title\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" }, - "deprecated": false - }, - { - "parentPluginId": "apm", - "id": "def-server.APMPluginSetup.createApmEventClient", - "type": "Function", - "tags": [], - "label": "createApmEventClient", - "description": [], - "signature": [ - "(params: { debug?: boolean | undefined; request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "; context: ", - "ApmPluginRequestHandlerContext", - "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<", - "InferSearchResponseOf", - "; } & { \"GET /api/apm/environments\": ", + "ServerRoute", + "<\"GET /api/apm/environments\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ serviceName: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" }, - "deprecated": false + ", { environments: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/errors\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/errors\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ sortField: ", + "StringC", + "; sortDirection: ", + "UnionC", + "<[", + "LiteralC", + "<\"asc\">, ", + "LiteralC", + "<\"desc\">]>; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { errorGroups: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/errors/{groupId}\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/errors/{groupId}\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; groupId: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { transaction: ", + "APMError", + " | ", + "Transaction", + " | ", + "Span", + " | BaseMetric | ", + "Profile", + " | undefined; error: ", + "APMError", + "; occurrencesCount: number; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/errors/distribution\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/errors/distribution\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ groupId: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { noHits: boolean; buckets: any; bucketSize: number; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/metrics/charts\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/metrics/charts\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ agentName: ", + "StringC", + "; }>, ", + "PartialC", + "<{ serviceNodeName: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "MetricsChartsByAgentAPIResponse", + ", ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/observability_overview\": ", + "ServerRoute", + "<\"GET /api/apm/observability_overview\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ bucketSize: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { serviceCount: any; transactionPerMinute: { value: undefined; timeseries: never[]; } | { value: number; timeseries: any; }; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/observability_overview/has_data\": ", + "ServerRoute", + "<\"GET /api/apm/observability_overview/has_data\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { hasData: boolean; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum/client-metrics\": ", + "ServerRoute", + "<\"GET /api/apm/rum/client-metrics\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { pageViews: { value: number; }; totalPageLoadDuration: { value: number; }; backEnd: { value: number; }; frontEnd: { value: number; }; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/page-load-distribution\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/page-load-distribution\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>, ", + "PartialC", + "<{ minPercentile: ", + "StringC", + "; maxPercentile: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { pageLoadDistribution: { pageLoadDistribution: { x: number; y: number; }[]; percentiles: Record | undefined; minDuration: number; maxDuration: number; } | null; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/page-load-distribution/breakdown\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/page-load-distribution/breakdown\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>, ", + "PartialC", + "<{ minPercentile: ", + "StringC", + "; maxPercentile: ", + "StringC", + "; }>, ", + "TypeC", + "<{ breakdown: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { pageLoadDistBreakdown: { name: string; data: { x: number; y: number; }[]; }[] | undefined; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/page-view-trends\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/page-view-trends\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>, ", + "PartialC", + "<{ breakdowns: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { topItems: string[]; items: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/services\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/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: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/visitor-breakdown\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/visitor-breakdown\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { os: any; browsers: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/web-core-vitals\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/web-core-vitals\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { coreVitalPages: any; cls: any; fid: any; lcp: any; tbt: any; fcp: any; lcpRanks: number[]; fidRanks: number[]; clsRanks: number[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/long-task-metrics\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/long-task-metrics\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { noOfLongTasks: number; sumOfLongTasks: number; longestLongTask: number; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/url-search\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/url-search\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; percentile: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { total: number; items: { url: string; count: number; pld: number; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum-client/js-errors\": ", + "ServerRoute", + "<\"GET /api/apm/rum-client/js-errors\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ pageSize: ", + "StringC", + "; pageIndex: ", + "StringC", + "; }>, ", + "PartialC", + "<{ urlQuery: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { totalErrorPages: number; totalErrors: number; totalErrorGroups: number; items: { count: number; errorGroupId: React.ReactText; errorMessage: string; }[] | undefined; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/observability_overview/has_rum_data\": ", + "ServerRoute", + "<\"GET /api/apm/observability_overview/has_rum_data\", ", + "PartialC", + "<{ query: ", + "PartialC", + "<{ uiFilters: ", + "StringC", + "; start: ", + "Type", + "; end: ", + "Type", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { indices: string; hasData: boolean; serviceName: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/rum/local_filters\": ", + "ServerRoute", + "<\"GET /api/apm/rum/local_filters\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ filterNames: ", + "Type", + "<(\"host\" | \"location\" | \"browser\" | \"serviceName\" | \"agentName\" | \"containerId\" | \"podName\" | \"transactionResult\" | \"serviceVersion\" | \"transactionUrl\" | \"device\" | \"os\")[], string, unknown>; }>, ", + "TypeC", + "<{ uiFilters: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>, ", + "TypeC", + "<{}>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { localUiFilters: { options: any[]; name: \"host\" | \"location\" | \"browser\" | \"serviceName\" | \"agentName\" | \"containerId\" | \"podName\" | \"transactionResult\" | \"serviceVersion\" | \"transactionUrl\" | \"device\" | \"os\"; title: string; fieldName: string; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/service-map\": ", + "ServerRoute", + "<\"GET /api/apm/service-map\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ serviceName: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { elements: (", + "ConnectionElement", + " | { data: { id: string; 'span.type': string; label: string; groupedConnections: ({ 'service.name': string; 'service.environment': string | null; 'agent.name': string; serviceAnomalyStats?: ", + "ServiceAnomalyStats", + " | undefined; label: string | undefined; id?: string | undefined; parent?: string | undefined; position?: cytoscape.Position | undefined; } | { 'span.destination.service.resource': string; 'span.type': string; 'span.subtype': string; label: string | undefined; id?: string | undefined; parent?: string | undefined; position?: cytoscape.Position | undefined; } | { id: string; source: string | undefined; target: string | undefined; label: string | undefined; bidirectional?: boolean | undefined; isInverseEdge?: boolean | undefined; } | undefined)[]; }; } | { data: { id: string; source: string; target: string; }; })[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/service-map/service/{serviceName}\": ", + "ServerRoute", + "<\"GET /api/apm/service-map/service/{serviceName}\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { avgMemoryUsage: number | null; avgCpuUsage: number | null; transactionStats: { avgTransactionDuration: number | null; avgRequestsPerMinute: number | null; }; avgErrorRate: number | null; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/serviceNodes\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/serviceNodes\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { serviceNodes: { name: string; cpu: number | null; heapMemory: number | null; nonHeapMemory: number | null; threadCount: number | null; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services\": ", + "ServerRoute", + "<\"GET /api/apm/services\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { items: JoinedReturnType; hasHistoricalData: boolean; hasLegacyData: boolean; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/metadata/details\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/metadata/details\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "ServiceMetadataDetails", + ", ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/metadata/icons\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/metadata/icons\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "ServiceMetadataIcons", + ", ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/agent_name\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/agent_name\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { agentName: string | undefined; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transaction_types\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transaction_types\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { transactionTypes: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/node/{serviceNodeName}/metadata\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/node/{serviceNodeName}/metadata\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; serviceNodeName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { host: React.ReactText; containerId: React.ReactText; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/annotation/search\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/annotation/search\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { annotations: ", + "Annotation", + "[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"POST /api/apm/services/{serviceName}/annotation\": ", + "ServerRoute", + "<\"POST /api/apm/services/{serviceName}/annotation\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; body: ", + "IntersectionC", + "<[", + "TypeC", + "<{ '@timestamp': ", + "Type", + "; service: ", + "IntersectionC", + "<[", + "TypeC", + "<{ version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>]>; }>, ", + "PartialC", + "<{ message: ", + "StringC", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { _id: string; _index: string; _source: ", + "Annotation", + "; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/error_groups/main_statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/error_groups/main_statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { is_aggregation_accurate: boolean; error_groups: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/error_groups/detailed_statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/error_groups/detailed_statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>, ", + "TypeC", + "<{ numBuckets: ", + "Type", + "; transactionType: ", + "StringC", + "; groupIds: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: _.Dictionary<{ groupId: string; timeseries: ", + "Coordinate", + "[]; }>; previousPeriod: _.Dictionary<{ timeseries: { x: number; y: number | null | undefined; }[]; groupId: string; }>; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; serviceNodeName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { '@timestamp'?: undefined; agent?: undefined; service?: undefined; container?: undefined; kubernetes?: undefined; host?: undefined; cloud?: undefined; } | { '@timestamp': string; agent: ", + "Agent", + " | { name: string; version: string; }; service: any; container: any; kubernetes: any; host: any; cloud: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/throughput\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/throughput\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: any; previousPeriod: { x: number; y: number | null | undefined; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/service_overview_instances/main_statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/service_overview_instances/main_statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ latencyAggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "LatencyAggregationType", + ".avg>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p95>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p99>]>; transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: { serviceNodeName: string; errorRate?: number | undefined; latency?: number | undefined; throughput?: number | undefined; cpuUsage?: number | null | undefined; memoryUsage?: number | null | undefined; }[]; previousPeriod: { serviceNodeName: string; errorRate?: number | undefined; latency?: number | undefined; throughput?: number | undefined; cpuUsage?: number | null | undefined; memoryUsage?: number | null | undefined; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/service_overview_instances/detailed_statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/service_overview_instances/detailed_statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ latencyAggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "LatencyAggregationType", + ".avg>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p95>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p99>]>; transactionType: ", + "StringC", + "; serviceNodeIds: ", + "Type", + "; numBuckets: ", + "Type", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: _.Dictionary<{ serviceNodeName: string; errorRate?: ", + "Coordinate", + "[] | undefined; latency?: ", + "Coordinate", + "[] | undefined; throughput?: ", + "Coordinate", + "[] | undefined; cpuUsage?: ", + "Coordinate", + "[] | undefined; memoryUsage?: ", + "Coordinate", + "[] | undefined; }>; previousPeriod: _.Dictionary<{ cpuUsage: { x: number; y: number | null | undefined; }[]; errorRate: { x: number; y: number | null | undefined; }[]; latency: { x: number; y: number | null | undefined; }[]; memoryUsage: { x: number; y: number | null | undefined; }[]; throughput: { x: number; y: number | null | undefined; }[]; serviceNodeName: string; }>; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/dependencies\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/dependencies\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ numBuckets: ", + "Type", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { serviceDependencies: ", + "ServiceDependencyItem", + "[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/profiling/timeline\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/profiling/timeline\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { profilingTimeline: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/profiling/statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/profiling/statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ valueType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "ProfilingValueType", + ".wallTime>, ", + "LiteralC", + "<", + "ProfilingValueType", + ".cpuTime>, ", + "LiteralC", + "<", + "ProfilingValueType", + ".samples>, ", + "LiteralC", + "<", + "ProfilingValueType", + ".allocObjects>, ", + "LiteralC", + "<", + "ProfilingValueType", + ".allocSpace>, ", + "LiteralC", + "<", + "ProfilingValueType", + ".inuseObjects>, ", + "LiteralC", + "<", + "ProfilingValueType", + ".inuseSpace>]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { nodes: Record; rootNodes: string[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/alerts\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/alerts\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { alerts: any[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/traces/{traceId}\": ", + "ServerRoute", + "<\"GET /api/apm/traces/{traceId}\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ traceId: ", + "StringC", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { trace: { errorDocs: ", + "APMError", + "[]; items: TypeOfProcessorEvent<", + "ProcessorEvent", + ".transaction | ", + "ProcessorEvent", + ".span>[]; exceedsMax: boolean; }; errorsPerTransaction: ", + "ErrorsPerTransaction", + "; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/traces\": ", + "ServerRoute", + "<\"GET /api/apm/traces\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { items: ", + "TransactionGroup", + "[]; isAggregationAccurate: boolean; bucketSize: number; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/traces/{traceId}/root_transaction\": ", + "ServerRoute", + "<\"GET /api/apm/traces/{traceId}/root_transaction\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ traceId: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { transaction: TypeOfProcessorEvent<", + "ProcessorEvent", + ">; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/groups\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/groups\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { items: ", + "TransactionGroup", + "[]; isAggregationAccurate: boolean; bucketSize: number; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/groups/main_statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/groups/main_statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ transactionType: ", + "StringC", + "; latencyAggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "LatencyAggregationType", + ".avg>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p95>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p99>]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { transactionGroups: any; isAggregationAccurate: boolean; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/groups/detailed_statistics\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/groups/detailed_statistics\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>, ", + "TypeC", + "<{ transactionNames: ", + "Type", + "; numBuckets: ", + "Type", + "; transactionType: ", + "StringC", + "; latencyAggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "LatencyAggregationType", + ".avg>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p95>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p99>]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: _.Dictionary<{ transactionName: string; latency: ", + "Coordinate", + "[]; throughput: ", + "Coordinate", + "[]; errorRate: ", + "Coordinate", + "[]; impact: number; }>; previousPeriod: _.Dictionary<{ errorRate: { x: number; y: number | null | undefined; }[]; throughput: { x: number; y: number | null | undefined; }[]; latency: { x: number; y: number | null | undefined; }[]; transactionName: string; impact: number; }>; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/latency\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/charts/latency\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; latencyAggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "LatencyAggregationType", + ".avg>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p95>, ", + "LiteralC", + "<", + "LatencyAggregationType", + ".p99>]>; }>, ", + "PartialC", + "<{ transactionName: ", + "StringC", + "; }>, ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>]>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: { overallAvgDuration: any; latencyTimeseries: any; }; previousPeriod: { latencyTimeseries: { x: number; y: number | null | undefined; }[]; overallAvgDuration: any; }; anomalyTimeseries: { jobId: string; anomalyScore: { x0: number; x: number; y: number; }[]; anomalyBoundaries: { x: number; y0: number; y: number; }[]; } | undefined; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/throughput\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/charts/throughput\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ transactionName: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { throughputTimeseries: any[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/distribution\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/charts/distribution\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; transactionName: ", + "StringC", + "; }>, ", + "PartialC", + "<{ transactionId: ", + "StringC", + "; traceId: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { noHits: boolean; buckets: { samples: any; count: any; }[]; bucketSize: number; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transaction/charts/breakdown\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transaction/charts/breakdown\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ transactionName: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { timeseries: { title: any; color: any; type: string; data: any; hideLegend: boolean; legendValue: string; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/error_rate\": ", + "ServerRoute", + "<\"GET /api/apm/services/{serviceName}/transactions/charts/error_rate\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ transactionName: ", + "StringC", + "; }>, ", + "IntersectionC", + "<[", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ comparisonStart: ", + "Type", + "; comparisonEnd: ", + "Type", + "; }>]>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { currentPeriod: { noHits: boolean; transactionErrorRate: ", + "Coordinate", + "[]; average: number | null; }; previousPeriod: { transactionErrorRate: { x: number; y: number | null | undefined; }[]; noHits: boolean; average: number | null; }; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/alerts/chart_preview/transaction_error_rate\": ", + "ServerRoute", + "<\"GET /api/apm/alerts/chart_preview/transaction_error_rate\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ aggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<\"avg\">, ", + "LiteralC", + "<\"95th\">, ", + "LiteralC", + "<\"99th\">]>; serviceName: ", + "StringC", + "; environment: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { errorRateChartPreview: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/alerts/chart_preview/transaction_duration\": ", + "ServerRoute", + "<\"GET /api/apm/alerts/chart_preview/transaction_duration\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ aggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<\"avg\">, ", + "LiteralC", + "<\"95th\">, ", + "LiteralC", + "<\"99th\">]>; serviceName: ", + "StringC", + "; environment: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { latencyChartPreview: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/alerts/chart_preview/transaction_error_count\": ", + "ServerRoute", + "<\"GET /api/apm/alerts/chart_preview/transaction_error_count\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ aggregationType: ", + "UnionC", + "<[", + "LiteralC", + "<\"avg\">, ", + "LiteralC", + "<\"95th\">, ", + "LiteralC", + "<\"99th\">]>; serviceName: ", + "StringC", + "; environment: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { errorCountChartPreview: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/correlations/latency/overall_distribution\": ", + "ServerRoute", + "<\"GET /api/apm/correlations/latency/overall_distribution\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ serviceName: ", + "StringC", + "; transactionName: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { maxLatency: null; distributionInterval: null; overallDistribution: null; } | { maxLatency: number; distributionInterval: number; overallDistribution: null; } | { maxLatency: number; distributionInterval: number; overallDistribution: { x: any; y: number; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/correlations/latency/slow_transactions\": ", + "ServerRoute", + "<\"GET /api/apm/correlations/latency/slow_transactions\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ serviceName: ", + "StringC", + "; transactionName: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "TypeC", + "<{ durationPercentile: ", + "StringC", + "; fieldNames: ", + "StringC", + "; maxLatency: ", + "StringC", + "; distributionInterval: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { significantTerms: { distribution: { x: any; y: number; }[]; fieldName: string; fieldValue: React.ReactText; score: number; impact: number; fieldCount: number; valueCount: number; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/correlations/errors/overall_timeseries\": ", + "ServerRoute", + "<\"GET /api/apm/correlations/errors/overall_timeseries\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ serviceName: ", + "StringC", + "; transactionName: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { overall: null; } | { overall: { timeseries: { x: number; y: number; }[]; }; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/correlations/errors/failed_transactions\": ", + "ServerRoute", + "<\"GET /api/apm/correlations/errors/failed_transactions\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "PartialC", + "<{ serviceName: ", + "StringC", + "; transactionName: ", + "StringC", + "; transactionType: ", + "StringC", + "; }>, ", + "TypeC", + "<{ fieldNames: ", + "StringC", + "; }>, ", + "PartialC", + "<{ environment: ", + "StringC", + "; }>, ", + "PartialC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { significantTerms: { timeseries: { x: number; y: number; }[]; fieldName: string; fieldValue: React.ReactText; score: number; impact: number; fieldCount: number; valueCount: number; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/agent-configuration\": ", + "ServerRoute", + "<\"GET /api/apm/settings/agent-configuration\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { configurations: ", + "AgentConfiguration", + "[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/agent-configuration/view\": ", + "ServerRoute", + "<\"GET /api/apm/settings/agent-configuration/view\", ", + "PartialC", + "<{ query: ", + "PartialC", + "<{ name: ", + "StringC", + "; environment: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "AgentConfiguration", + ", ", + "APMRouteCreateOptions", + ">; } & { \"DELETE /api/apm/settings/agent-configuration\": ", + "ServerRoute", + "<\"DELETE /api/apm/settings/agent-configuration\", ", + "TypeC", + "<{ body: ", + "TypeC", + "<{ service: ", + "PartialC", + "<{ name: ", + "StringC", + "; environment: ", + "StringC", + "; }>; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { result: string; }, ", + "APMRouteCreateOptions", + ">; } & { \"PUT /api/apm/settings/agent-configuration\": ", + "ServerRoute", + "<\"PUT /api/apm/settings/agent-configuration\", ", + "IntersectionC", + "<[", + "PartialC", + "<{ query: ", + "PartialC", + "<{ overwrite: ", + "Type", + "; }>; }>, ", + "TypeC", + "<{ body: ", + "IntersectionC", + "<[", + "PartialC", + "<{ agent_name: ", + "StringC", + "; }>, ", + "TypeC", + "<{ service: ", + "PartialC", + "<{ name: ", + "StringC", + "; environment: ", + "StringC", + "; }>; settings: ", + "IntersectionC", + "<[", + "RecordC", + "<", + "StringC", + ", ", + "StringC", + ">, ", + "PartialC", + ">]>; }>]>; }>]>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", void, ", + "APMRouteCreateOptions", + ">; } & { \"POST /api/apm/settings/agent-configuration/search\": ", + "ServerRoute", + "<\"POST /api/apm/settings/agent-configuration/search\", ", + "TypeC", + "<{ body: ", + "IntersectionC", + "<[", + "TypeC", + "<{ service: ", + "PartialC", + "<{ name: ", + "StringC", + "; environment: ", + "StringC", + "; }>; }>, ", + "PartialC", + "<{ etag: ", + "StringC", + "; mark_as_applied_by_agent: ", + "BooleanC", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "SearchHit", + "<", + "AgentConfiguration", + ", undefined, undefined>, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/agent-configuration/services\": ", + "ServerRoute", + "<\"GET /api/apm/settings/agent-configuration/services\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { serviceNames: string[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/agent-configuration/environments\": ", + "ServerRoute", + "<\"GET /api/apm/settings/agent-configuration/environments\", ", + "PartialC", + "<{ query: ", + "PartialC", + "<{ serviceName: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { environments: { name: any; alreadyConfigured: any; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/agent-configuration/agent_name\": ", + "ServerRoute", + "<\"GET /api/apm/settings/agent-configuration/agent_name\", ", + "TypeC", + "<{ query: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { agentName: string | undefined; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/anomaly-detection/jobs\": ", + "ServerRoute", + "<\"GET /api/apm/settings/anomaly-detection/jobs\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { jobs: { job_id: string; environment: string; }[]; hasLegacyJobs: boolean; }, ", + "APMRouteCreateOptions", + ">; } & { \"POST /api/apm/settings/anomaly-detection/jobs\": ", + "ServerRoute", + "<\"POST /api/apm/settings/anomaly-detection/jobs\", ", + "TypeC", + "<{ body: ", + "TypeC", + "<{ environments: ", + "ArrayC", + "<", + "StringC", + ">; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { jobCreated: boolean; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/anomaly-detection/environments\": ", + "ServerRoute", + "<\"GET /api/apm/settings/anomaly-detection/environments\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { environments: any; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/apm-index-settings\": ", + "ServerRoute", + "<\"GET /api/apm/settings/apm-index-settings\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { apmIndexSettings: { configurationName: \"apm_oss.sourcemapIndices\" | \"apm_oss.errorIndices\" | \"apm_oss.onboardingIndices\" | \"apm_oss.spanIndices\" | \"apm_oss.transactionIndices\" | \"apm_oss.metricsIndices\" | \"apmAgentConfigurationIndex\" | \"apmCustomLinkIndex\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/apm-indices\": ", + "ServerRoute", + "<\"GET /api/apm/settings/apm-indices\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "ApmIndicesConfig", + ", ", + "APMRouteCreateOptions", + ">; } & { \"POST /api/apm/settings/apm-indices/save\": ", + "ServerRoute", + "<\"POST /api/apm/settings/apm-indices/save\", ", + "TypeC", + "<{ body: ", + "PartialC", + "<{ 'apm_oss.sourcemapIndices': ", + "StringC", + "; 'apm_oss.errorIndices': ", + "StringC", + "; 'apm_oss.onboardingIndices': ", + "StringC", + "; 'apm_oss.spanIndices': ", + "StringC", + "; 'apm_oss.transactionIndices': ", + "StringC", + "; 'apm_oss.metricsIndices': ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", ", + "SavedObject", + "<{}>, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/custom_links/transaction\": ", + "ServerRoute", + "<\"GET /api/apm/settings/custom_links/transaction\", ", + "PartialC", + "<{ query: ", + "PartialC", + "<{ 'service.name': ", + "StringC", + "; 'service.environment': ", + "StringC", + "; 'transaction.name': ", + "StringC", + "; 'transaction.type': ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", TypeOfProcessorEvent<", + "ProcessorEvent", + ">, ", + "APMRouteCreateOptions", + ">; } & { \"GET /api/apm/settings/custom_links\": ", + "ServerRoute", + "<\"GET /api/apm/settings/custom_links\", ", + "PartialC", + "<{ query: ", + "PartialC", + "<{ 'service.name': ", + "StringC", + "; 'service.environment': ", + "StringC", + "; 'transaction.name': ", + "StringC", + "; 'transaction.type': ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { customLinks: ", + "CustomLink", + "[]; }, ", + "APMRouteCreateOptions", + ">; } & { \"POST /api/apm/settings/custom_links\": ", + "ServerRoute", + "<\"POST /api/apm/settings/custom_links\", ", + "TypeC", + "<{ body: ", + "IntersectionC", + "<[", + "TypeC", + "<{ label: ", + "StringC", + "; url: ", + "StringC", + "; }>, ", + "PartialC", + "<{ id: ", + "StringC", + "; filters: ", + "ArrayC", + "<", + "TypeC", + "<{ key: ", + "UnionC", + "<[", + "LiteralC", + "<\"\">, ", + "KeyofC", + "<{ 'service.name': ", + "StringC", + "; 'service.environment': ", + "StringC", + "; 'transaction.name': ", + "StringC", + "; 'transaction.type': ", + "StringC", + "; }>]>; value: ", + "StringC", + "; }>>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", void, ", + "APMRouteCreateOptions", + ">; } & { \"PUT /api/apm/settings/custom_links/{id}\": ", + "ServerRoute", + "<\"PUT /api/apm/settings/custom_links/{id}\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ id: ", + "StringC", + "; }>; body: ", + "IntersectionC", + "<[", + "TypeC", + "<{ label: ", + "StringC", + "; url: ", + "StringC", + "; }>, ", + "PartialC", + "<{ id: ", + "StringC", + "; filters: ", + "ArrayC", + "<", + "TypeC", + "<{ key: ", + "UnionC", + "<[", + "LiteralC", + "<\"\">, ", + "KeyofC", + "<{ 'service.name': ", + "StringC", + "; 'service.environment': ", + "StringC", + "; 'transaction.name': ", + "StringC", + "; 'transaction.type': ", + "StringC", + "; }>]>; value: ", + "StringC", + "; }>>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", void, ", + "APMRouteCreateOptions", + ">; } & { \"DELETE /api/apm/settings/custom_links/{id}\": ", + "ServerRoute", + "<\"DELETE /api/apm/settings/custom_links/{id}\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ id: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { result: string; }, ", + "APMRouteCreateOptions", + ">; }>" + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts", + "lineNumber": 60 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "apm", + "id": "def-server.APMXPackConfig", + "type": "Type", + "tags": [], + "label": "APMXPackConfig", + "description": [], + "signature": [ + "{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "SearchAggregatedTransactionSetting", + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }" + ], + "source": { + "path": "x-pack/plugins/apm/server/index.ts", + "lineNumber": 55 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "apm", + "id": "def-server.InspectResponse", + "type": "Type", + "tags": [], + "label": "InspectResponse", + "description": [], + "signature": [ + "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 26 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup", + "type": "Interface", + "tags": [], + "label": "APMPluginSetup", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 51 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup.config$", + "type": "Object", + "tags": [], + "label": "config$", + "description": [], + "signature": [ + "Observable", + "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ", + "SearchAggregatedTransactionSetting", + "; 'xpack.apm.metricsInterval': number; }>" + ], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup.getApmIndices", + "type": "Function", + "tags": [], + "label": "getApmIndices", + "description": [], + "signature": [ + "() => Promise<", + "ApmIndicesConfig", + ">" + ], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 53 + }, + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup.createApmEventClient", + "type": "Function", + "tags": [], + "label": "createApmEventClient", + "description": [], + "signature": [ + "(params: { debug?: boolean | undefined; request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "; context: ", + "ApmPluginRequestHandlerContext", + "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<", + "InferSearchResponseOf", + ">, ESSearchRequestOf, {}>>; }>" + ], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 54 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "apm", + "id": "def-server.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ debug?: boolean | undefined; request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "; context: ", + "ApmPluginRequestHandlerContext", + "; }" + ], + "source": { + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 54 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json index bdfba6a93e195e..c09f772ea0a553 100644 --- a/api_docs/apm_oss.json +++ b/api_docs/apm_oss.json @@ -54,7 +54,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" + "{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }" ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", diff --git a/api_docs/banners.json b/api_docs/banners.json index 27810c9ecc5db1..ab2aedc00eb6c7 100644 --- a/api_docs/banners.json +++ b/api_docs/banners.json @@ -41,13 +41,7 @@ "label": "placement", "description": [], "signature": [ - { - "pluginId": "banners", - "scope": "common", - "docId": "kibBannersPluginApi", - "section": "def-common.BannerPlacement", - "text": "BannerPlacement" - } + "\"top\" | \"disabled\"" ], "source": { "path": "x-pack/plugins/banners/common/types.ts", diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json index a6efe251af115f..ce294077f9499c 100644 --- a/api_docs/bfetch.json +++ b/api_docs/bfetch.json @@ -58,7 +58,7 @@ "label": "BatchedFunc", "description": [], "signature": [ - "(payload: Payload, signal: AbortSignal | undefined) => Promise" + "(payload: Payload, signal?: AbortSignal | undefined) => Promise" ], "source": { "path": "src/plugins/bfetch/public/batching/types.ts", @@ -94,13 +94,32 @@ "FetchStreamingParams", ") => { xhr: XMLHttpRequest; stream: ", "Observable", - "; }" + "; }" ], "source": { "path": "src/plugins/bfetch/public/plugin.ts", "lineNumber": 24 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "FetchStreamingParams" + ], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] }, { "parentPluginId": "bfetch", @@ -126,7 +145,27 @@ "path": "src/plugins/bfetch/public/plugin.ts", "lineNumber": 25 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "StreamingBatchedFunctionParams", + "" + ], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -174,7 +213,26 @@ "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 42 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-server.data", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "BatchItemData" + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -266,7 +324,55 @@ "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 47 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-server.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 48 + }, + "deprecated": false + }, + { + "parentPluginId": "bfetch", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "bfetch", + "scope": "server", + "docId": "kibBfetchPluginApi", + "section": "def-server.BatchProcessingRouteParams", + "text": "BatchProcessingRouteParams" + }, + "" + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ] }, { "parentPluginId": "bfetch", @@ -298,7 +404,55 @@ "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-server.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "bfetch", + "id": "def-server.params", + "type": "Function", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.StreamingResponseHandler", + "text": "StreamingResponseHandler" + }, + "" + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] }, { "parentPluginId": "bfetch", @@ -349,13 +503,227 @@ "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" - } + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>" ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", "lineNumber": 83 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-server.streamHandler", + "type": "Function", + "tags": [], + "label": "streamHandler", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + "Observable", + " | Promise<", + "Observable", + ">" + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 91 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", @@ -884,7 +1252,26 @@ "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-common.args", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "Func extends (...args: infer P) => any ? P : never" + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ] }, { "parentPluginId": "bfetch", @@ -900,7 +1287,26 @@ "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 16 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-common.items", + "type": "Array", + "tags": [], + "label": "items", + "description": [], + "signature": [ + "BatchEntry[]" + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 16 + }, + "deprecated": false + } + ] }, { "parentPluginId": "bfetch", @@ -1178,7 +1584,26 @@ "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 22 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-common.items", + "type": "Array", + "tags": [], + "label": "items", + "description": [], + "signature": [ + "Item[]" + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false diff --git a/api_docs/cases.json b/api_docs/cases.json index 6cd4a0ac48ae93..2df1b04871273c 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -48,7 +48,8 @@ "docId": "kibCasesPluginApi", "section": "def-public.StartPlugins", "text": "StartPlugins" - } + }, + ">" ], "source": { "path": "x-pack/plugins/cases/public/plugin.ts", @@ -355,7 +356,8 @@ "; features$: ", "Observable", "<", - "SecurityLicenseFeatures" + "SecurityLicenseFeatures", + ">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", @@ -439,7 +441,32 @@ "\nTODO: The extra security service is one that should be implemented in the kibana context of the consuming application.\nSecurity is needed for access to authc for the `useCurrentUser` hook. Security_Solution currently passes it via renderApp in public/plugin.tsx\nLeaving it out currently in lieu of RBAC changes" ], "signature": [ - "CoreStart & StartPlugins & { security: SecurityPluginSetup; }" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + " & ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.StartPlugins", + "text": "StartPlugins" + }, + " & { security: { authc: ", + "AuthenticationServiceSetup", + "; sessionTimeout: ", + "SessionTimeout", + "; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ", + "SecurityLicenseFeatures", + "; features$: ", + "Observable", + "<", + "SecurityLicenseFeatures", + ">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }; }" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", @@ -475,13 +502,32 @@ "AllCasesProps", ") => React.ReactElement<", "AllCasesProps", - ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ">" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", "lineNumber": 47 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "AllCasesProps" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 47 + }, + "deprecated": false + } + ] }, { "parentPluginId": "cases", @@ -495,13 +541,32 @@ "AllCasesSelectorModalProps", ") => React.ReactElement<", "AllCasesSelectorModalProps", - ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ">" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", "lineNumber": 48 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "AllCasesSelectorModalProps" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ] }, { "parentPluginId": "cases", @@ -515,13 +580,32 @@ "CaseViewProps", ") => React.ReactElement<", "CaseViewProps", - ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ">" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "CaseViewProps" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 51 + }, + "deprecated": false + } + ] }, { "parentPluginId": "cases", @@ -535,13 +619,32 @@ "ConfigureCasesProps", ") => React.ReactElement<", "ConfigureCasesProps", - ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ">" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", "lineNumber": 52 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "ConfigureCasesProps" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 52 + }, + "deprecated": false + } + ] }, { "parentPluginId": "cases", @@ -555,13 +658,32 @@ "CreateCaseProps", ") => React.ReactElement<", "CreateCaseProps", - ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ">" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", "lineNumber": 53 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "CreateCaseProps" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] }, { "parentPluginId": "cases", @@ -575,13 +697,32 @@ "RecentCasesProps", ") => React.ReactElement<", "RecentCasesProps", - ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ">" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", "lineNumber": 54 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "RecentCasesProps" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 54 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -790,7 +931,9 @@ "path": "x-pack/plugins/cases/server/types.ts", "lineNumber": 19 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1927,7 +2070,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; })" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", @@ -2850,12 +2994,13 @@ "label": "status", "description": [], "signature": [ + "\"all\" | ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatusWithAllStatus", - "text": "CaseStatusWithAllStatus" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" } ], "source": { @@ -3795,7 +3940,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }) | { syncAlerts: boolean; } | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", @@ -4034,7 +4180,13 @@ "label": "ActionConnector", "description": [], "signature": [ - "ActionResult" + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionResult", + "text": "ActionResult" + } ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -4068,7 +4220,13 @@ "label": "ActionTypeConnector", "description": [], "signature": [ - "ActionType" + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionType", + "text": "ActionType" + } ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -4085,7 +4243,47 @@ "label": "AllCommentsResponse", "description": [], "signature": [ - "(({ comment: string; type: CommentType.user; owner: string; } & { associationType: AssociationType; 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; }) | ({ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: AssociationType; 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; }))[]" + "(({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }))[]" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -4153,7 +4351,31 @@ "label": "AttributesTypeAlerts", "description": [], "signature": [ - "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: AssociationType; 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 | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -4170,7 +4392,23 @@ "label": "AttributesTypeUser", "description": [], "signature": [ - "{ comment: string; type: CommentType.user; owner: string; } & { associationType: AssociationType; 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; }" + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -4448,7 +4686,15 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + "; tags: string[]; title: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + "; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4479,7 +4725,16 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }); 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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -4496,7 +4751,7 @@ "label": "CaseConnector", "description": [], "signature": [ - "{ id: string; name: string; } & { type: ", + "({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4504,7 +4759,7 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" }, - ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } | { id: string; name: string; } & { type: ", + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4512,7 +4767,7 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" }, - ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } | { id: string; name: string; } & { type: ", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4520,7 +4775,7 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" }, - ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } | { id: string; name: string; } & { type: ", + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4528,14 +4783,15 @@ "section": "def-common.ConnectorTypes", "text": "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; } | { id: string; name: string; } & { type: ", + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; })" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -4569,7 +4825,7 @@ "label": "CaseFullExternalService", "description": [], "signature": [ - "null | { 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; }; }" + "({ 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" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -4594,7 +4850,15 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | undefined; connector?: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4625,7 +4889,16 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; owner?: string | undefined; } & { id: string; version: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -4642,7 +4915,15 @@ "label": "CasePostRequest", "description": [], "signature": [ - "{ type?: CaseType | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", + "{ type?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4681,7 +4962,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }); settings: { syncAlerts: boolean; }; owner: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -4706,7 +4988,15 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + "; tags: string[]; title: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + "; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4737,62 +5027,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 296 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CASES_URL", - "type": "string", - "tags": [], - "label": "CASES_URL", - "description": [ - "\nCase routes" - ], - "signature": [ - "\"/api/cases\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 34 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesByAlertIDRequest", - "type": "Type", - "tags": [], - "label": "CasesByAlertIDRequest", - "description": [], - "signature": [ - "{ owner?: string | string[] | undefined; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 299 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesClientPostRequest", - "type": "Type", - "tags": [], - "label": "CasesClientPostRequest", - "description": [ - "\nThis field differs from the CasePostRequest in that the post request's type field can be optional. This type requires\nthat the type field be defined. The CasePostRequest should be used in most places (the UI etc). This type is really\nonly necessary for validation." - ], - "signature": [ - "{ type: CaseType; description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -4800,46 +5036,206 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" }, - ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + ".none; fields: null; }); 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; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + "; } & { 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; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; owner: string; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "section": "def-common.CommentType", + "text": "CommentType" }, - ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + ".user; owner: string; } & { associationType: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "section": "def-common.AssociationType", + "text": "AssociationType" }, - ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + "; 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; }) | ({ type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 294 - }, - "deprecated": false, - "initialIsOpen": false - }, + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[] | undefined; comments?: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 296 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASES_URL", + "type": "string", + "tags": [], + "label": "CASES_URL", + "description": [ + "\nCase routes" + ], + "signature": [ + "\"/api/cases\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 34 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesByAlertIDRequest", + "type": "Type", + "tags": [], + "label": "CasesByAlertIDRequest", + "description": [], + "signature": [ + "{ owner?: string | string[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 299 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesClientPostRequest", + "type": "Type", + "tags": [], + "label": "CasesClientPostRequest", + "description": [ + "\nThis field differs from the CasePostRequest in that the post request's type field can be optional. This type requires\nthat the type field be defined. The CasePostRequest should be used in most places (the UI etc). This type is really\nonly necessary for validation." + ], + "signature": [ + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + "; description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }); settings: { syncAlerts: boolean; }; owner: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 294 + }, + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "cases", "id": "def-common.CasesConfigurationsResponse", @@ -4887,7 +5283,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; owner: string; } & { id: string; version: string; error: string | null; owner: string; })[]" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", @@ -4943,7 +5340,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; owner: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", @@ -4999,7 +5397,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", @@ -5055,7 +5454,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }) | undefined; closure_type?: \"close-by-user\" | \"close-by-pushing\" | undefined; } & { version: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", @@ -5111,7 +5511,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; owner: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", @@ -5167,7 +5568,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; owner: string; } & { id: string; version: string; error: string | null; owner: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", @@ -5201,7 +5603,15 @@ "label": "CasesFindRequest", "description": [], "signature": [ - "{ type?: CaseType | undefined; tags?: string | string[] | undefined; status?: ", + "{ type?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | undefined; tags?: string | string[] | undefined; status?: ", { "pluginId": "cases", "scope": "common", @@ -5234,7 +5644,15 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + "; tags: string[]; title: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + "; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -5265,32 +5683,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 300 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesPatchRequest", - "type": "Type", - "tags": [], - "label": "CasesPatchRequest", - "description": [], - "signature": [ - "{ cases: ({ description?: string | undefined; status?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" }, - " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -5298,55 +5692,128 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" }, - ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + ".none; fields: null; }); 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; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + "; } & { 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; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; owner: string; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "section": "def-common.CommentType", + "text": "CommentType" }, - ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + ".user; owner: string; } & { associationType: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 302 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesResponse", - "type": "Type", - "tags": [], - "label": "CasesResponse", - "description": [], - "signature": [ - "({ description: string; status: ", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[] | undefined; comments?: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[]; page: number; per_page: number; total: number; } & { count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 300 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesPatchRequest", + "type": "Type", + "tags": [], + "label": "CasesPatchRequest", + "description": [], + "signature": [ + "{ cases: ({ description?: string | undefined; status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | undefined; connector?: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -5377,7 +5844,177 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; owner?: string | undefined; } & { id: string; version: string; })[]; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 302 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesResponse", + "type": "Type", + "tags": [], + "label": "CasesResponse", + "description": [], + "signature": [ + "({ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + "; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }); 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; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; } & { 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; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; owner: string; } & { 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; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[] | undefined; comments?: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[]" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -5459,24 +6096,7 @@ "docId": "kibCasesPluginApi", "section": "def-common.CaseStatuses", "text": "CaseStatuses" - }, - ".open | typeof ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - "[\"in-progress\"] | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - ".closed" + } ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", @@ -5580,7 +6200,7 @@ "label": "Comment", "description": [], "signature": [ - "{ comment: string; type: ", + "({ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -5612,14 +6232,47 @@ "section": "def-common.ElasticUser", "text": "ElasticUser" }, - " | null; version: string; } | { type: ", + " | null; version: string; }) | ({ type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", "section": "def-common.CommentType", "text": "CommentType" - } + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; id: string; createdAt: string; createdBy: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + }, + "; pushedAt: string | null; pushedBy: string | null; updatedAt: string | null; updatedBy: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + }, + " | null; version: string; })" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", @@ -5636,7 +6289,7 @@ "label": "CommentAttributes", "description": [], "signature": [ - "{ comment: string; type: ", + "({ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -5652,7 +6305,7 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - "; 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: ", + "; 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", @@ -5675,7 +6328,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.AssociationType", "text": "AssociationType" - } + }, + "; 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; })" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5700,7 +6354,7 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - " | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; owner?: string | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; } | { type?: ", + " | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; owner?: string | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; } | ({ type?: ", { "pluginId": "cases", "scope": "common", @@ -5724,7 +6378,7 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - " | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; owner?: string | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; }" + " | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; owner?: string | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; })" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5741,7 +6395,7 @@ "label": "CommentPatchRequest", "description": [], "signature": [ - "{ comment: string; type: ", + "({ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -5749,7 +6403,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".user; owner: string; } & { id: string; version: string; } | { type: ", + ".user; owner: string; } & { id: string; version: string; }) | ({ type: ", { "pluginId": "cases", "scope": "common", @@ -5765,7 +6419,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { id: string; version: string; }" + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { id: string; version: string; })" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5823,7 +6477,23 @@ "label": "CommentRequestAlertType", "description": [], "signature": [ - "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; }" + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5840,7 +6510,15 @@ "label": "CommentRequestUserType", "description": [], "signature": [ - "{ comment: string; type: CommentType.user; owner: string; }" + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5857,7 +6535,7 @@ "label": "CommentResponse", "description": [], "signature": [ - "{ comment: string; type: ", + "({ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -5873,7 +6551,7 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - "; 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; } | { type: ", + "; 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; }) | ({ type: ", { "pluginId": "cases", "scope": "common", @@ -5896,7 +6574,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.AssociationType", "text": "AssociationType" - } + }, + "; 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; })" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5913,7 +6592,31 @@ "label": "CommentResponseAlertsType", "description": [], "signature": [ - "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: AssociationType; 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; }" + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5930,7 +6633,47 @@ "label": "CommentsResponse", "description": [], "signature": [ - "{ comments: (({ comment: string; type: CommentType.user; owner: string; } & { associationType: AssociationType; 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; }) | ({ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: AssociationType; 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; }))[]; page: number; per_page: number; total: number; }" + "{ comments: (({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert | ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }))[]; page: number; per_page: number; total: number; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", @@ -5964,7 +6707,7 @@ "label": "ConnectorFields", "description": [], "signature": [ - "null | { issueType: string | null; priority: string | null; parent: string | null; } | { incidentTypes: string[] | null; severityCode: string | null; } | { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" + "{ issueType: string | null; priority: string | null; parent: string | null; } | { incidentTypes: string[] | null; severityCode: string | null; } | { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -5981,7 +6724,15 @@ "label": "ConnectorJiraTypeFields", "description": [], "signature": [ - "{ type: ConnectorTypes.jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }" + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -6032,7 +6783,15 @@ "label": "ConnectorResillientTypeFields", "description": [], "signature": [ - "{ type: ConnectorTypes.resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }" + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -6049,7 +6808,15 @@ "label": "ConnectorServiceNowITSMTypeFields", "description": [], "signature": [ - "{ type: ConnectorTypes.serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }" + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -6066,7 +6833,15 @@ "label": "ConnectorServiceNowSIRTypeFields", "description": [], "signature": [ - "{ 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; }" + "{ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -6122,7 +6897,8 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } + }, + ".none; fields: null; }" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -6200,7 +6976,15 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", + "; tags: string[]; title: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + "; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -6231,7 +7015,24 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }); 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; }, \"type\" | \"status\" | \"description\" | \"title\" | \"updated_at\" | \"tags\" | \"settings\" | \"owner\" | \"created_at\" | \"created_by\" | \"updated_by\" | \"closed_at\" | \"closed_by\" | \"external_service\"> & { connector: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ESCaseConnector", + "text": "ESCaseConnector" + }, + "; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -6248,38 +7049,6 @@ "label": "ESCaseConnectorTypes", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - }, - ".jira | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - }, - ".resilient | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - }, - ".serviceNowITSM | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - }, - ".serviceNowSIR | ", { "pluginId": "cases", "scope": "common", @@ -6311,7 +7080,15 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | undefined; connector?: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", @@ -6342,7 +7119,24 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "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; }) | ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; owner?: string | undefined; } & { id: string; version: string; }, \"type\" | \"status\" | \"description\" | \"title\" | \"id\" | \"version\" | \"tags\" | \"settings\" | \"owner\"> & { connector?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ESCaseConnector", + "text": "ESCaseConnector" + }, + " | undefined; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", @@ -6398,12 +7192,21 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 86 - }, + }, + ".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }, \"updated_at\" | \"owner\" | \"created_at\" | \"created_by\" | \"updated_by\" | \"closure_type\"> & { connector: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ESCaseConnector", + "text": "ESCaseConnector" + }, + "; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 86 + }, "deprecated": false, "initialIsOpen": false }, @@ -6959,7 +7762,16 @@ "docId": "kibCasesPluginApi", "section": "def-common.CommentType", "text": "CommentType" - } + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", @@ -7040,7 +7852,16 @@ "docId": "kibCasesPluginApi", "section": "def-common.CommentType", "text": "CommentType" - } + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[]; page: number; per_page: number; total: number; } & { count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", @@ -7121,7 +7942,16 @@ "docId": "kibCasesPluginApi", "section": "def-common.CommentType", "text": "CommentType" - } + }, + ".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { associationType: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + "; 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; })[]" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", @@ -7275,46 +8105,62 @@ "text": "CommentType" }, ".generatedAlert>, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 70 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.AllCommentsResponseRt", - "type": "Object", - "tags": [], - "label": "AllCommentsResponseRt", - "description": [], - "signature": [ + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", "ArrayC", "<", - "IntersectionC", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", "UnionC", "<[", - "IntersectionC", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", "<[", - "TypeC" + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 132 + "lineNumber": 70 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.AllCommentsResponseRT", + "id": "def-common.AllCommentsResponseRt", "type": "Object", "tags": [], - "label": "AllCommentsResponseRT", + "label": "AllCommentsResponseRt", "description": [], "signature": [ "ArrayC", @@ -7325,248 +8171,151 @@ "<[", "IntersectionC", "<[", - "TypeC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 103 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.AllReportersFindRequestRt", - "type": "Object", - "tags": [], - "label": "AllReportersFindRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ owner: ", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", "UnionC", "<[", - "ArrayC", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", "StringC", - ">, ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 286 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.AllTagsFindRequestRt", - "type": "Object", - "tags": [], - "label": "AllTagsFindRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ owner: ", + "; created_by: ", + "TypeC", + "<{ email: ", "UnionC", "<[", - "ArrayC", - "<", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - ">, ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 278 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseAttributesRt", - "type": "Object", - "tags": [], - "label": "CaseAttributesRt", - "description": [], - "signature": [ - "IntersectionC", + "]>; full_name: ", + "UnionC", "<[", - "TypeC", - "<{ description: ", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - "; status: ", + "]>; username: ", "UnionC", "<[", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 87 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseConfigurationsResponseRt", - "type": "Object", - "tags": [], - "label": "CaseConfigurationsResponseRt", - "description": [], - "signature": [ - "ArrayC", - "<", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", "<[", - "IntersectionC", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", "<[", "TypeC", - "<{ connector: ", - "IntersectionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 76 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseConfigureAttributesRt", - "type": "Object", - "tags": [], - "label": "CaseConfigureAttributesRt", - "description": [], - "signature": [ - "IntersectionC", + "<{ email: ", + "UnionC", "<[", - "TypeC", - "<{ connector: ", - "IntersectionC", - "<[", - "TypeC", - "<{ id: ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 43 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseConfigureRequestParamsRt", - "type": "Object", - "tags": [], - "label": "CaseConfigureRequestParamsRt", - "description": [], - "signature": [ - "TypeC", - "<{ configuration_id: ", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - "; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 72 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseConfigureResponseRt", - "type": "Object", - "tags": [], - "label": "CaseConfigureResponseRt", - "description": [], - "signature": [ - "IntersectionC", + "]>; full_name: ", + "UnionC", "<[", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", "<[", - "TypeC", - "<{ connector: ", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", "<[", - "TypeC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 53 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseConnectorRt", - "type": "Object", - "tags": [], - "label": "CaseConnectorRt", - "description": [], - "signature": [ - "IntersectionC", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", "<[", "TypeC", - "<{ id: ", - "StringC", - "; name: ", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - "; }>, ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 74 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasePatchRequestRt", - "type": "Object", - "tags": [], - "label": "CasePatchRequestRt", - "description": [], - "signature": [ - "IntersectionC", + "]>; full_name: ", + "UnionC", "<[", - "PartialC", - "<{ description: ", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - "; status: ", + "]>; username: ", "UnionC", "<[", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 242 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasePostRequestRt", - "type": "Object", - "tags": [], - "label": "CasePostRequestRt", - "description": [ - "\nThis type is not used for validation when decoding a request because intersection does not have props defined which\nrequired for the excess function. Instead we use this as the type used by the UI. This allows the type field to be\noptional and the server will handle setting it to a default value before validating that the request\nhas all the necessary fields. CasesClientPostRequestRt is used for validation." - ], - "signature": [ + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", "IntersectionC", "<[", - "PartialC", + "TypeC", "<{ type: ", "UnionC", "<[", @@ -7576,182 +8325,54 @@ "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 142 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasePushRequestParamsRt", - "type": "Object", - "tags": [], - "label": "CasePushRequestParamsRt", - "description": [], - "signature": [ - "TypeC", - "<{ case_id: ", - "StringC", - "; connector_id: ", - "StringC", - "; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 253 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseResponseRt", - "type": "Object", - "tags": [], - "label": "CaseResponseRt", - "description": [], - "signature": [ - "IntersectionC", - "<[", - "IntersectionC", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", "<[", - "TypeC", - "<{ description: ", + "ArrayC", + "<", "StringC", - "; status: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 217 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesByAlertIDRequestRt", - "type": "Object", - "tags": [], - "label": "CasesByAlertIDRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ owner: ", + ">, ", + "StringC", + "]>; index: ", "UnionC", "<[", "ArrayC", "<", "StringC", ">, ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 209 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesClientPostRequestRt", - "type": "Object", - "tags": [], - "label": "CasesClientPostRequestRt", - "description": [ - "\nThis type is used for validating a create case request. It requires that the type field be defined." - ], - "signature": [ + "StringC", + "]>; rule: ", "TypeC", - "<{ type: ", + "<{ id: ", "UnionC", "<[", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - }, - ".collection>, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 131 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigurePatchRt", - "type": "Object", - "tags": [], - "label": "CasesConfigurePatchRt", - "description": [], - "signature": [ - "IntersectionC", - "<[", - "PartialC", - "; name: ", + "UnionC", "<[", - "TypeC", - "<{ id: ", "StringC", - "; name: ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 37 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesFindRequestRt", - "type": "Object", - "tags": [], - "label": "CasesFindRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ type: ", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", "UnionC", "<[", "LiteralC", @@ -7760,127 +8381,11966 @@ "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" + "section": "def-common.AssociationType", + "text": "AssociationType" }, - ".collection>, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 150 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesFindResponseRt", - "type": "Object", - "tags": [], - "label": "CasesFindResponseRt", - "description": [], - "signature": [ - "IntersectionC", + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", "<[", "TypeC", - "<{ cases: ", - "ArrayC", - "<", - "IntersectionC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", "<[", - "IntersectionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 232 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesPatchRequestRt", - "type": "Object", - "tags": [], - "label": "CasesPatchRequestRt", - "description": [], - "signature": [ "TypeC", - "<{ cases: ", - "ArrayC", - "<", - "IntersectionC", + "<{ email: ", + "UnionC", "<[", - "PartialC", - "<{ description: ", - "StringC" + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 250 + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 132 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CasesResponseRt", + "id": "def-common.AllCommentsResponseRT", "type": "Object", "tags": [], - "label": "CasesResponseRt", + "label": "AllCommentsResponseRT", "description": [], "signature": [ "ArrayC", "<", "IntersectionC", "<[", + "UnionC", + "<[", "IntersectionC", "<[", "TypeC", - "<{ description: ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 251 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesStatusRequestRt", - "type": "Object", - "tags": [], - "label": "CasesStatusRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ owner: ", - "UnionC", - "<[", - "ArrayC", - "<", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 103 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllReportersFindRequestRt", + "type": "Object", + "tags": [], + "label": "AllReportersFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ owner: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 286 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllTagsFindRequestRt", + "type": "Object", + "tags": [], + "label": "AllTagsFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ owner: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 278 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseAttributesRt", + "type": "Object", + "tags": [], + "label": "CaseAttributesRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; external_service: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector_id: ", + "StringC", + "; connector_name: ", + "StringC", + "; external_id: ", + "StringC", + "; external_title: ", + "StringC", + "; external_url: ", + "StringC", + "; }>, ", + "TypeC", + "<{ pushed_at: ", + "StringC", + "; pushed_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; }>]>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 87 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConfigurationsResponseRt", + "type": "Object", + "tags": [], + "label": "CaseConfigurationsResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; closure_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"close-by-user\">, ", + "LiteralC", + "<\"close-by-pushing\">]>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "TypeC", + "<{ mappings: ", + "ArrayC", + "<", + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"append\">, ", + "LiteralC", + "<\"nothing\">, ", + "LiteralC", + "<\"overwrite\">]>; source: ", + "UnionC", + "<[", + "LiteralC", + "<\"title\">, ", + "LiteralC", + "<\"description\">, ", + "LiteralC", + "<\"comments\">]>; target: ", + "UnionC", + "<[", + "StringC", + ", ", + "LiteralC", + "<\"not_mapped\">]>; }>>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; error: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 76 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConfigureAttributesRt", + "type": "Object", + "tags": [], + "label": "CaseConfigureAttributesRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; closure_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"close-by-user\">, ", + "LiteralC", + "<\"close-by-pushing\">]>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 43 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConfigureRequestParamsRt", + "type": "Object", + "tags": [], + "label": "CaseConfigureRequestParamsRt", + "description": [], + "signature": [ + "TypeC", + "<{ configuration_id: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 72 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConfigureResponseRt", + "type": "Object", + "tags": [], + "label": "CaseConfigureResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; closure_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"close-by-user\">, ", + "LiteralC", + "<\"close-by-pushing\">]>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "TypeC", + "<{ mappings: ", + "ArrayC", + "<", + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"append\">, ", + "LiteralC", + "<\"nothing\">, ", + "LiteralC", + "<\"overwrite\">]>; source: ", + "UnionC", + "<[", + "LiteralC", + "<\"title\">, ", + "LiteralC", + "<\"description\">, ", + "LiteralC", + "<\"comments\">]>; target: ", + "UnionC", + "<[", + "StringC", + ", ", + "LiteralC", + "<\"not_mapped\">]>; }>>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; error: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 53 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConnectorRt", + "type": "Object", + "tags": [], + "label": "CaseConnectorRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 74 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePatchRequestRt", + "type": "Object", + "tags": [], + "label": "CasePatchRequestRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 242 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePostRequestRt", + "type": "Object", + "tags": [], + "label": "CasePostRequestRt", + "description": [ + "\nThis type is not used for validation when decoding a request because intersection does not have props defined which\nrequired for the excess function. Instead we use this as the type used by the UI. This allows the type field to be\noptional and the server will handle setting it to a default value before validating that the request\nhas all the necessary fields. CasesClientPostRequestRt is used for validation." + ], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; }>, ", + "TypeC", + "<{ description: ", + "StringC", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 142 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePushRequestParamsRt", + "type": "Object", + "tags": [], + "label": "CasePushRequestParamsRt", + "description": [], + "signature": [ + "TypeC", + "<{ case_id: ", + "StringC", + "; connector_id: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 253 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseResponseRt", + "type": "Object", + "tags": [], + "label": "CaseResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; external_service: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector_id: ", + "StringC", + "; connector_name: ", + "StringC", + "; external_id: ", + "StringC", + "; external_title: ", + "StringC", + "; external_url: ", + "StringC", + "; }>, ", + "TypeC", + "<{ pushed_at: ", + "StringC", + "; pushed_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; }>]>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ subCaseIds: ", + "ArrayC", + "<", + "StringC", + ">; subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>; comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 217 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesByAlertIDRequestRt", + "type": "Object", + "tags": [], + "label": "CasesByAlertIDRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ owner: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 209 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesClientPostRequestRt", + "type": "Object", + "tags": [], + "label": "CasesClientPostRequestRt", + "description": [ + "\nThis type is used for validating a create case request. It requires that the type field be defined." + ], + "signature": [ + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; description: ", + "StringC", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 131 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigurePatchRt", + "type": "Object", + "tags": [], + "label": "CasesConfigurePatchRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + ", ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; closure_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"close-by-user\">, ", + "LiteralC", + "<\"close-by-pushing\">]>; owner: ", + "StringC", + "; }, \"connector\" | \"closure_type\">>, ", + "TypeC", + "<{ version: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 38 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigureRequestRt", + "type": "Object", + "tags": [], + "label": "CasesConfigureRequestRt", + "description": [], + "signature": [ + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; closure_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"close-by-user\">, ", + "LiteralC", + "<\"close-by-pushing\">]>; owner: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 37 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindRequestRt", + "type": "Object", + "tags": [], + "label": "CasesFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; tags: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; reporters: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; defaultSearchOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; fields: ", + "ArrayC", + "<", + "StringC", + ">; page: ", + "Type", + "; perPage: ", + "Type", + "; search: ", + "StringC", + "; searchFields: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; sortField: ", + "StringC", + "; sortOrder: ", + "UnionC", + "<[", + "LiteralC", + "<\"desc\">, ", + "LiteralC", + "<\"asc\">]>; owner: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 150 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindResponseRt", + "type": "Object", + "tags": [], + "label": "CasesFindResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; external_service: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector_id: ", + "StringC", + "; connector_name: ", + "StringC", + "; external_id: ", + "StringC", + "; external_title: ", + "StringC", + "; external_url: ", + "StringC", + "; }>, ", + "TypeC", + "<{ pushed_at: ", + "StringC", + "; pushed_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; }>]>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ subCaseIds: ", + "ArrayC", + "<", + "StringC", + ">; subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>; comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>, ", + "TypeC", + "<{ count_open_cases: ", + "NumberC", + "; count_in_progress_cases: ", + "NumberC", + "; count_closed_cases: ", + "NumberC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 232 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesPatchRequestRt", + "type": "Object", + "tags": [], + "label": "CasesPatchRequestRt", + "description": [], + "signature": [ + "TypeC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "PartialC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 250 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesResponseRt", + "type": "Object", + "tags": [], + "label": "CasesResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; tags: ", + "ArrayC", + "<", + "StringC", + ">; title: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".individual>]>; connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>]>; settings: ", + "TypeC", + "<{ syncAlerts: ", + "BooleanC", + "; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; external_service: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector_id: ", + "StringC", + "; connector_name: ", + "StringC", + "; external_id: ", + "StringC", + "; external_title: ", + "StringC", + "; external_url: ", + "StringC", + "; }>, ", + "TypeC", + "<{ pushed_at: ", + "StringC", + "; pushed_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; }>]>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ subCaseIds: ", + "ArrayC", + "<", + "StringC", + ">; subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>; comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 251 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatusRequestRt", + "type": "Object", + "tags": [], + "label": "CasesStatusRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ owner: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 30 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatusResponseRt", + "type": "Object", + "tags": [], + "label": "CasesStatusResponseRt", + "description": [], + "signature": [ + "TypeC", + "<{ count_open_cases: ", + "NumberC", + "; count_in_progress_cases: ", + "NumberC", + "; count_closed_cases: ", + "NumberC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseStatusRt", + "type": "Object", + "tags": [], + "label": "CaseStatusRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 16 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionAttributesRt", + "type": "Object", + "tags": [], + "label": "CaseUserActionAttributesRt", + "description": [], + "signature": [ + "TypeC", + "<{ action_field: ", + "ArrayC", + "<", + "UnionC", + "<[", + "LiteralC", + "<\"comment\">, ", + "LiteralC", + "<\"connector\">, ", + "LiteralC", + "<\"description\">, ", + "LiteralC", + "<\"pushed\">, ", + "LiteralC", + "<\"tags\">, ", + "LiteralC", + "<\"title\">, ", + "LiteralC", + "<\"status\">, ", + "LiteralC", + "<\"settings\">, ", + "LiteralC", + "<\"sub_case\">, ", + "LiteralC", + "<\"owner\">]>>; action: ", + "UnionC", + "<[", + "LiteralC", + "<\"add\">, ", + "LiteralC", + "<\"create\">, ", + "LiteralC", + "<\"delete\">, ", + "LiteralC", + "<\"update\">, ", + "LiteralC", + "<\"push-to-service\">]>; action_at: ", + "StringC", + "; action_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; new_value: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; old_value: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; owner: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 58 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionsResponseRt", + "type": "Object", + "tags": [], + "label": "CaseUserActionsResponseRt", + "description": [], + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ action_field: ", + "ArrayC", + "<", + "UnionC", + "<[", + "LiteralC", + "<\"comment\">, ", + "LiteralC", + "<\"connector\">, ", + "LiteralC", + "<\"description\">, ", + "LiteralC", + "<\"pushed\">, ", + "LiteralC", + "<\"tags\">, ", + "LiteralC", + "<\"title\">, ", + "LiteralC", + "<\"status\">, ", + "LiteralC", + "<\"settings\">, ", + "LiteralC", + "<\"sub_case\">, ", + "LiteralC", + "<\"owner\">]>>; action: ", + "UnionC", + "<[", + "LiteralC", + "<\"add\">, ", + "LiteralC", + "<\"create\">, ", + "LiteralC", + "<\"delete\">, ", + "LiteralC", + "<\"update\">, ", + "LiteralC", + "<\"push-to-service\">]>; action_at: ", + "StringC", + "; action_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; new_value: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; old_value: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ action_id: ", + "StringC", + "; case_id: ", + "StringC", + "; comment_id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "PartialC", + "<{ sub_case_id: ", + "StringC", + "; }>]>>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 60 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentAttributesBasicRt", + "type": "Object", + "tags": [], + "label": "CommentAttributesBasicRt", + "description": [], + "signature": [ + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 39 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchAttributesRt", + "type": "Object", + "tags": [], + "label": "CommentPatchAttributesRt", + "description": [ + "\nThis type is used by the CaseService.\nBecause the type for the attributes of savedObjectClient update function is Partial\nwe need to make all of our attributes partial too.\nWe ensure that partial updates of CommentContext is not going to happen inside the patch comment route." + ], + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "PartialC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>]>, ", + "PartialC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 120 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchRequestRt", + "type": "Object", + "tags": [], + "label": "CommentPatchRequestRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 105 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequestRt", + "type": "Object", + "tags": [], + "label": "CommentRequestRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 85 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponseRt", + "type": "Object", + "tags": [], + "label": "CommentResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 87 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponseTypeAlertsRt", + "type": "Object", + "tags": [], + "label": "CommentResponseTypeAlertsRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 95 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentsResponseRt", + "type": "Object", + "tags": [], + "label": "CommentsResponseRt", + "description": [], + "signature": [ + "TypeC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 125 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorFieldsRt", + "type": "Object", + "tags": [], + "label": "ConnectorFieldsRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappingsAttributesRT", + "type": "Object", + "tags": [], + "label": "ConnectorMappingsAttributesRT", + "description": [], + "signature": [ + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"append\">, ", + "LiteralC", + "<\"nothing\">, ", + "LiteralC", + "<\"overwrite\">]>; source: ", + "UnionC", + "<[", + "LiteralC", + "<\"title\">, ", + "LiteralC", + "<\"description\">, ", + "LiteralC", + "<\"comments\">]>; target: ", + "UnionC", + "<[", + "StringC", + ", ", + "LiteralC", + "<\"not_mapped\">]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 26 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappingsRt", + "type": "Object", + "tags": [], + "label": "ConnectorMappingsRt", + "description": [], + "signature": [ + "TypeC", + "<{ mappings: ", + "ArrayC", + "<", + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"append\">, ", + "LiteralC", + "<\"nothing\">, ", + "LiteralC", + "<\"overwrite\">]>; source: ", + "UnionC", + "<[", + "LiteralC", + "<\"title\">, ", + "LiteralC", + "<\"description\">, ", + "LiteralC", + "<\"comments\">]>; target: ", + "UnionC", + "<[", + "StringC", + ", ", + "LiteralC", + "<\"not_mapped\">]>; }>>; owner: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 32 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorTypeFieldsRt", + "type": "Object", + "tags": [], + "label": "ConnectorTypeFieldsRt", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR>; fields: ", + "UnionC", + "<[", + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>, ", + "NullC", + "]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none>; fields: ", + "NullC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 66 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ContextTypeUserRt", + "type": "Object", + "tags": [], + "label": "ContextTypeUserRt", + "description": [], + "signature": [ + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 59 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ExternalServiceResponseRt", + "type": "Object", + "tags": [], + "label": "ExternalServiceResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ title: ", + "StringC", + "; id: ", + "StringC", + "; pushedDate: ", + "StringC", + "; url: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ commentId: ", + "StringC", + "; pushedDate: ", + "StringC", + "; }>, ", + "PartialC", + "<{ externalCommentId: ", + "StringC", + "; }>]>>; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 258 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FindQueryParamsRt", + "type": "Object", + "tags": [], + "label": "FindQueryParamsRt", + "description": [], + "signature": [ + "PartialC", + "<{ subCaseId: ", + "StringC", + "; defaultSearchOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; hasReferenceOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; hasReference: ", + "UnionC", + "<[", + "ArrayC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; type: ", + "StringC", + "; }>>, ", + "TypeC", + "<{ id: ", + "StringC", + "; type: ", + "StringC", + "; }>]>; fields: ", + "ArrayC", + "<", + "StringC", + ">; filter: ", + "StringC", + "; page: ", + "Type", + "; perPage: ", + "Type", + "; search: ", + "StringC", + "; searchFields: ", + "ArrayC", + "<", + "StringC", + ">; sortField: ", + "StringC", + "; sortOrder: ", + "UnionC", + "<[", + "LiteralC", + "<\"desc\">, ", + "LiteralC", + "<\"asc\">]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 134 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.GetCaseIdsByAlertIdAggsRt", + "type": "Object", + "tags": [], + "label": "GetCaseIdsByAlertIdAggsRt", + "description": [], + "signature": [ + "TypeC", + "<{ references: ", + "TypeC", + "<{ doc_count: ", + "NumberC", + "; caseIds: ", + "TypeC", + "<{ buckets: ", + "ArrayC", + "<", + "TypeC", + "<{ key: ", + "StringC", + "; }>>; }>; }>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 19 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.GetConfigureFindRequestRt", + "type": "Object", + "tags": [], + "label": "GetConfigureFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ owner: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 64 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.JiraFieldsRT", + "type": "Object", + "tags": [], + "label": "JiraFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; parent: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.NumberFromString", + "type": "Object", + "tags": [], + "label": "NumberFromString", + "description": [], + "signature": [ + "Type", + "" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 12 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ResilientFieldsRT", + "type": "Object", + "tags": [], + "label": "ResilientFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC", + "]>; severityCode: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SavedObjectFindOptionsRt", + "type": "Object", + "tags": [], + "label": "SavedObjectFindOptionsRt", + "description": [], + "signature": [ + "PartialC", + "<{ defaultSearchOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; hasReferenceOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; hasReference: ", + "UnionC", + "<[", + "ArrayC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; type: ", + "StringC", + "; }>>, ", + "TypeC", + "<{ id: ", + "StringC", + "; type: ", + "StringC", + "; }>]>; fields: ", + "ArrayC", + "<", + "StringC", + ">; filter: ", + "StringC", + "; page: ", + "Type", + "; perPage: ", + "Type", + "; search: ", + "StringC", + "; searchFields: ", + "ArrayC", + "<", + "StringC", + ">; sortField: ", + "StringC", + "; sortOrder: ", + "UnionC", + "<[", + "LiteralC", + "<\"desc\">, ", + "LiteralC", + "<\"asc\">]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowITSMFieldsRT", + "type": "Object", + "tags": [], + "label": "ServiceNowITSMFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; urgency: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowSIRFieldsRT", + "type": "Object", + "tags": [], + "label": "ServiceNowSIRFieldsRT", + "description": [], + "signature": [ + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareHash: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; malwareUrl: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; priority: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; sourceIp: ", + "UnionC", + "<[", + "BooleanC", + ", ", + "NullC", + "]>; subcategory: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 11 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseAttributesRt", + "type": "Object", + "tags": [], + "label": "SubCaseAttributesRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 23 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasePatchRequestRt", + "type": "Object", + "tags": [], + "label": "SubCasePatchRequestRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 99 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseResponseRt", + "type": "Object", + "tags": [], + "label": "SubCaseResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 76 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindRequestRt", + "type": "Object", + "tags": [], + "label": "SubCasesFindRequestRt", + "description": [], + "signature": [ + "PartialC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; defaultSearchOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; fields: ", + "ArrayC", + "<", + "StringC", + ">; page: ", + "Type", + "; perPage: ", + "Type", + "; search: ", + "StringC", + "; searchFields: ", + "ArrayC", + "<", + "StringC", + ">; sortField: ", + "StringC", + "; sortOrder: ", + "UnionC", + "<[", + "LiteralC", + "<\"desc\">, ", + "LiteralC", + "<\"asc\">]>; owner: ", + "StringC", + "; }>" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 36 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindResponseRt", + "type": "Object", + "tags": [], + "label": "SubCasesFindResponseRt", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", + "UnionC", + "<[", + "ArrayC", + "<", "StringC", ">, ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 30 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesStatusResponseRt", - "type": "Object", - "tags": [], - "label": "CasesStatusResponseRt", - "description": [], - "signature": [ + "StringC", + "]>; index: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "StringC", + "]>; rule: ", + "TypeC", + "<{ id: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; name: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; }>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>, ", "TypeC", "<{ count_open_cases: ", "NumberC", @@ -7888,23 +20348,31 @@ "NumberC", "; count_closed_cases: ", "NumberC", - "; }>" + "; }>]>" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 24 + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 89 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseStatusRt", + "id": "def-common.SubCasesPatchRequestRt", "type": "Object", "tags": [], - "label": "CaseStatusRt", + "label": "SubCasesPatchRequestRt", "description": [], "signature": [ + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "PartialC", + "<{ status: ", "UnionC", "<[", "LiteralC", @@ -7925,75 +20393,48 @@ "docId": "kibCasesPluginApi", "section": "def-common.CaseStatuses", "text": "CaseStatuses" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 16 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseUserActionAttributesRt", - "type": "Object", - "tags": [], - "label": "CaseUserActionAttributesRt", - "description": [], - "signature": [ - "TypeC", - "<{ action_field: ", - "ArrayC", - "<", - "UnionC", - "<[", + }, + "[\"in-progress\"]>, ", "LiteralC", - "<\"comment\">, ", - "LiteralC" + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 58 + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 104 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActionsResponseRt", + "id": "def-common.SubCasesResponseRt", "type": "Object", "tags": [], - "label": "CaseUserActionsResponseRt", + "label": "SubCasesResponseRt", "description": [], "signature": [ "ArrayC", "<", "IntersectionC", "<[", + "IntersectionC", + "<[", "TypeC", - "<{ action_field: ", - "ArrayC", - "<", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 60 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentAttributesBasicRt", - "type": "Object", - "tags": [], - "label": "CommentAttributesBasicRt", - "description": [], - "signature": [ - "TypeC", - "<{ associationType: ", + "<{ status: ", "UnionC", "<[", "LiteralC", @@ -8002,81 +20443,158 @@ "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".case>, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 39 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentPatchAttributesRt", - "type": "Object", - "tags": [], - "label": "CommentPatchAttributesRt", - "description": [ - "\nThis type is used by the CaseService.\nBecause the type for the attributes of savedObjectClient update function is Partial\nwe need to make all of our attributes partial too.\nWe ensure that partial updates of CommentContext is not going to happen inside the patch comment route." - ], - "signature": [ - "IntersectionC", + ".open>, ", + "LiteralC", + ", ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".closed>]>; }>, ", + "TypeC", + "<{ closed_at: ", + "UnionC", "<[", + "StringC", + ", ", + "NullC", + "]>; closed_by: ", "UnionC", "<[", - "PartialC", - "<{ associationType: ", + "TypeC", + "<{ email: ", "UnionC", "<[", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 120 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentPatchRequestRt", - "type": "Object", - "tags": [], - "label": "CommentPatchRequestRt", - "description": [], - "signature": [ - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; created_at: ", + "StringC", + "; created_by: ", "UnionC", "<[", "TypeC", - "<{ comment: ", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - "; type: ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 105 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentRequestRt", - "type": "Object", - "tags": [], - "label": "CommentRequestRt", - "description": [], - "signature": [ + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", + "<[", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; owner: ", + "StringC", + "; }>]>, ", + "TypeC", + "<{ id: ", + "StringC", + "; totalComment: ", + "NumberC", + "; totalAlerts: ", + "NumberC", + "; version: ", + "StringC", + "; }>, ", + "PartialC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", "UnionC", "<[", + "IntersectionC", + "<[", "TypeC", "<{ comment: ", "StringC", @@ -8089,208 +20607,142 @@ "docId": "kibCasesPluginApi", "section": "def-common.CommentType", "text": "CommentType" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 85 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentResponseRt", - "type": "Object", - "tags": [], - "label": "CommentResponseRt", - "description": [], - "signature": [ - "IntersectionC", + }, + ".user>; owner: ", + "StringC", + "; }>, ", + "TypeC", + "<{ associationType: ", + "UnionC", "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", "UnionC", "<[", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", "<[", - "TypeC", - "<{ comment: ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 87 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentResponseTypeAlertsRt", - "type": "Object", - "tags": [], - "label": "CommentResponseTypeAlertsRt", - "description": [], - "signature": [ - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", "<[", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", + "UnionC", "<[", - "TypeC", - "<{ type: ", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", "UnionC", "<[", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 95 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentsResponseRt", - "type": "Object", - "tags": [], - "label": "CommentsResponseRt", - "description": [], - "signature": [ "TypeC", - "<{ comments: ", - "ArrayC", - "<", - "IntersectionC", + "<{ email: ", + "UnionC", "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", "UnionC", "<[", - "IntersectionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 125 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorFieldsRt", - "type": "Object", - "tags": [], - "label": "ConnectorFieldsRt", - "description": [], - "signature": [ + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", "UnionC", "<[", - "TypeC", - "<{ issueType: ", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", "UnionC", "<[", "StringC", ", ", - "NullC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 25 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorMappingsAttributesRT", - "type": "Object", - "tags": [], - "label": "ConnectorMappingsAttributesRT", - "description": [], - "signature": [ - "TypeC", - "<{ action_type: ", + "NullC", + "]>; updated_by: ", "UnionC", "<[", - "LiteralC", - "<\"append\">, ", - "LiteralC", - "<\"nothing\">, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 26 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorMappingsRt", - "type": "Object", - "tags": [], - "label": "ConnectorMappingsRt", - "description": [], - "signature": [ - "TypeC", - "<{ mappings: ", - "ArrayC", - "<", "TypeC", - "<{ action_type: ", + "<{ email: ", "UnionC", "<[", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 32 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorTypeFieldsRt", - "type": "Object", - "tags": [], - "label": "ConnectorTypeFieldsRt", - "description": [], - "signature": [ + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", "UnionC", "<[", - "TypeC", - "<{ type: ", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - }, - ".jira>; fields: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 66 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ContextTypeUserRt", - "type": "Object", - "tags": [], - "label": "ContextTypeUserRt", - "description": [], - "signature": [ - "TypeC", - "<{ comment: ", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", "StringC", - "; type: ", + "]>; }>, ", + "NullC", + "]>; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", "LiteralC", "<", { @@ -8300,271 +20752,51 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".user>; owner: ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 59 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ExternalServiceResponseRt", - "type": "Object", - "tags": [], - "label": "ExternalServiceResponseRt", - "description": [], - "signature": [ - "IntersectionC", - "<[", - "TypeC", - "<{ title: ", - "StringC", - "; id: ", - "StringC", - "; pushedDate: ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 258 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.FindQueryParamsRt", - "type": "Object", - "tags": [], - "label": "FindQueryParamsRt", - "description": [], - "signature": [ - "PartialC", - "<{ subCaseId: ", - "StringC", - "; defaultSearchOperator: ", - "UnionC", - "<[", + ".generatedAlert>, ", "LiteralC", - "<\"AND\">, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 134 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.GetCaseIdsByAlertIdAggsRt", - "type": "Object", - "tags": [], - "label": "GetCaseIdsByAlertIdAggsRt", - "description": [], - "signature": [ - "TypeC", - "<{ references: ", - "TypeC", - "<{ doc_count: ", - "NumberC", - "; caseIds: ", - "TypeC", - "<{ buckets: ", - "ArrayC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 19 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.GetConfigureFindRequestRt", - "type": "Object", - "tags": [], - "label": "GetConfigureFindRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ owner: ", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert>]>; alertId: ", "UnionC", "<[", "ArrayC", "<", "StringC", ">, ", - "StringC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 64 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.JiraFieldsRT", - "type": "Object", - "tags": [], - "label": "JiraFieldsRT", - "description": [], - "signature": [ - "TypeC", - "<{ issueType: ", - "UnionC", - "<[", "StringC", - ", ", - "NullC", - "]>; priority: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", - "lineNumber": 11 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.NumberFromString", - "type": "Object", - "tags": [], - "label": "NumberFromString", - "description": [], - "signature": [ - "Type", - "" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 12 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ResilientFieldsRT", - "type": "Object", - "tags": [], - "label": "ResilientFieldsRT", - "description": [], - "signature": [ - "TypeC", - "<{ incidentTypes: ", + "]>; index: ", "UnionC", "<[", "ArrayC", "<", "StringC", ">, ", - "NullC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", - "lineNumber": 11 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SavedObjectFindOptionsRt", - "type": "Object", - "tags": [], - "label": "SavedObjectFindOptionsRt", - "description": [], - "signature": [ - "PartialC", - "<{ defaultSearchOperator: ", - "UnionC", - "<[", - "LiteralC", - "<\"AND\">, ", - "LiteralC", - "<\"OR\">]>; hasReferenceOperator: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 25 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ServiceNowITSMFieldsRT", - "type": "Object", - "tags": [], - "label": "ServiceNowITSMFieldsRT", - "description": [], - "signature": [ + "StringC", + "]>; rule: ", "TypeC", - "<{ impact: ", + "<{ id: ", "UnionC", "<[", "StringC", ", ", "NullC", - "]>; severity: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", - "lineNumber": 11 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ServiceNowSIRFieldsRT", - "type": "Object", - "tags": [], - "label": "ServiceNowSIRFieldsRT", - "description": [], - "signature": [ - "TypeC", - "<{ category: ", + "]>; name: ", "UnionC", "<[", "StringC", ", ", "NullC", - "]>; destIp: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", - "lineNumber": 11 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCaseAttributesRt", - "type": "Object", - "tags": [], - "label": "SubCaseAttributesRt", - "description": [], - "signature": [ - "IntersectionC", - "<[", + "]>; }>; owner: ", + "StringC", + "; }>, ", "TypeC", - "<{ status: ", + "<{ associationType: ", "UnionC", "<[", "LiteralC", @@ -8573,171 +20805,128 @@ "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 23 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasePatchRequestRt", - "type": "Object", - "tags": [], - "label": "SubCasePatchRequestRt", - "description": [], - "signature": [ - "IntersectionC", - "<[", - "PartialC", - "<{ status: ", - "UnionC", - "<[", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", "LiteralC", "<", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 99 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCaseResponseRt", - "type": "Object", - "tags": [], - "label": "SubCaseResponseRt", - "description": [], - "signature": [ - "IntersectionC", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".subCase>]>; created_at: ", + "StringC", + "; created_by: ", + "TypeC", + "<{ email: ", + "UnionC", "<[", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", "<[", - "TypeC", - "<{ status: ", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", "UnionC", "<[", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 76 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesFindRequestRt", - "type": "Object", - "tags": [], - "label": "SubCasesFindRequestRt", - "description": [], - "signature": [ - "PartialC", - "<{ status: ", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>; owner: ", + "StringC", + "; pushed_at: ", "UnionC", "<[", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - ".open>, ", - "LiteralC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 36 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesFindResponseRt", - "type": "Object", - "tags": [], - "label": "SubCasesFindResponseRt", - "description": [], - "signature": [ - "IntersectionC", + "StringC", + ", ", + "NullC", + "]>; pushed_by: ", + "UnionC", "<[", "TypeC", - "<{ subCases: ", - "ArrayC", - "<", - "IntersectionC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; updated_at: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; updated_by: ", + "UnionC", "<[", - "IntersectionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 89 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesPatchRequestRt", - "type": "Object", - "tags": [], - "label": "SubCasesPatchRequestRt", - "description": [], - "signature": [ "TypeC", - "<{ subCases: ", - "ArrayC", - "<", - "IntersectionC", + "<{ email: ", + "UnionC", "<[", - "PartialC", - "<{ status: ", - "UnionC" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 104 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesResponseRt", - "type": "Object", - "tags": [], - "label": "SubCasesResponseRt", - "description": [], - "signature": [ - "ArrayC", - "<", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", "<[", - "IntersectionC", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>, ", + "NullC", + "]>; }>]>]>, ", "TypeC", - "<{ status: ", - "UnionC" + "<{ id: ", + "StringC", + "; version: ", + "StringC", + "; }>]>>; }>]>>" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", @@ -8762,7 +20951,24 @@ ", ", "NullC", ", ", - "StringC" + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>" ], "source": { "path": "x-pack/plugins/cases/common/api/user.ts", @@ -8787,7 +20993,26 @@ "<[", "UndefinedC", ", ", - "NullC" + "NullC", + ", ", + "StringC", + "]>; full_name: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; username: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC", + "]>; }>>" ], "source": { "path": "x-pack/plugins/cases/common/api/user.ts", diff --git a/api_docs/charts.json b/api_docs/charts.json index 472631574b9ad1..f42832e5d1e95f 100644 --- a/api_docs/charts.json +++ b/api_docs/charts.json @@ -179,7 +179,9 @@ "type": "Array", "tags": [], "label": "xValues", - "description": [], + "description": [ + "sorted and unquie x values" + ], "signature": [ "number[]" ], @@ -352,7 +354,17 @@ "> | undefined, splitChartAccessor?: string | number | ", "AccessorFn", " | undefined, negate?: boolean) => (points: [", - "GeometryValue" + "GeometryValue", + ", ", + "XYChartSeriesIdentifier", + "][]) => ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ClickTriggerEvent", + "text": "ClickTriggerEvent" + } ], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", @@ -407,7 +419,9 @@ "type": "Object", "tags": [], "label": "splitSeriesAccessorFnMap", - "description": [], + "description": [ + "needed when using `splitSeriesAccessors` as `AccessorFn`" + ], "signature": [ "Map JSX.Element>" + "React.NamedExoticComponent & { readonly type: ({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element; }" ], "source": { "path": "src/plugins/charts/public/static/components/legend_toggle.tsx", "lineNumber": 51 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.props", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 359 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1575,7 +1608,28 @@ "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 81 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [ + "The internal state of the palette" + ], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 81 + }, + "deprecated": false + } + ] }, { "parentPluginId": "charts", @@ -1609,7 +1663,76 @@ "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 87 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.series", + "type": "Array", + "tags": [], + "label": "series", + "description": [ + "The current series along with its ancestors." + ], + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.SeriesLayer", + "text": "SeriesLayer" + }, + "[]" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 88 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.chartConfiguration", + "type": "Object", + "tags": [], + "label": "chartConfiguration", + "description": [], + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ChartColorConfiguration", + "text": "ChartColorConfiguration" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 89 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [ + "The internal state of the palette" + ], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 90 + }, + "deprecated": false + } + ] }, { "parentPluginId": "charts", @@ -1627,7 +1750,39 @@ "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 96 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.size", + "type": "number", + "tags": [], + "label": "size", + "description": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 96 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 96 + }, + "deprecated": false + } + ] }, { "parentPluginId": "charts", @@ -1774,7 +1929,23 @@ "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 113 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 113 + }, + "deprecated": false + } + ] }, { "parentPluginId": "charts", @@ -1798,7 +1969,9 @@ "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 114 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -2105,13 +2278,10 @@ { "parentPluginId": "charts", "id": "def-public.defaultCountLabel", - "type": "Any", + "type": "string", "tags": [], "label": "defaultCountLabel", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 26 @@ -2127,7 +2297,7 @@ "label": "LabelRotation", "description": [], "signature": [ - "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" + "number" ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", @@ -2206,7 +2376,7 @@ "label": "ColorMode", "description": [], "signature": [ - "Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>" + "{ readonly Background: \"Background\"; readonly Labels: \"Labels\"; readonly None: \"None\"; }" ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", @@ -2223,7 +2393,7 @@ "label": "LabelRotation", "description": [], "signature": [ - "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" + "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; }" ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", @@ -2301,13 +2471,10 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.label", - "type": "Any", + "type": "string", "tags": [], "label": "label", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 39 @@ -2371,13 +2538,10 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.label", - "type": "Any", + "type": "string", "tags": [], "label": "label", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 57 @@ -2441,13 +2605,10 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.label", - "type": "Any", + "type": "string", "tags": [], "label": "label", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 75 @@ -2511,13 +2672,10 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.label", - "type": "Any", + "type": "string", "tags": [], "label": "label", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 93 @@ -2581,13 +2739,10 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label", - "type": "Any", + "type": "string", "tags": [], "label": "label", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 111 @@ -2651,13 +2806,10 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label", - "type": "Any", + "type": "string", "tags": [], "label": "label", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 130 @@ -2694,7 +2846,13 @@ "label": "ChartsPluginStart", "description": [], "signature": [ - "ChartsPluginSetup" + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ChartsPluginSetup", + "text": "ChartsPluginSetup" + } ], "source": { "path": "src/plugins/charts/public/plugin.ts", @@ -2763,7 +2921,18 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" - } + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/charts/common/palette.ts", @@ -2821,7 +2990,10 @@ "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" - } + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/charts/common/palette.ts", diff --git a/api_docs/core.json b/api_docs/core.json index 550b9e337923ed..0f856afee51c5b 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -1026,7 +1026,7 @@ "Navigation link capabilities." ], "signature": [ - "Record" + "{ [x: string]: boolean; }" ], "source": { "path": "src/core/types/capabilities.ts", @@ -1062,7 +1062,7 @@ "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], "signature": [ - "Record" + "{ [x: string]: boolean; }" ], "source": { "path": "src/core/types/capabilities.ts", @@ -1267,20 +1267,23 @@ "{@link StartServicesAccessor}" ], "signature": [ + "() => Promise<[", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.StartServicesAccessor", - "text": "StartServicesAccessor" + "section": "def-public.CoreStart", + "text": "CoreStart" }, - "" + ", TPluginsStart, TStart]>" ], "source": { "path": "src/core/public/index.ts", "lineNumber": 224 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1629,7 +1632,9 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 24 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -1649,7 +1654,23 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.domainId", + "type": "string", + "tags": [], + "label": "domainId", + "description": [], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -1669,7 +1690,26 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 36 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.details", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "DomainDeprecationDetails" + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 36 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -1697,7 +1737,26 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 42 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.details", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "DomainDeprecationDetails" + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2007,7 +2066,46 @@ "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "lineNumber": 38 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [ + "- The error to display" + ], + "signature": [ + "string | Error" + ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.source", + "type": "string", + "tags": [], + "label": "source", + "description": [ + "- Adds a prefix of the form `${source}: ` to the error message" + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 38 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2035,7 +2133,9 @@ "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "lineNumber": 43 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -2071,7 +2171,26 @@ "path": "src/core/public/i18n/i18n_service.tsx", "lineNumber": 65 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ children: React.ReactNode; }" + ], + "source": { + "path": "src/core/public/i18n/i18n_service.tsx", + "lineNumber": 65 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2176,7 +2295,39 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 33 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 33 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2196,7 +2347,39 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 39 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 39 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2218,7 +2401,9 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 45 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -2236,7 +2421,39 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 54 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 54 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 54 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2254,7 +2471,23 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 61 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 61 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2272,7 +2505,23 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2290,7 +2539,23 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 72 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 72 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2308,7 +2573,23 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 79 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 79 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2326,7 +2607,23 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 84 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 84 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2346,7 +2643,9 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 90 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -2366,7 +2665,9 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 100 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -2394,29 +2695,167 @@ "{@link ToastsSetup}" ], "signature": [ - "Pick<", + "{ get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastsApi", - "text": "ToastsApi" + "section": "def-public.Toast", + "text": "Toast" }, - ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" - ], - "source": { - "path": "src/core/public/notifications/notifications_service.ts", - "lineNumber": 78 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.NotificationsStart", - "type": "Interface", + "[]>; add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 78 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.NotificationsStart", + "type": "Interface", "tags": [], "label": "NotificationsStart", "description": [], @@ -2436,15 +2875,153 @@ "{@link ToastsStart}" ], "signature": [ - "Pick<", + "{ get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastsApi", - "text": "ToastsApi" + "section": "def-public.Toast", + "text": "Toast" }, - ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + "; }" ], "source": { "path": "src/core/public/notifications/notifications_service.ts", @@ -3494,7 +4071,56 @@ "path": "src/core/public/overlays/overlay_service.ts", "lineNumber": 52 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.mount", + "type": "Function", + "tags": [], + "label": "mount", + "description": [], + "signature": [ + "(element: HTMLElement) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 74 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 74 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -3535,7 +4161,56 @@ "path": "src/core/public/overlays/overlay_service.ts", "lineNumber": 54 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.mount", + "type": "Function", + "tags": [], + "label": "mount", + "description": [], + "signature": [ + "(element: HTMLElement) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 86 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 86 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -3569,7 +4244,57 @@ "path": "src/core/public/overlays/overlay_service.ts", "lineNumber": 56 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.message", + "type": "CompoundType", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 94 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 94 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -6278,7 +7003,13 @@ "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" ], "signature": [ - "FatalErrorsSetup" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorsSetup", + "text": "FatalErrorsSetup" + } ], "source": { "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", @@ -6297,7 +7028,153 @@ "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." ], "signature": [ - "{ get$: () => Rx.Observable; add: (toastOrTitle: ToastInput) => Toast; remove: (toastOrId: string | Toast) => void; addSuccess: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addWarning: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addDanger: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addError: (error: Error, options: ErrorToastOptions) => Toast; addInfo: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; }" + "{ get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", @@ -6402,7 +7279,11 @@ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" + "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: ", + "UiCounterMetricType", + "; name: string; } | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + "DeprecationSettings", + " | undefined; }" ], "source": { "path": "src/core/types/ui_settings.ts", @@ -6438,11 +7319,11 @@ "\nType definition for a Saved Object attribute value\n" ], "signature": [ - "undefined | null | string | number | false | true | ", + "string | number | boolean | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", - "[]" + "[] | null | undefined" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -6461,8 +7342,9 @@ "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" ], "signature": [ - "undefined | null | string | number | false | true | ", - "SavedObjectAttributes" + "string | number | boolean | ", + "SavedObjectAttributes", + " | null | undefined" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -6558,7 +7440,25 @@ "label": "Toast", "description": [], "signature": [ - "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; } & { id: string; }" + "Pick<", + "Toast", + ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; text?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; } & { id: string; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", @@ -6603,7 +7503,25 @@ "\nAllowed fields for {@link ToastInput}.\n" ], "signature": [ - "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; }" + "Pick<", + "Toast", + ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; text?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", @@ -6655,7 +7573,120 @@ "docId": "kibCorePluginApi", "section": "def-public.Toast", "text": "Toast" - } + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_service.tsx", @@ -6707,7 +7738,120 @@ "docId": "kibCorePluginApi", "section": "def-public.Toast", "text": "Toast" - } + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_service.tsx", @@ -7168,7 +8312,7 @@ "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." ], "signature": [ - "Record" + "{ [x: string]: string; }" ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", @@ -7604,7 +8748,9 @@ "type": "string", "tags": [], "label": "endpoint", - "description": [], + "description": [ + "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." + ], "signature": [ "string" ], @@ -7621,7 +8767,9 @@ "type": "Object", "tags": [], "label": "clientParams", - "description": [], + "description": [ + "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." + ], "signature": [ "Record" ], @@ -7638,7 +8786,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- Options that affect the way we call the API and process the result." + ], "signature": [ { "pluginId": "core", @@ -7800,15 +8950,14 @@ "label": "isNotAuthorizedError", "description": [], "signature": [ - "typeof ", + "(error: any) => error is ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchErrorHelpers", - "text": "LegacyElasticsearchErrorHelpers" - }, - ".isNotAuthorizedError" + "section": "def-server.LegacyElasticsearchError", + "text": "LegacyElasticsearchError" + } ], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", @@ -7844,15 +8993,14 @@ "label": "decorateNotAuthorizedError", "description": [], "signature": [ - "typeof ", + "(error: Error, reason?: string | undefined) => ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchErrorHelpers", - "text": "LegacyElasticsearchErrorHelpers" - }, - ".decorateNotAuthorizedError" + "section": "def-server.LegacyElasticsearchError", + "text": "LegacyElasticsearchError" + } ], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", @@ -7961,7 +9109,7 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", - "lineNumber": 25 + "lineNumber": 24 } } ], @@ -9180,7 +10328,7 @@ "Navigation link capabilities." ], "signature": [ - "Record" + "{ [x: string]: boolean; }" ], "source": { "path": "src/core/types/capabilities.ts", @@ -9216,7 +10364,7 @@ "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], "signature": [ - "Record" + "{ [x: string]: boolean; }" ], "source": { "path": "src/core/types/capabilities.ts", @@ -9486,7 +10634,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 87 + "lineNumber": 96 }, "deprecated": false, "children": [ @@ -9507,7 +10655,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 100 + "lineNumber": 109 }, "deprecated": false, "children": [ @@ -9523,7 +10671,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 100 + "lineNumber": 109 }, "deprecated": false, "isRequired": true @@ -9540,7 +10688,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 100 + "lineNumber": 109 }, "deprecated": false, "isRequired": true @@ -9559,7 +10707,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 100 + "lineNumber": 109 }, "deprecated": false, "isRequired": false @@ -9584,7 +10732,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 116 + "lineNumber": 125 }, "deprecated": false, "children": [ @@ -9600,7 +10748,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 116 + "lineNumber": 125 }, "deprecated": false, "isRequired": true @@ -9617,7 +10765,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 116 + "lineNumber": 125 }, "deprecated": false, "isRequired": true @@ -9636,7 +10784,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 116 + "lineNumber": 125 }, "deprecated": false, "isRequired": false @@ -9661,7 +10809,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 129 + "lineNumber": 138 }, "deprecated": false, "children": [ @@ -9677,7 +10825,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 129 + "lineNumber": 138 }, "deprecated": false, "isRequired": true @@ -9696,7 +10844,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 129 + "lineNumber": 138 }, "deprecated": false, "isRequired": false @@ -9721,7 +10869,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 145 + "lineNumber": 154 }, "deprecated": false, "children": [ @@ -9737,7 +10885,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 145 + "lineNumber": 154 }, "deprecated": false, "isRequired": true @@ -9756,7 +10904,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 145 + "lineNumber": 154 }, "deprecated": false, "isRequired": false @@ -10120,20 +11268,23 @@ "{@link StartServicesAccessor}" ], "signature": [ + "() => Promise<[", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.StartServicesAccessor", - "text": "StartServicesAccessor" + "section": "def-server.CoreStart", + "text": "CoreStart" }, - "" + ", TPluginsStart, TStart]>" ], "source": { "path": "src/core/server/index.ts", "lineNumber": 499 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -10746,13 +11897,7 @@ "label": "level", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MIGRATION_DEPRECATION_LEVEL", - "text": "MIGRATION_DEPRECATION_LEVEL" - } + "\"warning\" | \"none\" | \"info\" | \"critical\"" ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", @@ -10891,7 +12036,7 @@ "label": "correctiveActions", "description": [], "signature": [ - "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps: string[]; }" + "{ api?: { path: string; method: \"PUT\" | \"POST\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps: string[]; }" ], "source": { "path": "src/core/server/deprecations/types.ts", @@ -10989,7 +12134,32 @@ "path": "src/core/server/deprecations/deprecations_service.ts", "lineNumber": 102 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.deprecationContext", + "type": "Object", + "tags": [], + "label": "deprecationContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + } + ], + "source": { + "path": "src/core/server/deprecations/deprecations_service.ts", + "lineNumber": 102 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -11155,7 +12325,8 @@ "docId": "kibCorePluginApi", "section": "def-server.LegacyClusterClient", "text": "LegacyClusterClient" - } + }, + ", \"callAsInternalUser\" | \"asScoped\">; }" ], "source": { "path": "src/core/server/elasticsearch/types.ts", @@ -11264,7 +12435,51 @@ "path": "src/core/server/elasticsearch/types.ts", "lineNumber": 116 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "Unique identifier of the client" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 117 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.clientConfig", + "type": "Object", + "tags": [], + "label": "clientConfig", + "description": [ + "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." + ], + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 118 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -11309,7 +12524,8 @@ "docId": "kibCorePluginApi", "section": "def-server.LegacyClusterClient", "text": "LegacyClusterClient" - } + }, + ", \"callAsInternalUser\" | \"asScoped\">; }" ], "source": { "path": "src/core/server/elasticsearch/types.ts", @@ -11549,75 +12765,361 @@ "Headers used for authentication against Elasticsearch" ], "signature": [ + "{ accept?: 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; allow?: 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; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: 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; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: 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; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 191 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext", + "type": "Interface", + "tags": [], + "label": "GetDeprecationsContext", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 70 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.esClient", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 71 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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": "kibCoreHttpPluginApi", - "section": "def-server.Headers", - "text": "Headers" - } - ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 191 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext", - "type": "Interface", - "tags": [], - "label": "GetDeprecationsContext", - "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 70 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext.esClient", - "type": "Object", - "tags": [], - "label": "esClient", - "description": [], - "signature": [ + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } - ], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 71 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "Pick<", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + "; }" ], "source": { "path": "src/core/server/deprecations/types.ts", @@ -11818,30 +13320,459 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - ">(route: ", + ">(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, - ", handler: ", + ") => ", + "KibanaResponse", + "; } & ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesServiceToolkit", + "text": "HttpResourcesServiceToolkit" }, - " | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", - "Stream" + ">) => void" ], "source": { "path": "src/core/server/http_resources/types.ts", "lineNumber": 101 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 102 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; } & ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesServiceToolkit", + "text": "HttpResourcesServiceToolkit" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 103 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -11929,7 +13860,33 @@ "path": "src/core/server/http_resources/types.ts", "lineNumber": 45 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -11963,7 +13920,33 @@ "path": "src/core/server/http_resources/types.ts", "lineNumber": 47 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 47 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -11997,7 +13980,32 @@ "path": "src/core/server/http_resources/types.ts", "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12031,7 +14039,32 @@ "path": "src/core/server/http_resources/types.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 51 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -12117,13 +14150,17 @@ "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } + "Pick<", + "KibanaClient", + ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", + "TransportRequestParams", + ", options?: ", + "TransportRequestOptions", + " | undefined): ", + "TransportRequestPromise", + "<", + "ApiResponse", + ", unknown>>; }; }" ], "source": { "path": "src/core/server/elasticsearch/client/cluster_client.ts", @@ -12162,7 +14199,48 @@ "path": "src/core/server/elasticsearch/client/cluster_client.ts", "lineNumber": 37 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 37 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -12300,29 +14378,382 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, - "; customError: (options: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" }, - ", any, { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + ") => ", + "KibanaResponse", + " | Buffer | ", "Stream", - " | undefined>(options: ", + ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, - ") => ", - "KibanaResponse" + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -12374,7 +14805,7 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - ", any, { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + ", any, { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { @@ -12385,7 +14816,170 @@ "text": "CustomHttpResponseOptions" }, ") => ", - "KibanaResponse" + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -12546,7 +15140,9 @@ "path": "src/core/server/elasticsearch/client/cluster_client.ts", "lineNumber": 50 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -12758,13 +15354,17 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } + "Pick<", + "KibanaClient", + ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", + "TransportRequestParams", + ", options?: ", + "TransportRequestOptions", + " | undefined): ", + "TransportRequestPromise", + "<", + "ApiResponse", + ", unknown>>; }; }" ], "source": { "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", @@ -12782,13 +15382,17 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } + "Pick<", + "KibanaClient", + ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", + "TransportRequestParams", + ", options?: ", + "TransportRequestOptions", + " | undefined): ", + "TransportRequestPromise", + "<", + "ApiResponse", + ", unknown>>; }; }" ], "source": { "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", @@ -12832,7 +15436,9 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -12850,7 +15456,23 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 35 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 35 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12868,7 +15490,9 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 39 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -12888,7 +15512,9 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 43 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -12906,7 +15532,26 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 47 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.changes", + "type": "Object", + "tags": [], + "label": "changes", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 47 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12924,7 +15569,39 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 51 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 51 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12942,7 +15619,23 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 55 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 55 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12960,7 +15653,26 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 59 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.keys", + "type": "Array", + "tags": [], + "label": "keys", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 59 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12978,7 +15690,23 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 63 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -12996,7 +15724,23 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -13535,6 +16279,27 @@ "lineNumber": 20 } }, + { + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/target/types/server/schemas/common/get_call_cluster.mock.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/target/types/server/schemas/common/get_call_cluster.mock.d.ts", + "lineNumber": 4 + } + }, + { + "plugin": "lists", + "link": { + "path": "x-pack/plugins/lists/target/types/server/schemas/common/get_call_cluster.mock.d.ts", + "lineNumber": 5 + } + }, { "plugin": "monitoring", "link": { @@ -16348,7 +19113,9 @@ "path": "src/core/server/metrics/types.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -16619,7 +19386,7 @@ "The os platform" ], "signature": [ - "NodeJS.Platform" + "\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\" | \"netbsd\"" ], "source": { "path": "src/core/server/metrics/collectors/types.ts", @@ -17255,13 +20022,7 @@ "\nSchema to use to validate the plugin configuration.\n\n{@link PluginConfigSchema}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginConfigSchema", - "text": "PluginConfigSchema" - }, + "Type", "" ], "source": { @@ -17396,7 +20157,14 @@ ") => boolean; isEqualTo: (other: ", "ByteSizeValue", ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>>; get: () => Readonly<{ kibana: Readonly<{ readonly index: string; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", - "ByteSizeValue" + "ByteSizeValue", + ") => boolean; isLessThan: (other: ", + "ByteSizeValue", + ") => boolean; isEqualTo: (other: ", + "ByteSizeValue", + ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>; }; create: () => ", + "Observable", + "; get: () => T; }" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -17654,7 +20422,32 @@ "path": "src/core/server/deprecations/types.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + } + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17721,7 +20514,56 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" - } + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExporter", + "text": "SavedObjectsExporter" + }, + ", \"exportByTypes\" | \"exportByObjects\">; getImporter: (client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImporter", + "text": "SavedObjectsImporter" + }, + ", \"import\" | \"resolveImportErrors\">; }; elasticsearch: { client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + }, + "; legacy: { client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + ", \"callAsCurrentUser\" | \"callAsInternalUser\">; }; }; uiSettings: { client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + "; }; }" ], "source": { "path": "src/core/server/index.ts", @@ -18278,13 +21120,7 @@ "\nThe current availability level of the service." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatusLevel", - "text": "ServiceStatusLevel" - } + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" ], "source": { "path": "src/core/server/status/types.ts", @@ -18698,7 +21534,9 @@ "path": "src/core/server/status/types.ts", "lineNumber": 226 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -19319,7 +22157,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 70 + "lineNumber": 79 }, "deprecated": false, "initialIsOpen": false @@ -19351,7 +22189,72 @@ "\nRepresents the full ECS schema.\n" ], "signature": [ - "EcsBase & EcsTracing & { ecs: EcsField; agent?: EcsAgent | undefined; as?: EcsAutonomousSystem | undefined; client?: EcsClient | undefined; cloud?: EcsCloud | undefined; container?: EcsContainer | undefined; destination?: EcsDestination | undefined; dns?: EcsDns | undefined; error?: EcsError | undefined; event?: EcsEvent | undefined; file?: EcsFile | undefined; group?: EcsGroup | undefined; host?: EcsHost | undefined; http?: EcsHttp | undefined; log?: EcsLog | undefined; network?: EcsNetwork | undefined; observer?: EcsObserver | undefined; organization?: EcsOrganization | undefined; package?: EcsPackage | undefined; process?: EcsProcess | undefined; registry?: EcsRegistry | undefined; related?: EcsRelated | undefined; rule?: EcsRule | undefined; server?: EcsServer | undefined; service?: EcsService | undefined; source?: EcsSource | undefined; threat?: EcsThreat | undefined; tls?: EcsTls | undefined; url?: EcsUrl | undefined; user?: EcsUser | undefined; user_agent?: EcsUserAgent | undefined; vulnerability?: EcsVulnerability | undefined; }" + "EcsBase", + " & ", + "EcsTracing", + " & { ecs: EcsField; agent?: ", + "EcsAgent", + " | undefined; as?: ", + "EcsAutonomousSystem", + " | undefined; client?: ", + "EcsClient", + " | undefined; cloud?: ", + "EcsCloud", + " | undefined; container?: ", + "EcsContainer", + " | undefined; destination?: ", + "EcsDestination", + " | undefined; dns?: ", + "EcsDns", + " | undefined; error?: ", + "EcsError", + " | undefined; event?: ", + "EcsEvent", + " | undefined; file?: ", + "EcsFile", + " | undefined; group?: ", + "EcsGroup", + " | undefined; host?: ", + "EcsHost", + " | undefined; http?: ", + "EcsHttp", + " | undefined; log?: ", + "EcsLog", + " | undefined; network?: ", + "EcsNetwork", + " | undefined; observer?: ", + "EcsObserver", + " | undefined; organization?: ", + "EcsOrganization", + " | undefined; package?: ", + "EcsPackage", + " | undefined; process?: ", + "EcsProcess", + " | undefined; registry?: ", + "EcsRegistry", + " | undefined; related?: ", + "EcsRelated", + " | undefined; rule?: ", + "EcsRule", + " | undefined; server?: ", + "EcsServer", + " | undefined; service?: ", + "EcsService", + " | undefined; source?: ", + "EcsSource", + " | undefined; threat?: ", + "EcsThreat", + " | undefined; tls?: ", + "EcsTls", + " | undefined; url?: ", + "EcsUrl", + " | undefined; user?: ", + "EcsUser", + " | undefined; user_agent?: ", + "EcsUserAgent", + " | undefined; vulnerability?: ", + "EcsVulnerability", + " | undefined; }" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/index.d.ts", @@ -19368,7 +22271,7 @@ "label": "EcsEventCategory", "description": [], "signature": [ - "\"host\" | \"authentication\" | \"database\" | \"package\" | \"session\" | \"registry\" | \"network\" | \"web\" | \"file\" | \"process\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + "\"host\" | \"database\" | \"package\" | \"session\" | \"registry\" | \"network\" | \"web\" | \"file\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", @@ -19402,7 +22305,7 @@ "label": "EcsEventOutcome", "description": [], "signature": [ - "\"success\" | \"failure\" | \"unknown\"" + "\"unknown\" | \"success\" | \"failure\"" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", @@ -19419,7 +22322,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"connection\" | \"end\" | \"user\" | \"info\" | \"error\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"connection\" | \"user\" | \"end\" | \"error\" | \"info\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", @@ -19438,7 +22341,17 @@ "\nClient used to query the elasticsearch cluster.\n" ], "signature": [ - "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" + "Pick<", + "KibanaClient", + ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", + "TransportRequestParams", + ", options?: ", + "TransportRequestOptions", + " | undefined): ", + "TransportRequestPromise", + "<", + "ApiResponse", + ", unknown>>; }; }" ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", @@ -19457,7 +22370,15 @@ "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" ], "signature": [ - "Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; }" + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" + }, + ", \"password\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"hosts\" | \"username\" | \"requestHeadersWhitelist\" | \"customHeaders\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; }" ], "source": { "path": "src/core/server/elasticsearch/client/client_config.ts", @@ -19476,7 +22397,15 @@ "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" ], "signature": [ - "T extends HandlerFunction ? U : never" + "T extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HandlerFunction", + "text": "HandlerFunction" + }, + " ? U : never" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -19495,7 +22424,7 @@ "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" ], "signature": [ - "(context: T, args: any[]) => any" + "(context: T, ...args: any[]) => any" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -19540,29 +22469,208 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ", response: { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", "Stream", - " | undefined>(options: ", + ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, - ") => ", + ") => ", "KibanaResponse", - "; badRequest: (options?: ", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - } + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; } & ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesServiceToolkit", + "text": "HttpResourcesServiceToolkit" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" ], "source": { "path": "src/core/server/http_resources/types.ts", @@ -19581,7 +22689,13 @@ "\nHTTP Resources response parameters" ], "signature": [ - "HttpResponseOptions" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } ], "source": { "path": "src/core/server/http_resources/types.ts", @@ -19600,7 +22714,7 @@ "\nA function that returns a context value for a specific key of given context type.\n" ], "signature": [ - "(context: Pick>, rest: [request: ", + "(context: Pick>, request: ", { "pluginId": "core", "scope": "server", @@ -19608,7 +22722,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { @@ -19627,7 +22741,162 @@ "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" - } + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => Context[ContextName] | Promise" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -19648,7 +22917,15 @@ "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}.\n" ], "signature": [ - "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + "{ callAsInternalUser: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyAPICaller", + "text": "LegacyAPICaller" + }, + "; asScoped: (request?: ", { "pluginId": "core", "scope": "server", @@ -19672,7 +22949,15 @@ "section": "def-server.FakeRequest", "text": "FakeRequest" }, - " | undefined) => Pick; }" + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + ", \"callAsCurrentUser\" | \"callAsInternalUser\">; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", @@ -19892,7 +23177,15 @@ "\nRepresents an Elasticsearch cluster API client created by a plugin.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}." ], "signature": [ - "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + "{ close: () => void; callAsInternalUser: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyAPICaller", + "text": "LegacyAPICaller" + }, + "; asScoped: (request?: ", { "pluginId": "core", "scope": "server", @@ -19916,7 +23209,15 @@ "section": "def-server.FakeRequest", "text": "FakeRequest" }, - " | undefined) => Pick; }" + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + ", \"callAsCurrentUser\" | \"callAsInternalUser\">; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", @@ -20115,7 +23416,23 @@ "\nServes the same purpose as \"normal\" `ClusterClient` but exposes additional\n`callAsCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `callAsInternalUser` does) to request Elasticsearch API, but rather\npasses HTTP headers extracted from the current user request to the API.\n\nSee {@link LegacyScopedClusterClient}.\n" ], "signature": [ - "{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; }" + "{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined) => Promise; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", @@ -20201,20 +23518,6 @@ "lineNumber": 73 } }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts", - "lineNumber": 1 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts", - "lineNumber": 30 - } - }, { "plugin": "globalSearch", "link": { @@ -20240,28 +23543,14 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", - "lineNumber": 27 + "lineNumber": 26 } }, { "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", - "lineNumber": 33 - } - }, - { - "plugin": "infra", - "link": { - "path": "x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts", - "lineNumber": 1 - } - }, - { - "plugin": "infra", - "link": { - "path": "x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts", - "lineNumber": 58 + "lineNumber": 32 } } ], @@ -20278,7 +23567,17 @@ "label": "LegacyElasticsearchClientConfig", "description": [], "signature": [ - "Pick & Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ConfigOptions['requestTimeout']; sniffInterval?: ElasticsearchConfig['sniffInterval'] | ConfigOptions['sniffInterval']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; }" + "Pick<", + "ConfigOptions", + ", \"plugins\" | \"log\" | \"keepAlive\"> & Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" + }, + ", \"password\" | \"sniffOnStart\" | \"sniffOnConnectionFault\" | \"hosts\" | \"username\" | \"requestHeadersWhitelist\" | \"customHeaders\" | \"apiVersion\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; sniffInterval?: number | false | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/elasticsearch_client_config.ts", @@ -20317,7 +23616,73 @@ "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" ], "signature": [ - "Pick & EcsTracing & { agent?: EcsAgent | undefined; as?: EcsAutonomousSystem | undefined; client?: EcsClient | undefined; cloud?: EcsCloud | undefined; container?: EcsContainer | undefined; destination?: EcsDestination | undefined; dns?: EcsDns | undefined; error?: EcsError | undefined; event?: EcsEvent | undefined; file?: EcsFile | undefined; group?: EcsGroup | undefined; host?: EcsHost | undefined; http?: EcsHttp | undefined; log?: Pick | undefined; network?: EcsNetwork | undefined; observer?: EcsObserver | undefined; organization?: EcsOrganization | undefined; package?: EcsPackage | undefined; process?: EcsProcess | undefined; registry?: EcsRegistry | undefined; related?: EcsRelated | undefined; rule?: EcsRule | undefined; server?: EcsServer | undefined; service?: EcsService | undefined; source?: EcsSource | undefined; threat?: EcsThreat | undefined; tls?: EcsTls | undefined; url?: EcsUrl | undefined; user?: EcsUser | undefined; user_agent?: EcsUserAgent | undefined; vulnerability?: EcsVulnerability | undefined; }" + "Pick<", + "EcsBase", + ", \"labels\" | \"tags\"> & ", + "EcsTracing", + " & { agent?: ", + "EcsAgent", + " | undefined; as?: ", + "EcsAutonomousSystem", + " | undefined; client?: ", + "EcsClient", + " | undefined; cloud?: ", + "EcsCloud", + " | undefined; container?: ", + "EcsContainer", + " | undefined; destination?: ", + "EcsDestination", + " | undefined; dns?: ", + "EcsDns", + " | undefined; error?: ", + "EcsError", + " | undefined; event?: ", + "EcsEvent", + " | undefined; file?: ", + "EcsFile", + " | undefined; group?: ", + "EcsGroup", + " | undefined; host?: ", + "EcsHost", + " | undefined; http?: ", + "EcsHttp", + " | undefined; log?: Pick<", + "EcsLog", + ", \"origin\" | \"original\" | \"file\" | \"syslog\"> | undefined; network?: ", + "EcsNetwork", + " | undefined; observer?: ", + "EcsObserver", + " | undefined; organization?: ", + "EcsOrganization", + " | undefined; package?: ", + "EcsPackage", + " | undefined; process?: ", + "EcsProcess", + " | undefined; registry?: ", + "EcsRegistry", + " | undefined; related?: ", + "EcsRelated", + " | undefined; rule?: ", + "EcsRule", + " | undefined; server?: ", + "EcsServer", + " | undefined; service?: ", + "EcsService", + " | undefined; source?: ", + "EcsSource", + " | undefined; threat?: ", + "EcsThreat", + " | undefined; tls?: ", + "EcsTls", + " | undefined; url?: ", + "EcsUrl", + " | undefined; user?: ", + "EcsUser", + " | undefined; user_agent?: ", + "EcsUserAgent", + " | undefined; vulnerability?: ", + "EcsVulnerability", + " | undefined; }" ], "source": { "path": "node_modules/@kbn/logging/target/log_meta.d.ts", @@ -20336,7 +23701,15 @@ "\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n" ], "signature": [ - "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends any[] | undefined ? boolean : T[Key] extends object | undefined ? boolean | MakeUsageFromSchema : boolean) | undefined; }" + "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends any[] | undefined ? boolean : T[Key] extends object | undefined ? boolean | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MakeUsageFromSchema", + "text": "MakeUsageFromSchema" + }, + " : boolean) | undefined; }" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -20355,7 +23728,13 @@ "\n{@inheritdoc MetricsServiceSetup}\n" ], "signature": [ - "MetricsServiceSetup" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } ], "source": { "path": "src/core/server/metrics/types.ts", @@ -20416,7 +23795,8 @@ "\nDedicated type for plugin configuration schema.\n" ], "signature": [ - "Type" + "Type", + "" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -20514,7 +23894,11 @@ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" + "{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: ", + "UiCounterMetricType", + "; name: string; } | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + "DeprecationSettings", + " | undefined; }" ], "source": { "path": "src/core/types/ui_settings.ts", @@ -20533,11 +23917,11 @@ "\nType definition for a Saved Object attribute value\n" ], "signature": [ - "undefined | null | string | number | false | true | ", + "string | number | boolean | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", - "[]" + "[] | null | undefined" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -20556,8 +23940,9 @@ "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" ], "signature": [ - "undefined | null | string | number | false | true | ", - "SavedObjectAttributes" + "string | number | boolean | ", + "SavedObjectAttributes", + " | null | undefined" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -20634,16 +24019,13 @@ "label": "SharedGlobalConfig", "description": [], "signature": [ - "{ readonly kibana: Readonly<{ readonly index: string; }>; readonly elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => ", - "Duration", - "; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: ", - "argThresholdOpts", - " | undefined): string; (argThresholds?: ", - "argThresholdOpts", - " | undefined): string; }; abs: () => ", - "Duration", - "; as: (units: ", - "unitOfTime" + "{ readonly kibana: Readonly<{ readonly index: string; }>; readonly elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; readonly path: Readonly<{ readonly data: string; }>; readonly savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", + "ByteSizeValue", + ") => boolean; isLessThan: (other: ", + "ByteSizeValue", + ") => boolean; isEqualTo: (other: ", + "ByteSizeValue", + ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -20710,7 +24092,7 @@ "\nThe current \"level\" of availability of a service.\n" ], "signature": [ - "Readonly<{ available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }>" + "{ readonly available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; readonly degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; readonly unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; readonly critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }" ], "source": { "path": "src/core/server/status/types.ts", diff --git a/api_docs/core_application.json b/api_docs/core_application.json index 51f24e0dccfb00..c8a036fda242df 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -115,7 +115,9 @@ "type": "string", "tags": [], "label": "basePath", - "description": [], + "description": [ + "the URL path scope for the sub history" + ], "signature": [ "string" ], @@ -173,7 +175,7 @@ "\nThe last action dispatched on the history stack." ], "signature": [ - "Action" + "\"PUSH\" | \"POP\" | \"REPLACE\"" ], "source": { "path": "src/core/public/application/scoped_history.ts", @@ -207,7 +209,9 @@ "type": "CompoundType", "tags": [], "label": "pathOrLocation", - "description": [], + "description": [ + "a string or location descriptor" + ], "signature": [ "string | ", "LocationDescriptorObject", @@ -266,7 +270,9 @@ "type": "CompoundType", "tags": [], "label": "pathOrLocation", - "description": [], + "description": [ + "a string or location descriptor" + ], "signature": [ "string | ", "LocationDescriptorObject", @@ -323,7 +329,9 @@ "type": "number", "tags": [], "label": "n", - "description": [], + "description": [ + "number of positions in the stack to go. Negative numbers indicate number of entries backward, positive\nnumbers for forwards. If passed 0, the current location will be reloaded. If `n` exceeds the number of\nentries available, this is a no-op." + ], "signature": [ "number" ], @@ -449,7 +457,9 @@ "type": "Function", "tags": [], "label": "listener", - "description": [], + "description": [ + "a function that receives location updates." + ], "signature": [ "(location: ", "Location", @@ -834,20 +844,63 @@ "\nA mount function called when the user navigates to this app's route." ], "signature": [ + "(params: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppMount", - "text": "AppMount" + "section": "def-public.AppMountParameters", + "text": "AppMountParameters" }, - "" + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUnmount", + "text": "AppUnmount" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUnmount", + "text": "AppUnmount" + }, + ">" ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 187 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMountParameters", + "text": "AppMountParameters" + }, + "" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 326 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -1209,7 +1262,7 @@ "\nGets the read-only capabilities." ], "signature": [ - "Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>" + "{ readonly [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; readonly navLinks: Readonly<{ [x: string]: boolean; }>; readonly management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; readonly catalogue: Readonly<{ [x: string]: boolean; }>; }" ], "source": { "path": "src/core/public/application/types.ts", @@ -1615,6 +1668,13 @@ "path": "x-pack/plugins/fleet/target/types/public/applications/fleet/index.d.ts", "lineNumber": 11 } + }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/target/types/public/applications/integrations/index.d.ts", + "lineNumber": 11 + } } ] }, @@ -1649,15 +1709,15 @@ { "plugin": "dashboard", "link": { - "path": "src/plugins/dashboard/public/application/types.ts", - "lineNumber": 82 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 194 } }, { "plugin": "dashboard", "link": { "path": "src/plugins/dashboard/public/application/dashboard_router.tsx", - "lineNumber": 56 + "lineNumber": 57 } }, { @@ -1678,7 +1738,7 @@ "plugin": "maps", "link": { "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx", - "lineNumber": 59 + "lineNumber": 67 } }, { @@ -1783,9 +1843,37 @@ "plugin": "maps", "link": { "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts", - "lineNumber": 13 + "lineNumber": 17 } } + ], + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(factory: ", + "AppLeaveActionFactory", + ", nextAppId?: string | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveAction", + "text": "AppLeaveAction" + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 471 + }, + "deprecated": false + } ] }, { @@ -1812,7 +1900,33 @@ "path": "src/core/public/application/types.ts", "lineNumber": 502 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.menuMount", + "type": "Function", + "tags": [], + "label": "menuMount", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 502 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -1969,7 +2083,7 @@ "\nInput type for registering secondary in-app locations for an application.\n\nDeep links must include at least one of `path` or `deepLinks`. A deep link that does not have a `path`\nrepresents a topological level in the application's hierarchy, but does not have a destination URL that is\nuser-accessible." ], "signature": [ - "{ id: string; title: string; keywords?: string[] | undefined; navLinkStatus?: ", + "({ id: string; title: string; keywords?: string[] | undefined; navLinkStatus?: ", { "pluginId": "core", "scope": "public", @@ -1985,7 +2099,7 @@ "section": "def-public.AppDeepLink", "text": "AppDeepLink" }, - "[] | undefined; } | { id: string; title: string; keywords?: string[] | undefined; navLinkStatus?: ", + "[] | undefined; }) | ({ id: string; title: string; keywords?: string[] | undefined; navLinkStatus?: ", { "pluginId": "core", "scope": "public", @@ -2001,7 +2115,7 @@ "section": "def-public.AppDeepLink", "text": "AppDeepLink" }, - "[]; }" + "[]; })" ], "source": { "path": "src/core/public/application/types.ts", @@ -2057,7 +2171,7 @@ "signature": [ "(factory: ", "AppLeaveActionFactory", - ", nextAppId: string | undefined) => ", + ", nextAppId?: string | undefined) => ", { "pluginId": "core", "scope": "public", @@ -2210,7 +2324,31 @@ "\nDefines the list of fields that can be updated via an {@link AppUpdater}." ], "signature": [ - "{ status?: AppStatus | undefined; deepLinks?: AppDeepLink[] | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" + "{ status?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppStatus", + "text": "AppStatus" + }, + " | undefined; deepLinks?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppDeepLink", + "text": "AppDeepLink" + }, + "[] | undefined; navLinkStatus?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppNavLinkStatus", + "text": "AppNavLinkStatus" + }, + " | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" ], "source": { "path": "src/core/public/application/types.ts", @@ -2264,7 +2402,31 @@ "\nPublic information about a registered app's {@link AppDeepLink | deepLinks}\n" ], "signature": [ - "Pick & { deepLinks: PublicAppDeepLinkInfo[]; keywords: string[]; navLinkStatus: AppNavLinkStatus; }" + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppDeepLink", + "text": "AppDeepLink" + }, + ", \"title\" | \"id\" | \"path\"> & { deepLinks: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.PublicAppDeepLinkInfo", + "text": "PublicAppDeepLinkInfo" + }, + "[]; keywords: string[]; navLinkStatus: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppNavLinkStatus", + "text": "AppNavLinkStatus" + }, + "; }" ], "source": { "path": "src/core/public/application/types.ts", @@ -2283,7 +2445,39 @@ "\nPublic information about a registered {@link App | application}\n" ], "signature": [ - "Pick, \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; keywords: string[]; deepLinks: PublicAppDeepLinkInfo[]; }" + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + ", \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppStatus", + "text": "AppStatus" + }, + "; navLinkStatus: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppNavLinkStatus", + "text": "AppNavLinkStatus" + }, + "; appRoute: string; keywords: string[]; deepLinks: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.PublicAppDeepLinkInfo", + "text": "PublicAppDeepLinkInfo" + }, + "[]; }" ], "source": { "path": "src/core/public/application/types.ts", diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index 997507c911665a..fae65ff62c9714 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -284,7 +284,24 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "PropsForButton" + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet", + "<", + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForAnchor", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { href?: string | undefined; onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.AnchorHTMLAttributes), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -335,7 +352,7 @@ "\nContent of the button (in lieu of `children`)" ], "signature": [ - "React.ReactNode" + "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -368,7 +385,24 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "PropsForButton" + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet", + "<", + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForAnchor", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { href?: string | undefined; onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.AnchorHTMLAttributes), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -434,7 +468,24 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "PropsForButton" + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet", + "<", + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForAnchor", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { href?: string | undefined; onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.AnchorHTMLAttributes), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -500,7 +551,24 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "PropsForButton" + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet", + "<", + "PropsForButton", + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForAnchor", + "<", + "CommonEuiButtonEmptyProps", + ", {}>> & ", + "CommonEuiButtonEmptyProps", + " & { href?: string | undefined; onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.AnchorHTMLAttributes), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -602,20 +670,39 @@ "label": "mount", "description": [], "signature": [ + "(element: HTMLElement) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } ], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 17 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.element", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "src/core/public/types.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2372,20 +2459,39 @@ "label": "content", "description": [], "signature": [ + "(element: HTMLDivElement) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 41 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.element", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "src/core/public/types.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2402,11 +2508,7 @@ "description": [], "signature": [ "CommonProps", - " & { text: ", - "ReactNode", - "; href?: string | undefined; onClick?: ((event: ", - "MouseEvent", - ") => void) | undefined; truncate?: boolean | undefined; }" + " & { text: React.ReactNode; href?: string | undefined; onClick?: ((event: React.MouseEvent) => void) | undefined; truncate?: boolean | undefined; }" ], "source": { "path": "src/core/public/chrome/types.ts", diff --git a/api_docs/core_http.json b/api_docs/core_http.json index fedb0a0e9cd65f..7bedeac3baf793 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -779,15 +779,23 @@ "label": "fetchOptions", "description": [], "signature": [ - "Readonly<", + "{ readonly path: string; readonly query?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" + "section": "def-public.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHeadersInit", + "text": "HttpHeadersInit" }, - ">" + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly body?: string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined; readonly cache?: \"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined; readonly credentials?: \"include\" | \"omit\" | \"same-origin\" | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: \"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined; readonly redirect?: \"error\" | \"follow\" | \"manual\" | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: \"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" ], "source": { "path": "src/core/public/http/types.ts", @@ -853,7 +861,7 @@ "label": "request", "description": [], "signature": [ - "Readonly" + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly isHistoryNavigation: boolean; readonly isReloadNavigation: boolean; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" ], "source": { "path": "src/core/public/http/types.ts", @@ -912,7 +920,7 @@ "\nA BodyInit object or null to set request's body." ], "signature": [ - "string | ArrayBuffer | Blob | URLSearchParams | ArrayBufferView | FormData | ReadableStream | null | undefined" + "string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined" ], "source": { "path": "src/core/public/http/types.ts", @@ -1179,15 +1187,23 @@ "The original {@link HttpFetchOptionsWithPath} used to send this request." ], "signature": [ - "Readonly<", + "{ readonly path: string; readonly query?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" + "section": "def-public.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHeadersInit", + "text": "HttpHeadersInit" }, - ">" + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly body?: string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined; readonly cache?: \"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined; readonly credentials?: \"include\" | \"omit\" | \"same-origin\" | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: \"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined; readonly redirect?: \"error\" | \"follow\" | \"manual\" | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: \"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" ], "source": { "path": "src/core/public/http/types.ts", @@ -1205,7 +1221,7 @@ "Raw request sent to Kibana server." ], "signature": [ - "Readonly" + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly isHistoryNavigation: boolean; readonly isReloadNavigation: boolean; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" ], "source": { "path": "src/core/public/http/types.ts", @@ -1776,7 +1792,9 @@ "path": "src/core/public/http/types.ts", "lineNumber": 78 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -1794,7 +1812,23 @@ "path": "src/core/public/http/types.ts", "lineNumber": 83 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 83 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -1812,7 +1846,23 @@ "path": "src/core/public/http/types.ts", "lineNumber": 88 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 88 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -2176,7 +2226,13 @@ "\nSee {@link HttpSetup}" ], "signature": [ - "HttpSetup" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } ], "source": { "path": "src/core/public/http/types.ts", @@ -2555,9 +2611,9 @@ "matched route details" ], "signature": [ - "Readonly<{ path: string; method: ", + "{ readonly path: string; readonly method: ", "RecursiveReadonly", - "; options: ", + "; readonly options: ", "RecursiveReadonly", "<", { @@ -2567,7 +2623,7 @@ "section": "def-server.KibanaRequestRouteOptions", "text": "KibanaRequestRouteOptions" }, - ">; }>" + ">; }" ], "source": { "path": "src/core/server/http/router/request.ts", @@ -2585,13 +2641,7 @@ "\nReadonly copy of incoming request headers." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Headers", - "text": "Headers" - } + "{ accept?: 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; allow?: 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; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: 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; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: 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; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "source": { "path": "src/core/server/http/router/request.ts", @@ -3192,7 +3242,33 @@ "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 123 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.data", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 123 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -3217,7 +3293,9 @@ "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 129 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -3242,7 +3320,26 @@ "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 134 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "({ location: string; } & Record<\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)" + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 134 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -3419,19 +3516,70 @@ "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" ], "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.GetAuthState", - "text": "GetAuthState" - } + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => { status: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 36 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -3443,19 +3591,62 @@ "\nReturns authentication status for a request.\n{@link IsAuthenticated}" ], "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.IsAuthenticated", - "text": "IsAuthenticated" - } + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => boolean" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 56 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 44 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -3485,13 +3676,9 @@ "HTTP message to send to the client" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponsePayload", - "text": "HttpResponsePayload" - } + "string | Record | Buffer | ", + "Stream", + " | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", @@ -3666,7 +3853,33 @@ "path": "src/core/server/http/types.ts", "lineNumber": 136 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.cookieOptions", + "type": "Object", + "tags": [], + "label": "cookieOptions", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 137 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -3692,68 +3905,183 @@ "path": "src/core/server/http/types.ts", "lineNumber": 150 }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreAuth", - "type": "Function", - "tags": [], - "label": "registerOnPreAuth", - "description": [ - "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthHandler", - "text": "OnPreAuthHandler" - }, - ") => void" - ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 162 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerAuth", - "type": "Function", - "tags": [], - "label": "registerAuth", - "description": [ - "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" - ], - "signature": [ - "(handler: ", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthenticationHandler", - "text": "AuthenticationHandler" - }, - ") => void" - ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 174 - }, - "deprecated": false + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + }, + ") => Next | RewriteUrl | ", + "KibanaResponse", + " | Promise>" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 150 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPostAuth", + "id": "def-server.HttpServiceSetup.registerOnPreAuth", "type": "Function", "tags": [], - "label": "registerOnPostAuth", + "label": "registerOnPreAuth", "description": [ - "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" + "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" ], "signature": [ "(handler: ", @@ -3761,25 +4089,192 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthHandler", - "text": "OnPostAuthHandler" + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 186 + "lineNumber": 162 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + }, + ") => ", + "KibanaResponse", + " | Next | Promise<", + "KibanaResponse", + " | Next>" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 162 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreResponse", + "id": "def-server.HttpServiceSetup.registerAuth", "type": "Function", "tags": [], - "label": "registerOnPreResponse", + "label": "registerAuth", "description": [ - "\nTo define custom logic to perform for the server response.\n" + "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" ], "signature": [ "(handler: ", @@ -3787,290 +4282,5282 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseHandler", - "text": "OnPreResponseHandler" + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 198 + "lineNumber": 174 }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "Pick<", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.BasePath", - "text": "BasePath" - }, - ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" - ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 204 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.auth", - "type": "Object", - "tags": [ - "deprecated" + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Authenticated", + "text": "Authenticated" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Authenticated", + "text": "Authenticated" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" + }, + ">" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 174 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPostAuth", + "type": "Function", + "tags": [], + "label": "registerOnPostAuth", + "description": [ + "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + }, + ") => void" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 186 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + }, + ") => ", + "KibanaResponse", + " | Next | Promise<", + "KibanaResponse", + " | Next>" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 186 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreResponse", + "type": "Function", + "tags": [], + "label": "registerOnPreResponse", + "description": [ + "\nTo define custom logic to perform for the server response.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + }, + ") => void" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 198 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", preResponse: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + }, + ", toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + }, + ") => Render | Next | Promise" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 198 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "{ remove: (path: string) => string; get: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => string; set: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 204 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.auth", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 212 + }, + "deprecated": true, + "references": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", + "tags": [], + "label": "csp", + "description": [ + "\nThe CSP config used for Kibana." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICspConfig", + "text": "ICspConfig" + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 217 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createRouter", + "type": "Function", + "tags": [], + "label": "createRouter", + "description": [ + "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" + ], + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 234 + }, + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "type": "Function", + "tags": [], + "label": "registerRouteHandlerContext", + "description": [ + "\nRegister a context provider for a route handler." + ], + "signature": [ + "(contextName: ContextName, provider: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 266 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.contextName", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [], + "signature": [ + "ContextName" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 270 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.provider", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + "(context: Pick>, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => Context[ContextName] | Promise" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 271 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 277 + }, + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart", + "type": "Interface", + "tags": [], + "label": "HttpServiceStart", + "description": [], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 310 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "{ remove: (path: string) => string; get: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => string; set: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 315 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 321 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 326 + }, + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse", + "type": "Interface", + "tags": [], + "label": "IKibanaResponse", + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 33 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.status", + "type": "number", + "tags": [], + "label": "status", + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 34 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.payload", + "type": "Uncategorized", + "tags": [], + "label": "payload", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 35 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 36 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket", + "type": "Interface", + "tags": [], + "label": "IKibanaSocket", + "description": [ + "\nA tiny abstraction for TCP socket." + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 17 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "DetailedPeerCertificate", + " | ", + "PeerCertificate", + " | null; }" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 18 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "true" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 18 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "DetailedPeerCertificate", + " | ", + "PeerCertificate", + " | null; }" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 19 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "false" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 19 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [ + "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." + ], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "DetailedPeerCertificate", + " | ", + "PeerCertificate", + " | null; }" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 29 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "CompoundType", + "tags": [], + "label": "detailed", + "description": [ + "- If true; the full chain with issuer property will be returned." + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 29 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "An object representing the peer's certificate." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getProtocol", + "type": "Function", + "tags": [], + "label": "getProtocol", + "description": [ + "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." + ], + "signature": [ + "() => string | null" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 36 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate", + "type": "Function", + "tags": [], + "label": "renegotiate", + "description": [ + "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." + ], + "signature": [ + "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.options.rejectUnauthorized", + "type": "CompoundType", + "tags": [], + "label": "rejectUnauthorized", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.options.requestCert", + "type": "CompoundType", + "tags": [], + "label": "requestCert", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43 + }, + "deprecated": false + } + ] + } + ], + "returnComment": [ + "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.authorized", + "type": "CompoundType", + "tags": [], + "label": "authorized", + "description": [ + "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 49 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.authorizationError", + "type": "Object", + "tags": [], + "label": "authorizationError", + "description": [ + "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." + ], + "signature": [ + "Error | undefined" + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 55 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter", + "type": "Interface", + "tags": [], + "label": "IRouter", + "description": [ + "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 62 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.routerPath", + "type": "string", + "tags": [], + "label": "routerPath", + "description": [ + "\nResulted path" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 66 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRegister a route handler for `GET` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => void" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 73 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "\nRegister a route handler for `POST` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => void" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 80 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "\nRegister a route handler for `PUT` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => void" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 87 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch", + "type": "Function", + "tags": [], + "label": "patch", + "description": [ + "\nRegister a route handler for `PATCH` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => void" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 94 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nRegister a route handler for `DELETE` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => void" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 101 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 52 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors", + "type": "Function", + "tags": [], + "label": "handleLegacyErrors", + "description": [ + "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." + ], + "signature": [ + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; } = { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 107 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 385 + }, + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents", + "type": "Interface", + "tags": [], + "label": "KibanaRequestEvents", + "description": [ + "\nRequest events." + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 62 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents.aborted$", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "\nObservable that emits once if and when the request has been aborted." + ], + "signature": [ + "Observable", + "" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 66 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents.completed$", + "type": "Object", + "tags": [], + "label": "completed$", + "description": [ + "\nObservable that emits once if and when the request has been completely handled.\n" + ], + "signature": [ + "Observable", + "" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 76 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute", + "type": "Interface", + "tags": [], + "label": "KibanaRequestRoute", + "description": [ + "\nRequest specific route information exposed to a handler." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequestRoute", + "text": "KibanaRequestRoute" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 52 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 53 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.method", + "type": "Uncategorized", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "Method" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 54 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.options", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Method extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ">" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 55 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.LegacyRequest", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "LegacyRequest", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " extends ", + "Request" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 84 + }, + "deprecated": true, + "references": [ + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/saved_objects/index.ts", + "lineNumber": 8 + } + }, + { + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/saved_objects/index.ts", + "lineNumber": 34 + } + } + ], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPostAuthToolkit", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 42 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => Next" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 44 + }, + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreAuthToolkit", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 42 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => Next" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 44 + }, + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", + "tags": [], + "label": "OnPreResponseExtensions", + "description": [ + "\nAdditional data to extend a response." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 56 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseExtensions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + "Record<\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 58 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "tags": [], + "label": "OnPreResponseInfo", + "description": [ + "\nResponse status code." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 65 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseInfo.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 66 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseRender", + "description": [ + "\nAdditional data to extend a response when rendering a new body" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 45 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + "Record<\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [ + "the body to use in the response" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreResponseToolkit", + "description": [ + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 88 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.render", + "type": "Function", + "tags": [], + "label": "render", + "description": [ + "To override the response with a different body" + ], + "signature": [ + "(responseRender: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + }, + ") => OnPreResponseResult" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 90 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.responseRender", + "type": "Object", + "tags": [], + "label": "responseRender", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 90 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "(responseExtensions?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined) => OnPreResponseResult" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 92 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.responseExtensions", + "type": "Object", + "tags": [], + "label": "responseExtensions", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 92 + }, + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingToolkit", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 55 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => OnPreRoutingResult" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 57 + }, + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl", + "type": "Function", + "tags": [], + "label": "rewriteUrl", + "description": [ + "Rewrite requested resources url before is was authenticated and routed to a handler" + ], + "signature": [ + "(url: string) => OnPreRoutingResult" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 59 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 59 + }, + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig", + "type": "Interface", + "tags": [], + "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 157 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" ], - "label": "auth", + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 171 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", + "tags": [], + "label": "validate", "description": [ - "\nAuth status.\nSee {@link HttpAuth}\n" + "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" ], "signature": [ + "false | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpAuth", - "text": "HttpAuth" - } + "section": "def-server.RouteValidatorFullConfig", + "text": "RouteValidatorFullConfig" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 229 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 234 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + "" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 106 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "tags": [], + "label": "authRequired", + "description": [ + "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + ], + "signature": [ + "boolean | \"optional\" | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 116 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "tags": [], + "label": "xsrfRequired", + "description": [ + "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" + ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 125 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 130 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "signature": [ + "(Method extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " ? undefined : ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptionsBody", + "text": "RouteConfigOptionsBody" + }, + ") | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 135 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", + "tags": [], + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "signature": [ + "{ payload?: (Method extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 140 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptionsBody", + "description": [ + "\nAdditional body options for a route" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 55 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", + "tags": [], + "label": "accepts", + "description": [ + "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" + ], + "signature": [ + "string | string[] | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteContentType", + "text": "RouteContentType" + }, + "[] | undefined" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "type": "number", + "tags": [], + "label": "maxBytes", + "description": [ + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], + "signature": [ + "number | undefined" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 212 + "path": "src/core/server/http/router/route.ts", + "lineNumber": 75 }, - "deprecated": true, - "references": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.csp", - "type": "Object", + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", "tags": [], - "label": "csp", + "label": "output", "description": [ - "\nThe CSP config used for Kibana." + "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICspConfig", - "text": "ICspConfig" - } + "\"data\" | \"stream\" | undefined" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 217 + "path": "src/core/server/http/router/route.ts", + "lineNumber": 88 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createRouter", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", "tags": [], - "label": "createRouter", + "label": "parse", "description": [ - "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" + "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." ], "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" + "boolean | \"gunzip\" | undefined" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 234 + "path": "src/core/server/http/router/route.ts", + "lineNumber": 99 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory", + "type": "Interface", + "tags": [], + "label": "RouteValidationResultFactory", + "description": [ + "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 20 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "id": "def-server.RouteValidationResultFactory.ok", "type": "Function", "tags": [], - "label": "registerRouteHandlerContext", - "description": [ - "\nRegister a context provider for a route handler." - ], + "label": "ok", + "description": [], "signature": [ - "(contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } + "(value: T) => { value: T; }" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 266 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 21 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.value", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 21 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.getServerInfo", + "id": "def-server.RouteValidationResultFactory.badRequest", "type": "Function", "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running http server." - ], + "label": "badRequest", + "description": [], "signature": [ - "() => ", + "(error: string | Error, path?: string[] | undefined) => { error: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 277 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 22 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 22 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.path", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpServiceStart", + "id": "def-server.RouteValidatorConfig", "type": "Interface", "tags": [], - "label": "HttpServiceStart", - "description": [], + "label": "RouteValidatorConfig", + "description": [ + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" + }, + "" + ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 310 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 87 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpServiceStart.basePath", - "type": "Object", + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", "tags": [], - "label": "basePath", + "label": "params", "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + "\nValidation logic for the URL params" ], "signature": [ - "Pick<", + "ObjectType", + " | ", + "Type", + "

| ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.BasePath", - "text": "BasePath" + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" }, - ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" + "

| undefined" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 315 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 92 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpServiceStart.auth", - "type": "Object", + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", "tags": [], - "label": "auth", + "label": "query", "description": [ - "\nAuth status.\nSee {@link HttpAuth}" + "\nValidation logic for the Query params" ], "signature": [ + "ObjectType", + " | ", + "Type", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpAuth", - "text": "HttpAuth" - } + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + " | undefined" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 321 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 97 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpServiceStart.getServerInfo", - "type": "Function", + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", "tags": [], - "label": "getServerInfo", + "label": "body", "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running http server." + "\nValidation logic for the body payload" ], "signature": [ - "() => ", + "ObjectType", + " | ", + "Type", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + " | undefined" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 326 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 102 }, "deprecated": false } @@ -4079,77 +9566,85 @@ }, { "parentPluginId": "core", - "id": "def-server.IKibanaResponse", + "id": "def-server.RouteValidatorOptions", "type": "Interface", "tags": [], - "label": "IKibanaResponse", + "label": "RouteValidatorOptions", "description": [ - "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 33 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 110 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IKibanaResponse.status", - "type": "number", + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", "tags": [], - "label": "status", - "description": [], + "label": "unsafe", + "description": [ + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" + ], + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 34 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 115 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", + "tags": [], + "label": "SessionCookieValidationResult", + "description": [ + "\nReturn type from a function to validate cookie contents." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 48 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.IKibanaResponse.payload", - "type": "Uncategorized", + "id": "def-server.SessionCookieValidationResult.isValid", + "type": "boolean", "tags": [], - "label": "payload", - "description": [], - "signature": [ - "T | undefined" + "label": "isValid", + "description": [ + "\nWhether the cookie is valid or not." ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 35 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IKibanaResponse.options", - "type": "Object", + "id": "def-server.SessionCookieValidationResult.path", + "type": "string", "tags": [], - "label": "options", - "description": [], + "label": "path", + "description": [ + "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } + "string | undefined" ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 36 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 56 }, "deprecated": false } @@ -4158,100 +9653,82 @@ }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket", + "id": "def-server.SessionStorage", "type": "Interface", "tags": [], - "label": "IKibanaSocket", + "label": "SessionStorage", "description": [ - "\nA tiny abstraction for TCP socket." + "\nProvides an interface to store and retrieve data across requests." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 17 + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 14 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", + "id": "def-server.SessionStorage.get", "type": "Function", "tags": [], - "label": "getPeerCertificate", - "description": [], + "label": "get", + "description": [ + "\nRetrieves session value from the session storage." + ], "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "DetailedPeerCertificate", - " | ", - "PeerCertificate", - " | null; }" + "() => Promise" ], "source": { - "path": "src/core/server/http/router/socket.ts", + "path": "src/core/server/http/session_storage.ts", "lineNumber": 18 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "boolean", - "tags": [], - "label": "detailed", - "description": [], - "signature": [ - "true" - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 18 - }, - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", + "id": "def-server.SessionStorage.set", "type": "Function", "tags": [], - "label": "getPeerCertificate", - "description": [], + "label": "set", + "description": [ + "\nPuts current session value into the session storage." + ], "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "DetailedPeerCertificate", - " | ", - "PeerCertificate", - " | null; }" + "(sessionValue: T) => void" ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 19 + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 23 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "boolean", + "id": "def-server.SessionStorage.set.$1", + "type": "Uncategorized", "tags": [], - "label": "detailed", - "description": [], + "label": "sessionValue", + "description": [ + "- value to put" + ], "signature": [ - "false" + "T" ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 19 + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 23 }, "deprecated": false, "isRequired": true @@ -4261,177 +9738,156 @@ }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", + "id": "def-server.SessionStorage.clear", + "type": "Function", + "tags": [], + "label": "clear", + "description": [ + "\nClears current session." + ], + "signature": [ + "() => void" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", + "tags": [], + "label": "SessionStorageCookieOptions", + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 20 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.name", + "type": "string", "tags": [], - "label": "getPeerCertificate", + "label": "name", "description": [ - "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." - ], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "DetailedPeerCertificate", - " | ", - "PeerCertificate", - " | null; }" + "\nName of the session cookie." ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 29 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 24 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "CompoundType", - "tags": [], - "label": "detailed", - "description": [ - "- If true; the full chain with issuer property will be returned." - ], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 29 - }, - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "An object representing the peer's certificate." - ] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getProtocol", - "type": "Function", + "id": "def-server.SessionStorageCookieOptions.encryptionKey", + "type": "string", "tags": [], - "label": "getProtocol", + "label": "encryptionKey", "description": [ - "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." - ], - "signature": [ - "() => string | null" + "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 36 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 28 }, - "deprecated": false, - "children": [], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate", + "id": "def-server.SessionStorageCookieOptions.validate", "type": "Function", "tags": [], - "label": "renegotiate", + "label": "validate", "description": [ - "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." + "\nFunction called to validate a cookie's decrypted value." ], "signature": [ - "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + "(sessionValue: T | T[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionCookieValidationResult", + "text": "SessionCookieValidationResult" + } ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 43 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 32 }, "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.options", - "type": "Object", + "id": "def-server.sessionValue", + "type": "CompoundType", "tags": [], - "label": "options", + "label": "sessionValue", "description": [], + "signature": [ + "T | T[]" + ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 43 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 32 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.options.rejectUnauthorized", - "type": "CompoundType", - "tags": [], - "label": "rejectUnauthorized", - "description": [], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 43 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.options.requestCert", - "type": "CompoundType", - "tags": [], - "label": "requestCert", - "description": [], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 43 - }, - "deprecated": false - } - ] + "deprecated": false } - ], - "returnComment": [ - "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." ] }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.authorized", - "type": "CompoundType", + "id": "def-server.SessionStorageCookieOptions.isSecure", + "type": "boolean", "tags": [], - "label": "authorized", + "label": "isSecure", "description": [ - "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." - ], - "signature": [ - "boolean | undefined" + "\nFlag indicating whether the cookie should be sent only via a secure connection." ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 49 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 36 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IKibanaSocket.authorizationError", - "type": "Object", + "id": "def-server.SessionStorageCookieOptions.sameSite", + "type": "CompoundType", "tags": [], - "label": "authorizationError", + "label": "sameSite", "description": [ - "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." + "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" ], "signature": [ - "Error | undefined" + "\"None\" | \"Strict\" | \"Lax\" | undefined" ], "source": { - "path": "src/core/server/http/router/socket.ts", - "lineNumber": 55 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 41 }, "deprecated": false } @@ -4440,342 +9896,449 @@ }, { "parentPluginId": "core", - "id": "def-server.IRouter", - "type": "Interface", + "id": "def-server.SessionStorageFactory", + "type": "Interface", + "tags": [], + "label": "SessionStorageFactory", + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + "" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 33 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 34 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "core", + "id": "def-server.AuthResultType", + "type": "Enum", + "tags": [], + "label": "AuthResultType", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthStatus", + "type": "Enum", "tags": [], - "label": "IRouter", + "label": "AuthStatus", "description": [ - "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" + "\nStatus indicating an outcome of the authentication." + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 15 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler", + "type": "Type", + "tags": [], + "label": "AuthenticationHandler", + "description": [ + "\nSee {@link AuthToolkit}." ], "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - "" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 62 - }, - "deprecated": false, - "children": [ + ", response: { badRequest: (options?: ", { - "parentPluginId": "core", - "id": "def-server.IRouter.routerPath", - "type": "string", - "tags": [], - "label": "routerPath", - "description": [ - "\nResulted path" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 66 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.IRouter.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nRegister a route handler for `GET` request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteRegistrar", - "text": "RouteRegistrar" - }, - "<\"get\", Context>" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 73 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">; unauthorized: (options?: ", { - "parentPluginId": "core", - "id": "def-server.IRouter.post", - "type": "Function", - "tags": [], - "label": "post", - "description": [ - "\nRegister a route handler for `POST` request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteRegistrar", - "text": "RouteRegistrar" - }, - "<\"post\", Context>" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 80 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.IRouter.put", - "type": "Function", - "tags": [], - "label": "put", - "description": [ - "\nRegister a route handler for `PUT` request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteRegistrar", - "text": "RouteRegistrar" - }, - "<\"put\", Context>" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 87 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Authenticated", + "text": "Authenticated" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.IRouter.patch", - "type": "Function", - "tags": [], - "label": "patch", - "description": [ - "\nRegister a route handler for `PATCH` request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteRegistrar", - "text": "RouteRegistrar" - }, - "<\"patch\", Context>" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 94 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" }, + " | Promise<", { - "parentPluginId": "core", - "id": "def-server.IRouter.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "\nRegister a route handler for `DELETE` request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteRegistrar", - "text": "RouteRegistrar" - }, - "<\"delete\", Context>" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 101 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors", - "type": "Function", - "tags": [], - "label": "handleLegacyErrors", - "description": [ - "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandlerWrapper", - "text": "RequestHandlerWrapper" - } - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 107 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Authenticated", + "text": "Authenticated" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" + }, + ">" ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 147 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents", - "type": "Interface", + "id": "def-server.AuthHeaders", + "type": "Type", "tags": [], - "label": "KibanaRequestEvents", + "label": "AuthHeaders", "description": [ - "\nRequest events." + "\nAuth Headers map" + ], + "signature": [ + "{ [x: string]: string | string[]; }" ], "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 62 + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 82 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents.aborted$", - "type": "Object", - "tags": [], - "label": "aborted$", - "description": [ - "\nObservable that emits once if and when the request has been aborted." - ], - "signature": [ - "Observable", - "" - ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 66 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents.completed$", - "type": "Object", - "tags": [], - "label": "completed$", - "description": [ - "\nObservable that emits once if and when the request has been completely handled.\n" - ], - "signature": [ - "Observable", - "" - ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 76 - }, - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute", - "type": "Interface", + "id": "def-server.AuthResult", + "type": "Type", "tags": [], - "label": "KibanaRequestRoute", - "description": [ - "\nRequest specific route information exposed to a handler." - ], + "label": "AuthResult", + "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestRoute", - "text": "KibanaRequestRoute" - }, - "" - ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 52 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 53 - }, - "deprecated": false + "section": "def-server.Authenticated", + "text": "Authenticated" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.method", - "type": "Uncategorized", - "tags": [], - "label": "method", - "description": [], - "signature": [ - "Method" - ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 54 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.options", - "type": "Uncategorized", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestRouteOptions", - "text": "KibanaRequestRouteOptions" - }, - "" - ], - "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 55 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" } ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DestructiveRouteMethod", + "type": "Type", + "tags": [], + "label": "DestructiveRouteMethod", + "description": [ + "\nSet of HTTP methods changing the state of the server." + ], + "signature": [ + "\"post\" | \"put\" | \"delete\" | \"patch\"" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 19 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.LegacyRequest", - "type": "Interface", + "id": "def-server.GetAuthHeaders", + "type": "Type", "tags": [ - "deprecated" + "return" + ], + "label": "GetAuthHeaders", + "description": [ + "\nGet headers to authenticate a user against Elasticsearch." ], - "label": "LegacyRequest", - "description": [], "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", { "pluginId": "core", "scope": "server", @@ -4783,1261 +10346,971 @@ "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, - " extends ", - "Request" + ") => Record | undefined" ], "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 84 + "path": "src/core/server/http/auth_headers_storage.ts", + "lineNumber": 18 }, - "deprecated": true, - "references": [ - { - "plugin": "security", - "link": { - "path": "x-pack/plugins/security/server/saved_objects/index.ts", - "lineNumber": 8 - } - }, - { - "plugin": "security", - "link": { - "path": "x-pack/plugins/security/server/saved_objects/index.ts", - "lineNumber": 34 - } - } - ], - "children": [], + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPostAuthToolkit", - "type": "Interface", + "id": "def-server.GetAuthState", + "type": "Type", "tags": [], - "label": "OnPostAuthToolkit", - "description": [], - "source": { - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "lineNumber": 42 - }, - "deprecated": false, - "children": [ + "label": "GetAuthState", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor." + ], + "signature": [ + "(request: ", { - "parentPluginId": "core", - "id": "def-server.OnPostAuthToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => Next" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "lineNumber": 44 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => { status: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreAuthToolkit", - "description": [], "source": { - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "lineNumber": 42 + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 35 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => Next" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "lineNumber": 44 - }, - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPreResponseExtensions", - "type": "Interface", + "id": "def-server.Headers", + "type": "Type", "tags": [], - "label": "OnPreResponseExtensions", + "label": "Headers", "description": [ - "\nAdditional data to extend a response." + "\nHttp request headers to read." + ], + "signature": [ + "{ accept?: 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; allow?: 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; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: 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; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: 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; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 56 + "path": "src/core/server/http/router/headers.ts", + "lineNumber": 40 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseExtensions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "additional headers to attach to the response" - ], - "signature": [ - "Record<\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 58 - }, - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPreResponseInfo", - "type": "Interface", + "id": "def-server.HttpResponsePayload", + "type": "Type", "tags": [], - "label": "OnPreResponseInfo", + "label": "HttpResponsePayload", "description": [ - "\nResponse status code." + "\nData send to the client as a response payload." + ], + "signature": [ + "string | Record | Buffer | ", + "Stream", + " | undefined" ], "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 65 + "path": "src/core/server/http/router/response.ts", + "lineNumber": 73 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseInfo.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 66 - }, - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPreResponseRender", - "type": "Interface", + "id": "def-server.IBasePath", + "type": "Type", "tags": [], - "label": "OnPreResponseRender", + "label": "IBasePath", "description": [ - "\nAdditional data to extend a response when rendering a new body" + "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 45 - }, - "deprecated": false, - "children": [ + "signature": [ + "{ remove: (path: string) => string; get: (request: ", { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "additional headers to attach to the response" - ], - "signature": [ - "Record<\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 47 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => string; set: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender.body", - "type": "string", - "tags": [], - "label": "body", - "description": [ - "the body to use in the response" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 49 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 104 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit", - "type": "Interface", + "id": "def-server.IsAuthenticated", + "type": "Type", "tags": [], - "label": "OnPreResponseToolkit", + "label": "IsAuthenticated", "description": [ - "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + "\nReturns authentication status for a request." ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 88 - }, - "deprecated": false, - "children": [ + "signature": [ + "(request: ", { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.render", - "type": "Function", - "tags": [], - "label": "render", - "description": [ - "To override the response with a different body" - ], - "signature": [ - "(responseRender: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseRender", - "text": "OnPreResponseRender" - }, - ") => OnPreResponseResult" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 90 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "(responseExtensions?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseExtensions", - "text": "OnPreResponseExtensions" - }, - " | undefined) => OnPreResponseResult" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 92 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + ") => boolean" ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit", - "type": "Interface", + "id": "def-server.KibanaRequestRouteOptions", + "type": "Type", "tags": [], - "label": "OnPreRoutingToolkit", - "description": [], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "lineNumber": 55 - }, - "deprecated": false, - "children": [ + "label": "KibanaRequestRouteOptions", + "description": [ + "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + ], + "signature": [ + "Method extends ", { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => OnPreRoutingResult" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "lineNumber": 57 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" }, + " ? Required OnPreRoutingResult" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "lineNumber": 59 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ", \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ">" ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfig", - "type": "Interface", + "id": "def-server.KibanaResponseFactory", + "type": "Type", "tags": [], - "label": "RouteConfig", + "label": "KibanaResponseFactory", "description": [ - "\nRoute specific configuration." + "\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?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, - "" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 157 - }, - "deprecated": false, - "children": [ + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.RouteConfig.path", - "type": "string", - "tags": [], - "label": "path", - "description": [ - "\nThe endpoint _within_ the router path to register the route.\n" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 171 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">; conflict: (options?: ", { - "parentPluginId": "core", - "id": "def-server.RouteConfig.validate", - "type": "CompoundType", - "tags": [], - "label": "validate", - "description": [ - "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" - ], - "signature": [ - "false | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorFullConfig", - "text": "RouteValidatorFullConfig" - }, - "" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 229 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.RouteConfig.options", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "\nAdditional route options {@link RouteConfigOptions}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 234 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions", - "type": "Interface", - "tags": [], - "label": "RouteConfigOptions", - "description": [ - "\nAdditional route options." - ], - "signature": [ + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - "" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 106 - }, - "deprecated": false, - "children": [ + "<", { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.authRequired", - "type": "CompoundType", - "tags": [], - "label": "authRequired", - "description": [ - "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." - ], - "signature": [ - "boolean | \"optional\" | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 116 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">) => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.xsrfRequired", - "type": "Uncategorized", - "tags": [], - "label": "xsrfRequired", - "description": [ - "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" - ], - "signature": [ - "(Method extends \"get\" ? never : boolean) | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 125 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">; redirected: (options: ", { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.tags", - "type": "Object", - "tags": [], - "label": "tags", - "description": [ - "\nAdditional metadata tag strings to attach to the route." - ], - "signature": [ - "readonly string[] | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 130 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "\nAdditional body options {@link RouteConfigOptionsBody}." - ], - "signature": [ - "(Method extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SafeRouteMethod", - "text": "SafeRouteMethod" - }, - " ? undefined : ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptionsBody", - "text": "RouteConfigOptionsBody" - }, - ") | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 135 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.timeout", - "type": "Object", - "tags": [], - "label": "timeout", - "description": [ - "\nDefines per-route timeouts." - ], - "signature": [ - "{ payload?: (Method extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SafeRouteMethod", - "text": "SafeRouteMethod" - }, - " ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 140 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 323 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody", - "type": "Interface", + "id": "def-server.KnownHeaders", + "type": "Type", "tags": [], - "label": "RouteConfigOptionsBody", + "label": "KnownHeaders", "description": [ - "\nAdditional body options for a route" + "\nSet of well-known HTTP headers." + ], + "signature": [ + "\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\"" ], "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 55 + "path": "src/core/server/http/router/headers.ts", + "lineNumber": 34 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.accepts", - "type": "CompoundType", - "tags": [], - "label": "accepts", - "description": [ - "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" - ], - "signature": [ - "string | string[] | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteContentType", - "text": "RouteContentType" - }, - "[] | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 68 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.maxBytes", - "type": "number", - "tags": [], - "label": "maxBytes", - "description": [ - "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." - ], - "signature": [ - "number | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 75 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.output", - "type": "CompoundType", - "tags": [], - "label": "output", - "description": [ - "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." - ], - "signature": [ - "\"data\" | \"stream\" | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 88 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.parse", - "type": "CompoundType", - "tags": [], - "label": "parse", - "description": [ - "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." - ], - "signature": [ - "boolean | \"gunzip\" | undefined" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 99 - }, - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory", - "type": "Interface", + "id": "def-server.LifecycleResponseFactory", + "type": "Type", "tags": [], - "label": "RouteValidationResultFactory", + "label": "LifecycleResponseFactory", "description": [ - "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 20 - }, - "deprecated": false, - "children": [ + "signature": [ + "{ badRequest: (options?: ", { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok", - "type": "Function", - "tags": [], - "label": "ok", - "description": [], - "signature": [ - "(value: T) => { value: T; }" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 21 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest", - "type": "Function", - "tags": [], - "label": "badRequest", - "description": [], - "signature": [ - "(error: string | Error, path?: string[] | undefined) => { error: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" - }, - "; }" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 22 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }" ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 329 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig", - "type": "Interface", + "id": "def-server.OnPostAuthHandler", + "type": "Type", "tags": [], - "label": "RouteValidatorConfig", + "label": "OnPostAuthHandler", "description": [ - "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + "\nSee {@link OnPostAuthToolkit}." ], "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorConfig", - "text": "RouteValidatorConfig" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - "" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 87 - }, - "deprecated": false, - "children": [ + ", response: { badRequest: (options?: ", { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.params", - "type": "CompoundType", - "tags": [], - "label": "params", - "description": [ - "\nValidation logic for the URL params" - ], - "signature": [ - "ObjectType", - " | ", - "Type", - "

| ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationFunction", - "text": "RouteValidationFunction" - }, - "

| undefined" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 92 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.query", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [ - "\nValidation logic for the Query params" - ], - "signature": [ - "ObjectType", - " | ", - "Type", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationFunction", - "text": "RouteValidationFunction" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 97 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">; unauthorized: (options?: ", { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "\nValidation logic for the body payload" - ], - "signature": [ - "ObjectType", - " | ", - "Type", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationFunction", - "text": "RouteValidationFunction" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 102 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions", - "type": "Interface", - "tags": [], - "label": "RouteValidatorOptions", - "description": [ - "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + }, + ") => ", + "KibanaResponse", + " | Next | Promise<", + "KibanaResponse", + " | Next>" ], "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 110 + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 51 }, "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions.unsafe", - "type": "Object", - "tags": [], - "label": "unsafe", - "description": [ - "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" - ], - "signature": [ - "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 115 - }, - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult", - "type": "Interface", + "id": "def-server.OnPreAuthHandler", + "type": "Type", "tags": [], - "label": "SessionCookieValidationResult", + "label": "OnPreAuthHandler", "description": [ - "\nReturn type from a function to validate cookie contents." + "\nSee {@link OnPreAuthToolkit}." ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 48 - }, - "deprecated": false, - "children": [ + "signature": [ + "(request: ", { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult.isValid", - "type": "boolean", - "tags": [], - "label": "isValid", - "description": [ - "\nWhether the cookie is valid or not." - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 52 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, + ", response: { badRequest: (options?: ", { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult.path", - "type": "string", - "tags": [], - "label": "path", - "description": [ - "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 56 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage", - "type": "Interface", - "tags": [], - "label": "SessionStorage", - "description": [ - "\nProvides an interface to store and retrieve data across requests." - ], - "signature": [ + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorage", - "text": "SessionStorage" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - "" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 14 - }, - "deprecated": false, - "children": [ + ">; unauthorized: (options?: ", { - "parentPluginId": "core", - "id": "def-server.SessionStorage.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nRetrieves session value from the session storage." - ], - "signature": [ - "() => Promise" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 18 - }, - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, + ") => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.SessionStorage.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [ - "\nPuts current session value into the session storage." - ], - "signature": [ - "(sessionValue: T) => void" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 23 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.set.$1", - "type": "Uncategorized", - "tags": [], - "label": "sessionValue", - "description": [ - "- value to put" - ], - "signature": [ - "T" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 23 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">; forbidden: (options?: ", { - "parentPluginId": "core", - "id": "def-server.SessionStorage.clear", - "type": "Function", - "tags": [], - "label": "clear", - "description": [ - "\nClears current session." - ], - "signature": [ - "() => void" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 27 - }, - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions", - "type": "Interface", - "tags": [], - "label": "SessionStorageCookieOptions", - "description": [ - "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." - ], - "signature": [ + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - "" - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 20 - }, - "deprecated": false, - "children": [ + ">; customError: (options: ", { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nName of the session cookie." - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 24 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, + "<", { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.encryptionKey", - "type": "string", - "tags": [], - "label": "encryptionKey", - "description": [ - "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 28 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">) => ", + "KibanaResponse", + "<", { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.validate", - "type": "Function", - "tags": [], - "label": "validate", - "description": [ - "\nFunction called to validate a cookie's decrypted value." - ], - "signature": [ - "(sessionValue: T | T[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionCookieValidationResult", - "text": "SessionCookieValidationResult" - } - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 32 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, + ">; redirected: (options: ", { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.isSecure", - "type": "boolean", - "tags": [], - "label": "isSecure", - "description": [ - "\nFlag indicating whether the cookie should be sent only via a secure connection." - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 36 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.sameSite", - "type": "CompoundType", - "tags": [], - "label": "sameSite", - "description": [ - "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" - ], - "signature": [ - "\"None\" | \"Strict\" | \"Lax\" | undefined" - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 41 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + }, + ") => ", + "KibanaResponse", + " | Next | Promise<", + "KibanaResponse", + " | Next>" ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 55 + }, + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SessionStorageFactory", - "type": "Interface", + "id": "def-server.OnPreResponseHandler", + "type": "Type", "tags": [], - "label": "SessionStorageFactory", + "label": "OnPreResponseHandler", "description": [ - "\nSessionStorage factory to bind one to an incoming request" + "\nSee {@link OnPreRoutingToolkit}." ], "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageFactory", - "text": "SessionStorageFactory" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - "" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 33 - }, - "deprecated": false, - "children": [ + ", preResponse: ", { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory.asScoped", - "type": "Function", - "tags": [], - "label": "asScoped", - "description": [], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorage", - "text": "SessionStorage" - }, - "" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 34 - }, - "deprecated": false - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + }, + ", toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + }, + ") => Render | Next | Promise" ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "core", - "id": "def-server.AuthResultType", - "type": "Enum", - "tags": [], - "label": "AuthResultType", - "description": [], "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 22 + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 104 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.AuthStatus", - "type": "Enum", - "tags": [], - "label": "AuthStatus", - "description": [ - "\nStatus indicating an outcome of the authentication." - ], - "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 15 - }, - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler", + "id": "def-server.OnPreRoutingHandler", "type": "Type", "tags": [], - "label": "AuthenticationHandler", + "label": "OnPreRoutingHandler", "description": [ - "\nSee {@link AuthToolkit}." + "\nSee {@link OnPreRoutingToolkit}." ], "signature": [ "(request: ", @@ -6045,10 +11318,28 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ", response: { badRequest: (options?: ", + ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", @@ -6066,375 +11357,479 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - ">; unauthorized: (options?: ", + ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" - } - ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 147 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthHeaders", - "type": "Type", - "tags": [], - "label": "AuthHeaders", - "description": [ - "\nAuth Headers map" - ], - "signature": [ - "{ [x: string]: string | string[]; }" - ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 82 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResult", - "type": "Type", - "tags": [], - "label": "AuthResult", - "description": [], - "signature": [ + }, + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.Authenticated", - "text": "Authenticated" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - " | ", + ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthNotHandled", - "text": "AuthNotHandled" + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, - " | ", + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - } - ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 44 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DestructiveRouteMethod", - "type": "Type", - "tags": [], - "label": "DestructiveRouteMethod", - "description": [ - "\nSet of HTTP methods changing the state of the server." - ], - "signature": [ - "\"post\" | \"put\" | \"delete\" | \"patch\"" - ], - "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 19 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetAuthHeaders", - "type": "Type", - "tags": [ - "return" - ], - "label": "GetAuthHeaders", - "description": [ - "\nGet headers to authenticate a user against Elasticsearch." - ], - "signature": [ - "(request: ", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, - " | ", + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ") => Record | undefined" - ], - "source": { - "path": "src/core/server/http/auth_headers_storage.ts", - "lineNumber": 18 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetAuthState", - "type": "Type", - "tags": [], - "label": "GetAuthState", - "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor." - ], - "signature": [ - "(request: ", + ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - " | ", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ") => { status: ", + ">) => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - "; state: T; }" - ], - "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 35 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.Headers", - "type": "Type", - "tags": [], - "label": "Headers", - "description": [ - "\nHttp request headers to read." - ], - "signature": [ - "{ accept?: 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; allow?: 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; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: 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; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: 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; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" - ], - "source": { - "path": "src/core/server/http/router/headers.ts", - "lineNumber": 40 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponsePayload", - "type": "Type", - "tags": [], - "label": "HttpResponsePayload", - "description": [ - "\nData send to the client as a response payload." - ], - "signature": [ - "undefined | string | Record | Buffer | ", - "Stream" - ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 73 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IBasePath", - "type": "Type", - "tags": [], - "label": "IBasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" - ], - "signature": [ - "{ remove: (path: string) => string; get: (request: KibanaRequest | LegacyRequest) => string; prepend: (path: string) => string; set: (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "source": { - "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 104 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IsAuthenticated", - "type": "Type", - "tags": [], - "label": "IsAuthenticated", - "description": [ - "\nReturns authentication status for a request." - ], - "signature": [ - "(request: ", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" }, - " | ", + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" }, - ") => boolean" + ") => Next | RewriteUrl | ", + "KibanaResponse", + " | Promise>" ], "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 44 + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 71 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KibanaRequestRouteOptions", + "id": "def-server.RedirectResponseOptions", "type": "Type", "tags": [], - "label": "KibanaRequestRouteOptions", + "label": "RedirectResponseOptions", "description": [ - "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + "\nHTTP response parameters for redirection response" ], "signature": [ - "Method extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.SafeRouteMethod", - "text": "SafeRouteMethod" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, - " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required>" + " & { headers: { location: string; }; }" ], "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 44 + "path": "src/core/server/http/router/response.ts", + "lineNumber": 93 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KibanaResponseFactory", + "id": "def-server.RequestHandler", "type": "Type", "tags": [], - "label": "KibanaResponseFactory", + "label": "RequestHandler", "description": [ - "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." + "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." ], "signature": [ - "{ custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | Stream | undefined>(options: CustomHttpResponseOptions) => KibanaResponse; badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; customError: (options: CustomHttpResponseOptions) => KibanaResponse; redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; ok: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; accepted: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; noContent: (options?: HttpResponseOptions) => KibanaResponse; }" + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 323 + "path": "src/core/server/http/router/router.ts", + "lineNumber": 351 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KnownHeaders", + "id": "def-server.RequestHandlerContextContainer", "type": "Type", "tags": [], - "label": "KnownHeaders", + "label": "RequestHandlerContextContainer", "description": [ - "\nSet of well-known HTTP headers." + "\nAn object that handles registration of http request context providers." ], "signature": [ - "\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + } ], "source": { - "path": "src/core/server/http/router/headers.ts", - "lineNumber": 34 + "path": "src/core/server/http/types.ts", + "lineNumber": 30 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.LifecycleResponseFactory", + "id": "def-server.RequestHandlerContextProvider", "type": "Type", "tags": [], - "label": "LifecycleResponseFactory", + "label": "RequestHandlerContextProvider", "description": [ - "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." + "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" ], "signature": [ - "{ badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; customError: (options: CustomHttpResponseOptions) => KibanaResponse; redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; }" + "(context: Pick>, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => Context[ContextName] | Promise" ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 329 + "path": "src/core/server/http/types.ts", + "lineNumber": 38 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler", + "id": "def-server.RequestHandlerWrapper", "type": "Type", "tags": [], - "label": "OnPostAuthHandler", + "label": "RequestHandlerWrapper", "description": [ - "\nSee {@link OnPostAuthToolkit}." + "\nType-safe wrapper for {@link RequestHandler} function." ], "signature": [ - "(request: ", + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" }, - ", response: { badRequest: (options?: ", + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", @@ -6452,41 +11847,25 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - ">; unauthorized: (options?: ", + ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" - } - ], - "source": { - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "lineNumber": 51 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler", - "type": "Type", - "tags": [], - "label": "OnPreAuthHandler", - "description": [ - "\nSee {@link OnPreAuthToolkit}." - ], - "signature": [ - "(request: ", + }, + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ", response: { badRequest: (options?: ", + ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", @@ -6504,84 +11883,109 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - ">; unauthorized: (options?: ", + ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" - } - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "lineNumber": 55 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler", - "type": "Type", - "tags": [], - "label": "OnPreResponseHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "signature": [ - "(request: ", + }, + ") => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ", preResponse: ", + ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseInfo", - "text": "OnPreResponseInfo" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - ", toolkit: ", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseToolkit", - "text": "OnPreResponseToolkit" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ") => Render | Next | Promise" - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 104 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler", - "type": "Type", - "tags": [], - "label": "OnPreRoutingHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "signature": [ - "(request: ", + ">) => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ", response: { badRequest: (options?: ", + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; } = { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", @@ -6606,153 +12010,144 @@ "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" - } - ], - "source": { - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "lineNumber": 71 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RedirectResponseOptions", - "type": "Type", - "tags": [], - "label": "RedirectResponseOptions", - "description": [ - "\nHTTP response parameters for redirection response" - ], - "signature": [ - "HttpResponseOptions & { headers: { location: string;}; }" - ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 93 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandler", - "type": "Type", - "tags": [], - "label": "RequestHandler", - "description": [ - "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." - ], - "signature": [ - "(context: Context, request: ", + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - ", response: ResponseFactory) => ", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - " | Promise<", + ">) => ", + "KibanaResponse", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" + "section": "def-server.ResponseError", + "text": "ResponseError" }, - ">" - ], - "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 351 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextContainer", - "type": "Type", - "tags": [], - "label": "RequestHandlerContextContainer", - "description": [ - "\nAn object that handles registration of http request context providers." - ], - "signature": [ - "IContextContainer" - ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 30 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider", - "type": "Type", - "tags": [], - "label": "RequestHandlerContextProvider", - "description": [ - "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" - ], - "signature": [ - "(context: Pick>, rest: [request: ", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" }, - ", response: { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + ") => ", + "KibanaResponse", + " | Buffer | ", "Stream", - " | undefined>(options: ", + ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, - ") => ", + ") => ", "KibanaResponse", - "; badRequest: (options?: ", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - } - ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 38 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper", - "type": "Type", - "tags": [], - "label": "RequestHandlerWrapper", - "description": [ - "\nType-safe wrapper for {@link RequestHandler} function." - ], - "signature": [ - "(handler: ", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>(handler: ", { "pluginId": "core", "scope": "server", @@ -6882,7 +12277,7 @@ "\nRoute handler common definition\n" ], "signature": [ - "(route: ", + "(route: ", { "pluginId": "core", "scope": "server", @@ -6898,7 +12293,7 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { @@ -6909,7 +12304,170 @@ "text": "CustomHttpResponseOptions" }, ") => ", - "KibanaResponse" + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", @@ -6993,7 +12551,21 @@ "\nRoute validations config and options merged into one object" ], "signature": [ - "RouteValidatorConfig & RouteValidatorOptions" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" + }, + " & ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidatorOptions", + "text": "RouteValidatorOptions" + } ], "source": { "path": "src/core/server/http/router/validator/validator.ts", @@ -7096,7 +12668,7 @@ "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" ], "signature": [ - " | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index 8edf6fce295f68..3590d38b0f8265 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -161,7 +161,9 @@ "type": "Array", "tags": [], "label": "objects", - "description": [], + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" + ], "signature": [ { "pluginId": "core", @@ -308,7 +310,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">) => Promise<", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", { "pluginId": "core", "scope": "public", @@ -340,7 +342,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">" ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", @@ -451,7 +453,9 @@ "type": "Array", "tags": [], "label": "objects", - "description": [], + "description": [ + "- an array ids, or an array of objects containing id and optionally type" + ], "signature": [ "{ id: string; type: string; }[]" ], @@ -1535,15 +1539,113 @@ "{@link SavedObjectsClient}" ], "signature": [ - "Pick<", + "{ get: (type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">; delete: (type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">; bulkCreate: (objects?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">; find: (options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + ">; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">; update: (type: string, id: string, attributes: T, { version, references, upsert }?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">; bulkUpdate: (objects?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" + ">; }" ], "source": { "path": "src/core/public/saved_objects/saved_objects_service.ts", @@ -1642,7 +1744,113 @@ "\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n" ], "signature": [ - "{ get: (type: string, id: string) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; bulkCreate: (objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise>; find: (options: Pick) => Promise>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise>; update: (type: string, id: string, attributes: T, { version, references, upsert }?: SavedObjectsUpdateOptions) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" + "{ get: (type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">; delete: (type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">; bulkCreate: (objects?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">; find: (options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + ">; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">; update: (type: string, id: string, attributes: T, { version, references, upsert }?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">; bulkUpdate: (objects?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">; }" ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", @@ -2894,7 +3102,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">, dependencies?: ", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", { "pluginId": "core", "scope": "server", @@ -2934,7 +3142,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", @@ -3214,15 +3422,8 @@ "label": "isSavedObjectsClientError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isSavedObjectsClientError" + "(error: any) => error is ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3258,15 +3459,8 @@ "label": "decorateBadRequestError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateBadRequestError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3319,15 +3513,8 @@ "label": "createBadRequestError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createBadRequestError" + "(reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3363,15 +3550,8 @@ "label": "createUnsupportedTypeError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createUnsupportedTypeError" + "(type: string) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3407,15 +3587,9 @@ "label": "isBadRequestError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isBadRequestError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3452,15 +3626,8 @@ "label": "createInvalidVersionError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createInvalidVersionError" + "(versionInput?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3496,15 +3663,9 @@ "label": "isInvalidVersionError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isInvalidVersionError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3541,15 +3702,8 @@ "label": "decorateNotAuthorizedError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateNotAuthorizedError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3602,15 +3756,9 @@ "label": "isNotAuthorizedError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isNotAuthorizedError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3647,15 +3795,8 @@ "label": "decorateForbiddenError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateForbiddenError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3708,15 +3849,9 @@ "label": "isForbiddenError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isForbiddenError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3753,15 +3888,8 @@ "label": "decorateRequestEntityTooLargeError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateRequestEntityTooLargeError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3814,15 +3942,9 @@ "label": "isRequestEntityTooLargeError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isRequestEntityTooLargeError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3859,15 +3981,8 @@ "label": "createGenericNotFoundError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createGenericNotFoundError" + "(type?: string | null, id?: string | null) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3920,15 +4035,8 @@ "label": "createIndexAliasNotFoundError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createIndexAliasNotFoundError" + "(alias: string) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3964,15 +4072,8 @@ "label": "decorateIndexAliasNotFoundError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateIndexAliasNotFoundError" + "(error: Error, alias: string) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4025,15 +4126,9 @@ "label": "isNotFoundError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isNotFoundError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4070,15 +4165,8 @@ "label": "decorateConflictError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateConflictError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4131,15 +4219,8 @@ "label": "createConflictError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createConflictError" + "(type: string, id: string, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4209,15 +4290,9 @@ "label": "isConflictError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isConflictError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4254,15 +4329,8 @@ "label": "decorateTooManyRequestsError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateTooManyRequestsError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4315,15 +4383,8 @@ "label": "createTooManyRequestsError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".createTooManyRequestsError" + "(type: string, id: string) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4376,15 +4437,9 @@ "label": "isTooManyRequestsError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isTooManyRequestsError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4421,15 +4476,8 @@ "label": "decorateEsCannotExecuteScriptError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateEsCannotExecuteScriptError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4482,15 +4530,9 @@ "label": "isEsCannotExecuteScriptError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isEsCannotExecuteScriptError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4527,15 +4569,8 @@ "label": "decorateEsUnavailableError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateEsUnavailableError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4588,15 +4623,9 @@ "label": "isEsUnavailableError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isEsUnavailableError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4633,15 +4662,8 @@ "label": "decorateGeneralError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".decorateGeneralError" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4694,15 +4716,9 @@ "label": "isGeneralError", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - ".isGeneralError" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4755,697 +4771,370 @@ "label": "#savedObjectsClient", "description": [], "signature": [ - "Pick<", + "{ get: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 36 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportTransforms", - "type": "Object", - "tags": [], - "label": "#exportTransforms", - "description": [], - "signature": [ - "Record Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportTransform", - "text": "SavedObjectsExportTransform" + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 37 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportSizeLimit", - "type": "number", - "tags": [], - "label": "#exportSizeLimit", - "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 38 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.log", - "type": "Object", - "tags": [], - "label": "#log", - "description": [], - "signature": [ - "Logger" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 39 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 41 - }, - "deprecated": false, - "children": [ + ") => Promise<{}>; create: (type: string, attributes: T, options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger", - "type": "Object", - "tags": [], - "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", - "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 46 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 47 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeRegistry", - "text": "SavedObjectTypeRegistry" - }, - ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 48 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.exportSizeLimit", - "type": "number", - "tags": [], - "label": "exportSizeLimit", - "description": [], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 49 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.logger", - "type": "Object", - "tags": [], - "label": "logger", - "description": [], - "signature": [ - "Logger" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 50 - }, - "deprecated": false - } - ] - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByTypes", - "type": "Function", - "tags": [ - "throws" - ], - "label": "exportByTypes", - "description": [ - "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" - ], - "signature": [ - "(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.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" + "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<", - "Readable", - ">" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 73 - }, - "deprecated": false, - "children": [ { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByTypes.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 73 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByObjects", - "type": "Function", - "tags": [ - "throws" - ], - "label": "exportByObjects", - "description": [ - "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" - ], - "signature": [ - "(options: ", + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; find: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, ") => Promise<", - "Readable", - ">" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 92 - }, - "deprecated": false, - "children": [ { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByObjects.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 92 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError", - "type": "Class", - "tags": [], - "label": "SavedObjectsExportError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - }, - " extends Error" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 14 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 15 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 16 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, + ">; bulkGet: (objects?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$2", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 17 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 18 - }, - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.exportSizeExceeded", - "type": "Function", - "tags": [], - "label": "exportSizeExceeded", - "description": [], - "signature": [ - "typeof ", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, - ".exportSizeExceeded" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 27 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", - "type": "number", - "tags": [], - "label": "limit", - "description": [], - "signature": [ - "number" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 27 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectFetchError", - "type": "Function", - "tags": [], - "label": "objectFetchError", - "description": [], - "signature": [ - "typeof ", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" }, - ".objectFetchError" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 36 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectFetchError.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 36 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError", - "type": "Function", - "tags": [], - "label": "objectTransformError", - "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" - ], - "signature": [ - "typeof ", + ">; resolve: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, - ".objectTransformError" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 45 - }, - "deprecated": false, - "children": [ + ") => Promise<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 45 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError.$2", - "type": "Object", - "tags": [], - "label": "cause", - "description": [], - "signature": [ - "Error" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 45 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.invalidTransformError", - "type": "Function", - "tags": [], - "label": "invalidTransformError", - "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." - ], - "signature": [ - "typeof ", + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" }, - ".invalidTransformError" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 60 - }, - "deprecated": false, - "children": [ + ">; collectMultiNamespaceReferences: (objects: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", - "type": "Array", - "tags": [], - "label": "objectKeys", - "description": [], - "signature": [ - "string[]" - ], - "source": { - "path": "src/core/server/saved_objects/export/errors.ts", - "lineNumber": 60 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter", - "type": "Class", - "tags": [], - "label": "SavedObjectsImporter", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 29 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "#savedObjectsClient", - "description": [], - "signature": [ - "Pick<", + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + " | 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 30 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 36 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.typeRegistry", + "id": "def-server.SavedObjectsExporter.exportTransforms", "type": "Object", "tags": [], - "label": "#typeRegistry", + "label": "#exportTransforms", "description": [], "signature": [ - "Pick<", + "{ [x: string]: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeRegistry", - "text": "SavedObjectTypeRegistry" + "section": "def-server.SavedObjectsExportTransform", + "text": "SavedObjectsExportTransform" }, - ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + "; }" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 31 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 37 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.importSizeLimit", + "id": "def-server.SavedObjectsExporter.exportSizeLimit", "type": "number", "tags": [], - "label": "#importSizeLimit", + "label": "#exportSizeLimit", "description": [], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 32 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 38 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.importHooks", + "id": "def-server.SavedObjectsExporter.log", "type": "Object", "tags": [], - "label": "#importHooks", + "label": "#log", "description": [], "signature": [ - "Record[]>" + "Logger" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 33 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 39 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed", + "id": "def-server.SavedObjectsExporter.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -5454,82 +5143,414 @@ "any" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 35 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 41 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger", "type": "Object", "tags": [], - "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", "description": [], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 39 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 46 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.savedObjectsClient", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.savedObjectsClient", "type": "Object", "tags": [], "label": "savedObjectsClient", "description": [], "signature": [ - "Pick<", + "{ get: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 40 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "Pick<", + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeRegistry", - "text": "SavedObjectTypeRegistry" + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, - ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" - ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 41 + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 47 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.importSizeLimit", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.typeRegistry", + "type": "Object", + "tags": [], + "label": "typeRegistry", + "description": [], + "signature": [ + "{ getType: (type: string) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + " | undefined; getVisibleTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getAllTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getImportableAndExportableTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 48 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.exportSizeLimit", "type": "number", "tags": [], - "label": "importSizeLimit", + "label": "exportSizeLimit", "description": [], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 42 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 49 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger" + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 50 }, "deprecated": false } @@ -5540,59 +5561,53 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.import", + "id": "def-server.SavedObjectsExporter.exportByTypes", "type": "Function", "tags": [ "throws" ], - "label": "import", + "label": "exportByTypes", "description": [ - "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" ], "signature": [ - "({ readStream, createNewCopies, namespace, overwrite, }: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, + "Readable", ">" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 64 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 73 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.import.$1", + "id": "def-server.SavedObjectsExporter.exportByTypes.$1", "type": "Object", "tags": [], - "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", + "label": "options", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" } ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 64 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 73 }, "deprecated": false, "isRequired": true @@ -5602,59 +5617,53 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.resolveImportErrors", + "id": "def-server.SavedObjectsExporter.exportByObjects", "type": "Function", "tags": [ "throws" ], - "label": "resolveImportErrors", + "label": "exportByObjects", "description": [ - "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" + "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" ], "signature": [ - "({ readStream, createNewCopies, namespace, retries, }: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, + "Readable", ">" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 92 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.resolveImportErrors.$1", + "id": "def-server.SavedObjectsExporter.exportByObjects.$1", "type": "Object", "tags": [], - "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", + "label": "options", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" } ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 92 }, "deprecated": false, "isRequired": true @@ -5667,108 +5676,133 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError", + "id": "def-server.SavedObjectsExportError", "type": "Class", "tags": [], - "label": "SavedObjectsImportError", + "label": "SavedObjectsExportError", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" }, " extends Error" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "lineNumber": 14 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.importSizeExceeded", + "id": "def-server.SavedObjectsExportError.Unnamed", "type": "Function", "tags": [], - "label": "importSizeExceeded", + "label": "Constructor", "description": [], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - }, - ".importSizeExceeded" + "any" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 27 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 15 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", - "type": "number", + "id": "def-server.SavedObjectsExportError.Unnamed.$1", + "type": "string", "tags": [], - "label": "limit", + "label": "type", "description": [], "signature": [ - "number" + "string" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 27 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 16 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.Unnamed.$2", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 17 }, "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 18 + }, + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded", "type": "Function", "tags": [], - "label": "nonUniqueImportObjects", + "label": "exportSizeExceeded", "description": [], "signature": [ - "typeof ", + "(limit: number) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - }, - ".nonUniqueImportObjects" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 34 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1", - "type": "Array", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", + "type": "number", "tags": [], - "label": "nonUniqueEntries", + "label": "limit", "description": [], "signature": [ - "string[]" + "number" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 34 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27 }, "deprecated": false, "isRequired": true @@ -5778,41 +5812,43 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", + "id": "def-server.SavedObjectsExportError.objectFetchError", "type": "Function", "tags": [], - "label": "nonUniqueRetryObjects", + "label": "objectFetchError", "description": [], "signature": [ - "typeof ", + "(objects: ", + "SavedObject", + "[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - }, - ".nonUniqueRetryObjects" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 36 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1", + "id": "def-server.SavedObjectsExportError.objectFetchError.$1", "type": "Array", "tags": [], - "label": "nonUniqueRetryObjects", + "label": "objects", "description": [], "signature": [ - "string[]" + "SavedObject", + "[]" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 36 }, "deprecated": false, "isRequired": true @@ -5822,41 +5858,62 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", + "id": "def-server.SavedObjectsExportError.objectTransformError", "type": "Function", "tags": [], - "label": "nonUniqueRetryDestinations", - "description": [], + "label": "objectTransformError", + "description": [ + "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" + ], "signature": [ - "typeof ", + "(objects: ", + "SavedObject", + "[], cause: Error) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - }, - ".nonUniqueRetryDestinations" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 48 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 45 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", + "id": "def-server.SavedObjectsExportError.objectTransformError.$1", "type": "Array", "tags": [], - "label": "nonUniqueRetryDestinations", + "label": "objects", "description": [], "signature": [ - "string[]" + "SavedObject", + "[]" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 48 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 45 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.objectTransformError.$2", + "type": "Object", + "tags": [], + "label": "cause", + "description": [], + "signature": [ + "Error" + ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 45 }, "deprecated": false, "isRequired": true @@ -5866,42 +5923,42 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.referencesFetchError", + "id": "def-server.SavedObjectsExportError.invalidTransformError", "type": "Function", "tags": [], - "label": "referencesFetchError", - "description": [], + "label": "invalidTransformError", + "description": [ + "\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." + ], "signature": [ - "typeof ", + "(objectKeys: string[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - }, - ".referencesFetchError" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 55 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 60 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.referencesFetchError.$1", + "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", "type": "Array", "tags": [], - "label": "objects", + "label": "objectKeys", "description": [], "signature": [ - "SavedObject", - "[]" + "string[]" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 55 + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 60 }, "deprecated": false, "isRequired": true @@ -5914,127 +5971,54 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository", + "id": "def-server.SavedObjectsImporter", "type": "Class", "tags": [], - "label": "SavedObjectsRepository", + "label": "SavedObjectsImporter", "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 171 + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 29 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create", - "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "property" - ], - "label": "create", - "description": [ - "\nPersists an object\n" - ], + "id": "def-server.SavedObjectsImporter.savedObjectsClient", + "type": "Object", + "tags": [], + "label": "#savedObjectsClient", + "description": [], "signature": [ - "(type: string, attributes: T, options?: ", + "{ get: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, ") => Promise<", "SavedObject", - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 269 - }, - "deprecated": false, - "children": [ + ">; delete: (type: string, id: string, options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 270 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, + ") => Promise<{}>; create: (type: string, attributes: T, options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$2", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 271 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 272 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { id, type, version, attributes }" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate", - "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "bulkCreate", - "description": [ - "\nCreates multiple documents at once\n" - ], - "signature": [ - "(objects: ", + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", { "pluginId": "core", "scope": "server", @@ -6050,7 +6034,7 @@ "section": "def-server.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, - ") => Promise<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", @@ -6058,79 +6042,7 @@ "section": "def-server.SavedObjectsBulkResponse", "text": "SavedObjectsBulkResponse" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 362 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 363 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 364 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts", - "type": "Function", - "tags": [], - "label": "checkConflicts", - "description": [ - "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." - ], - "signature": [ - "(objects?: ", + ">; checkConflicts: (objects?: ", { "pluginId": "core", "scope": "server", @@ -6154,319 +6066,47 @@ "section": "def-server.SavedObjectsCheckConflictsResponse", "text": "SavedObjectsCheckConflictsResponse" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 548 - }, - "deprecated": false, - "children": [ + ">; find: (options: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 549 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 550 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete", - "type": "Function", - "tags": [ - "property" - ], - "label": "delete", - "description": [ - "\nDeletes an object\n" - ], - "signature": [ - "(type: string, id: string, options?: ", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 635 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 635 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 635 - }, - "deprecated": false, - "isRequired": true + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 635 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace", - "type": "Function", - "tags": [], - "label": "deleteByNamespace", - "description": [ - "\nDeletes all objects from the provided namespace.\n" - ], - "signature": [ - "(namespace: string, options?: ", + ">; bulkGet: (objects?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - }, - ") => Promise" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 697 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 698 - }, - "deprecated": false, - "isRequired": true + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 699 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.find", - "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property" - ], - "label": "find", - "description": [], - "signature": [ - "(options: ", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 759 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 760 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet", - "type": "Function", - "tags": [ - "property" - ], - "label": "bulkGet", - "description": [ - "\nReturns an array of objects by id\n" - ], - "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" }, - "[], options?: ", + ">; resolve: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", @@ -6479,746 +6119,2359 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 926 - }, - "deprecated": false, - "children": [ + ">; update: (type: string, id: string, attributes: Partial, options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- an array of objects containing id, type and optionally fields" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 927 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" }, + ") => Promise<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 928 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }] }" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get", - "type": "Function", - "tags": [ - "property" - ], - "label": "get", - "description": [ - "\nGets a single object\n" - ], - "signature": [ - "(type: string, id: string, options?: ", + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" }, - ") => Promise<", - "SavedObject", - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1013 - }, - "deprecated": false, - "children": [ + "[], options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1014 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" }, + " | undefined) => Promise<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1015 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" }, + ">; updateObjectsSpaces: (objects: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1016 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { id, type, version, attributes }" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve", - "type": "Function", - "tags": [ - "property" - ], - "label": "resolve", - "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" - ], - "signature": [ - "(type: string, id: string, options?: ", + "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.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" }, - ") => Promise<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1055 - }, - "deprecated": false, - "children": [ + ">; bulkUpdate: (objects: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1056 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" }, + "[], options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1057 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1058 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { saved_object, outcome }" - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update", - "type": "Function", - "tags": [ - "property", - "property", - "property" - ], - "label": "update", - "description": [ - "\nUpdates an object\n" - ], - "signature": [ - "(type: string, id: string, attributes: Partial, options?: ", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" }, - ") => Promise<", + ">; removeReferencesTo: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1185 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1186 - }, - "deprecated": false, - "isRequired": true + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" }, + " | undefined) => Promise<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1187 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" }, + ">; openPointInTimeForType: (type: string | string[], options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Partial" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1188 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - "" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1189 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences", - "type": "Function", - "tags": [], - "label": "collectMultiNamespaceReferences", - "description": [ - "\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n" - ], - "signature": [ - "(objects: ", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" }, - "[], options?: ", + ">; closePointInTime: (id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1283 - }, - "deprecated": false, - "children": [ + ">; createPointInTimeFinder: (findOptions: Pick<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "The objects to get the references for." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1284 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1285 - }, - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces", - "type": "Function", - "tags": [], - "label": "updateObjectsSpaces", - "description": [ - "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" - ], - "signature": [ - "(objects: ", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + " | undefined) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" }, - " | undefined) => Promise<", + "; errors: typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" }, - ">" + "; }" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1307 + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 30 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1308 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$2", - "type": "Array", - "tags": [], - "label": "spacesToAdd", - "description": [], - "signature": [ - "string[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1309 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$3", - "type": "Array", - "tags": [], - "label": "spacesToRemove", - "description": [], - "signature": [ - "string[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1310 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1311 - }, - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate", - "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "bulkUpdate", - "description": [ - "\nUpdates multiple objects in bulk\n" - ], + "id": "def-server.SavedObjectsImporter.typeRegistry", + "type": "Object", + "tags": [], + "label": "#typeRegistry", + "description": [], "signature": [ - "(objects: ", + "{ getType: (type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - "[], options?: ", + " | undefined; getVisibleTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => Promise<", + "[]; getAllTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1334 - }, - "deprecated": false, - "children": [ + "[]; getImportableAndExportableTypes: () => ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- [{ type, id, attributes, options: { version, namespace } references }]" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1335 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1336 - }, - "deprecated": false, - "isRequired": true - } + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ] + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 31 + }, + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo", - "type": "Function", + "id": "def-server.SavedObjectsImporter.importSizeLimit", + "type": "number", "tags": [], - "label": "removeReferencesTo", - "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" - ], + "label": "#importSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 32 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.importHooks", + "type": "Object", + "tags": [], + "label": "#importHooks", + "description": [], "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - ") => Promise<", + "{ [x: string]: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" + "section": "def-server.SavedObjectsImportHook", + "text": "SavedObjectsImportHook" }, - ">" + "[]; }" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1551 + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 33 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 35 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", - "type": "string", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit", + "type": "Object", "tags": [], - "label": "type", + "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", "description": [], - "signature": [ - "string" - ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1552 - }, + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 39 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.savedObjectsClient", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 40 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.typeRegistry", + "type": "Object", + "tags": [], + "label": "typeRegistry", + "description": [], + "signature": [ + "{ getType: (type: string) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + " | undefined; getVisibleTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getAllTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getImportableAndExportableTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 41 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.importSizeLimit", + "type": "number", + "tags": [], + "label": "importSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.import", + "type": "Function", + "tags": [ + "throws" + ], + "label": "import", + "description": [ + "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + ], + "signature": [ + "({ readStream, createNewCopies, namespace, overwrite, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.import.$1", + "type": "Object", + "tags": [], + "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.resolveImportErrors", + "type": "Function", + "tags": [ + "throws" + ], + "label": "resolveImportErrors", + "description": [ + "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" + ], + "signature": [ + "({ readStream, createNewCopies, namespace, retries, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.resolveImportErrors.$1", + "type": "Object", + "tags": [], + "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError", + "type": "Class", + "tags": [], + "label": "SavedObjectsImportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + " extends Error" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 14 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.importSizeExceeded", + "type": "Function", + "tags": [], + "label": "importSizeExceeded", + "description": [], + "signature": [ + "(limit: number) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", + "type": "number", + "tags": [], + "label": "limit", + "description": [], + "signature": [ + "number" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", + "type": "Function", + "tags": [], + "label": "nonUniqueImportObjects", + "description": [], + "signature": [ + "(nonUniqueEntries: string[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1", + "type": "Array", + "tags": [], + "label": "nonUniqueEntries", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", + "type": "Function", + "tags": [], + "label": "nonUniqueRetryObjects", + "description": [], + "signature": [ + "(nonUniqueRetryObjects: string[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1", + "type": "Array", + "tags": [], + "label": "nonUniqueRetryObjects", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", + "type": "Function", + "tags": [], + "label": "nonUniqueRetryDestinations", + "description": [], + "signature": [ + "(nonUniqueRetryDestinations: string[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", + "type": "Array", + "tags": [], + "label": "nonUniqueRetryDestinations", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.referencesFetchError", + "type": "Function", + "tags": [], + "label": "referencesFetchError", + "description": [], + "signature": [ + "(objects: ", + "SavedObject", + "[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.referencesFetchError.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObject", + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository", + "type": "Class", + "tags": [], + "label": "SavedObjectsRepository", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 171 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.create", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property" + ], + "label": "create", + "description": [ + "\nPersists an object\n" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => Promise<", + "SavedObject", + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 269 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 270 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 271 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 272 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { id, type, version, attributes }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkCreate", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once\n" + ], + "signature": [ + "(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" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 362 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 363 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 364 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.checkConflicts", + "type": "Function", + "tags": [], + "label": "checkConflicts", + "description": [ + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." + ], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 548 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.checkConflicts.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 549 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.checkConflicts.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 550 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.delete", + "type": "Function", + "tags": [ + "property" + ], + "label": "delete", + "description": [ + "\nDeletes an object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 635 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 635 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 635 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 635 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.deleteByNamespace", + "type": "Function", + "tags": [], + "label": "deleteByNamespace", + "description": [ + "\nDeletes all objects from the provided namespace.\n" + ], + "signature": [ + "(namespace: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + ") => Promise" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 697 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 698 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 699 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.find", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", + "description": [], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 759 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 760 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkGet", + "type": "Function", + "tags": [ + "property" + ], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 926 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type and optionally fields" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 927 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkGet.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 928 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }] }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.get", + "type": "Function", + "tags": [ + "property" + ], + "label": "get", + "description": [ + "\nGets a single object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1013 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1014 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1015 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.get.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1016 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { id, type, version, attributes }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.resolve", + "type": "Function", + "tags": [ + "property" + ], + "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1055 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1056 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1057 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.resolve.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1058 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { saved_object, outcome }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.update", + "type": "Function", + "tags": [ + "property", + "property", + "property" + ], + "label": "update", + "description": [ + "\nUpdates an object\n" + ], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1185 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1186 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1187 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1188 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1189 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences", + "type": "Function", + "tags": [], + "label": "collectMultiNamespaceReferences", + "description": [ + "\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n" + ], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1283 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "The objects to get the references for." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1284 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1285 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces", + "type": "Function", + "tags": [], + "label": "updateObjectsSpaces", + "description": [ + "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + ], + "signature": [ + "(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" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1307 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1308 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$2", + "type": "Array", + "tags": [], + "label": "spacesToAdd", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1309 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$3", + "type": "Array", + "tags": [], + "label": "spacesToRemove", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1310 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1311 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkUpdate", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "bulkUpdate", + "description": [ + "\nUpdates multiple objects in bulk\n" + ], + "signature": [ + "(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" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1334 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1335 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1336 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.removeReferencesTo", + "type": "Function", + "tags": [], + "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1551 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1552 + }, "deprecated": false, "isRequired": true }, @@ -7579,7 +8832,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">, dependencies?: ", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", { "pluginId": "core", "scope": "server", @@ -7619,7 +8872,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", @@ -8113,7 +9366,9 @@ "type": "string", "tags": [], "label": "namespace", - "description": [], + "description": [ + "The namespace ID, which must be either a non-empty string or `undefined`." + ], "signature": [ "string | undefined" ], @@ -8151,7 +9406,9 @@ "type": "string", "tags": [], "label": "namespace", - "description": [], + "description": [ + "The namespace string, which must be non-empty." + ], "signature": [ "string" ], @@ -8235,15 +9492,7 @@ "\nGenerates a random ID for a saved objects." ], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUtils", - "text": "SavedObjectsUtils" - }, - ".generateId" + "() => string" ], "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", @@ -8265,15 +9514,7 @@ "\nValidates that a saved object ID has been randomly generated.\n" ], "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUtils", - "text": "SavedObjectsUtils" - }, - ".isRandomId" + "(id: string | undefined) => boolean" ], "source": { "path": "src/core/server/saved_objects/service/lib/utils.ts", @@ -8822,7 +10063,9 @@ "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", @@ -8840,7 +10083,9 @@ "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", "lineNumber": 60 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -9627,7 +10872,7 @@ "{@inheritdoc SavedObjectAttributes}" ], "signature": [ - "Partial" + "{ [P in keyof T]?: T[P] | undefined; }" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", @@ -9683,26 +10928,207 @@ } ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 248 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 248 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 250 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + "" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 287 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 288 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCheckConflictsObject", + "description": [ + "\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 194 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 195 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 196 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCheckConflictsResponse", + "description": [ + "\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 203 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "{ id: string; type: string; error: ", + "SavedObjectError", + "; }[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 204 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientProviderOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientProviderOptions", + "description": [ + "\nOptions to control the creation of the Saved Objects Client." + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 57 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", - "type": "CompoundType", + "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", + "type": "Array", "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" + "label": "excludedWrappers", + "description": [], + "signature": [ + "string[] | undefined" ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 58 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [], "signature": [ - "boolean | \"wait_for\" | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 250 + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 59 }, "deprecated": false } @@ -9711,241 +11137,376 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateResponse", + "id": "def-server.SavedObjectsClientWrapperOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkUpdateResponse", + "label": "SavedObjectsClientWrapperOptions", "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - "" + "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 287 + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 19 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", - "type": "Array", + "id": "def-server.SavedObjectsClientWrapperOptions.client", + "type": "Object", "tags": [], - "label": "saved_objects", + "label": "client", "description": [], "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 288 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCheckConflictsObject", - "description": [ - "\n" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 194 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 195 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 196 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCheckConflictsResponse", - "description": [ - "\n" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 203 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsResponse.errors", - "type": "Array", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - "{ id: string; type: string; error: ", - "SavedObjectError", - "; }[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 204 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientProviderOptions", - "description": [ - "\nOptions to control the creation of the Saved Objects Client." - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 57 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", - "type": "Array", - "tags": [], - "label": "excludedWrappers", - "description": [], - "signature": [ - "string[] | undefined" + " | 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" ], "source": { "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 58 + "lineNumber": 20 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", - "type": "Array", - "tags": [], - "label": "includedHiddenTypes", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 59 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientWrapperOptions", - "description": [ - "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 19 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.client", + "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", "type": "Object", "tags": [], - "label": "client", + "label": "typeRegistry", "description": [], "signature": [ - "Pick<", + "{ getType: (type: string) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + " | undefined; getVisibleTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getAllTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 20 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "Pick<", + "[]; getImportableAndExportableTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeRegistry", - "text": "SavedObjectTypeRegistry" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" ], "source": { "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", @@ -10582,15 +12143,55 @@ "label": "client", "description": [], "signature": [ - "Pick(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; 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" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, \"find\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ">; }" ], "source": { "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", @@ -12588,17 +14189,206 @@ "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", - "type": "string", + "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unsupported_type\"" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 63 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterField", + "type": "Interface", + "tags": [], + "label": "SavedObjectsIncrementCounterField", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 161 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterField.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "The field name to increment the counter by." + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 163 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", + "type": "number", + "tags": [], + "label": "incrementBy", + "description": [ + "The number to increment the field by (defaults to 1)." + ], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 165 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsIncrementCounterOptions", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 120 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", + "type": "CompoundType", + "tags": [], + "label": "initialize", + "description": [ + "\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented." + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 126 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@link SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 128 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" + ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 133 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", + "type": "Uncategorized", + "tags": [], + "label": "upsertAttributes", + "description": [ + "\nAttributes to use when upserting the document if it doesn't exist." + ], + "signature": [ + "Attributes | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 137 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMappingProperties", + "type": "Interface", + "tags": [], + "label": "SavedObjectsMappingProperties", + "description": [ + "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 87 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMappingProperties.Unnamed", + "type": "Any", "tags": [], - "label": "type", + "label": "Unnamed", "description": [], "signature": [ - "\"unsupported_type\"" + "any" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 63 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 88 }, "deprecated": false } @@ -12607,69 +14397,248 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterField", + "id": "def-server.SavedObjectsMigrationLogger", "type": "Interface", "tags": [], - "label": "SavedObjectsIncrementCounterField", + "label": "SavedObjectsMigrationLogger", "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 161 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 19 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterField.fieldName", - "type": "string", + "id": "def-server.SavedObjectsMigrationLogger.debug", + "type": "Function", "tags": [], - "label": "fieldName", - "description": [ - "The field name to increment the counter by." + "label": "debug", + "description": [], + "signature": [ + "(msg: string) => void" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 163 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 20 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.msg", + "type": "string", + "tags": [], + "label": "msg", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", - "type": "number", + "id": "def-server.SavedObjectsMigrationLogger.info", + "type": "Function", "tags": [], - "label": "incrementBy", - "description": [ - "The number to increment the field by (defaults to 1)." + "label": "info", + "description": [], + "signature": [ + "(msg: string) => void" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 21 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.msg", + "type": "string", + "tags": [], + "label": "msg", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 21 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.warning", + "type": "Function", + "tags": [ + "deprecated" ], + "label": "warning", + "description": [], "signature": [ - "number | undefined" + "(msg: string) => void" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 165 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 25 }, - "deprecated": false + "deprecated": true, + "references": [ + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts", + "lineNumber": 29 + } + }, + { + "plugin": "dashboard", + "link": { + "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts", + "lineNumber": 56 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts", + "lineNumber": 167 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts", + "lineNumber": 234 + } + } + ], + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.msg", + "type": "string", + "tags": [], + "label": "msg", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.warn", + "type": "Function", + "tags": [], + "label": "warn", + "description": [], + "signature": [ + "(msg: string) => void" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 26 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.msg", + "type": "string", + "tags": [], + "label": "msg", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 26 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.error", + "type": "Function", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "(msg: string, meta: Meta) => void" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.msg", + "type": "string", + "tags": [], + "label": "msg", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.meta", + "type": "Uncategorized", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "Meta" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions", + "id": "def-server.SavedObjectsOpenPointInTimeOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsIncrementCounterOptions", + "label": "SavedObjectsOpenPointInTimeOptions", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" }, - " extends ", + " extends ", { "pluginId": "core", "scope": "server", @@ -12679,81 +14648,75 @@ } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 120 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 326 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", - "type": "CompoundType", - "tags": [], - "label": "initialize", - "description": [ - "\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented." - ], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 126 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", - "type": "Object", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", + "type": "string", "tags": [], - "label": "migrationVersion", + "label": "keepAlive", "description": [ - "{@link SavedObjectsMigrationVersion}" + "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." ], "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 128 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 330 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", - "type": "CompoundType", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "type": "string", "tags": [], - "label": "refresh", + "label": "preference", "description": [ - "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" + "\nAn optional ES preference value to be used for the query." ], "signature": [ - "boolean | \"wait_for\" | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 133 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 334 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsOpenPointInTimeResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsOpenPointInTimeResponse", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 340 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", - "type": "Uncategorized", + "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", + "type": "string", "tags": [], - "label": "upsertAttributes", + "label": "id", "description": [ - "\nAttributes to use when upserting the document if it doesn't exist." - ], - "signature": [ - "Attributes | undefined" + "\nPIT ID returned from ES." ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 137 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 344 }, "deprecated": false } @@ -12762,32 +14725,43 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsMappingProperties", + "id": "def-server.SavedObjectsPitParams", "type": "Interface", "tags": [], - "label": "SavedObjectsMappingProperties", - "description": [ - "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" - ], + "label": "SavedObjectsPitParams", + "description": [], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 87 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 69 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsMappingProperties.Unnamed", - "type": "Any", + "id": "def-server.SavedObjectsPitParams.id", + "type": "string", "tags": [], - "label": "Unnamed", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 70 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsPitParams.keepAlive", + "type": "string", + "tags": [], + "label": "keepAlive", "description": [], "signature": [ - "any" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 71 }, "deprecated": false } @@ -12796,130 +14770,113 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger", + "id": "def-server.SavedObjectsRawDoc", "type": "Interface", "tags": [], - "label": "SavedObjectsMigrationLogger", - "description": [], + "label": "SavedObjectsRawDoc", + "description": [ + "\nA raw document as represented directly in the saved object index.\n" + ], "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 19 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 16 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.debug", - "type": "Function", + "id": "def-server.SavedObjectsRawDoc._id", + "type": "string", "tags": [], - "label": "debug", + "label": "_id", "description": [], - "signature": [ - "(msg: string) => void" - ], "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 20 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 17 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.info", - "type": "Function", + "id": "def-server.SavedObjectsRawDoc._source", + "type": "Object", "tags": [], - "label": "info", + "label": "_source", "description": [], "signature": [ - "(msg: string) => void" + "SavedObjectsRawDocSource" ], "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 21 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 18 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.warning", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "warning", + "id": "def-server.SavedObjectsRawDoc._seq_no", + "type": "number", + "tags": [], + "label": "_seq_no", "description": [], "signature": [ - "(msg: string) => void" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 25 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 19 }, - "deprecated": true, - "references": [ - { - "plugin": "dashboard", - "link": { - "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts", - "lineNumber": 29 - } - }, - { - "plugin": "dashboard", - "link": { - "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts", - "lineNumber": 56 - } - }, - { - "plugin": "lens", - "link": { - "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts", - "lineNumber": 167 - } - }, - { - "plugin": "lens", - "link": { - "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts", - "lineNumber": 234 - } - } - ] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.warn", - "type": "Function", + "id": "def-server.SavedObjectsRawDoc._primary_term", + "type": "number", "tags": [], - "label": "warn", + "label": "_primary_term", "description": [], "signature": [ - "(msg: string) => void" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 26 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 20 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRawDocParseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRawDocParseOptions", + "description": [ + "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 78 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.error", - "type": "Function", + "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", + "type": "CompoundType", "tags": [], - "label": "error", - "description": [], + "label": "namespaceTreatment", + "description": [ + "\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`." + ], "signature": [ - "(msg: string, meta: Meta) => void" + "\"strict\" | \"lax\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 27 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 86 }, "deprecated": false } @@ -12928,18 +14885,20 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions", + "id": "def-server.SavedObjectsRemoveReferencesToOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsOpenPointInTimeOptions", - "description": [], + "label": "SavedObjectsRemoveReferencesToOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" }, " extends ", { @@ -12952,43 +14911,25 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 326 + "lineNumber": 230 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", - "type": "string", - "tags": [], - "label": "keepAlive", - "description": [ - "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 330 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", - "type": "string", + "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "preference", + "label": "refresh", "description": [ - "\nAn optional ES preference value to be used for the query." + "The Elasticsearch Refresh setting for this operation. Defaults to `true`" ], "signature": [ - "string | undefined" + "boolean | undefined" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 334 + "lineNumber": 232 }, "deprecated": false } @@ -12997,29 +14938,48 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeResponse", + "id": "def-server.SavedObjectsRemoveReferencesToResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsOpenPointInTimeResponse", - "description": [], + "label": "SavedObjectsRemoveReferencesToResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 340 + "lineNumber": 239 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", - "type": "string", + "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", + "type": "number", "tags": [], - "label": "id", + "label": "updated", "description": [ - "\nPIT ID returned from ES." + "The number of objects that have been updated by this operation" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 344 + "lineNumber": 241 }, "deprecated": false } @@ -13028,158 +14988,235 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams", + "id": "def-server.SavedObjectsRepositoryFactory", "type": "Interface", "tags": [], - "label": "SavedObjectsPitParams", - "description": [], + "label": "SavedObjectsRepositoryFactory", + "description": [ + "\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n" + ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 69 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 226 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams.id", - "type": "string", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", + "type": "Function", "tags": [], - "label": "id", - "description": [], + "label": "createScopedRepository", + "description": [ + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" + ], + "signature": [ + "(req: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 70 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 234 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.req", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 235 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.includedHiddenTypes", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [ + "- A list of additional hidden types the repository should have access to." + ], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 236 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams.keepAlive", - "type": "string", + "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", + "type": "Function", "tags": [], - "label": "keepAlive", - "description": [], + "label": "createInternalRepository", + "description": [ + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" + ], "signature": [ - "string | undefined" + "(includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 71 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 244 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.includedHiddenTypes", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [ + "- A list of additional hidden types the repository should have access to." + ], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 244 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc", + "id": "def-server.SavedObjectsResolveImportErrorsOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsRawDoc", + "label": "SavedObjectsResolveImportErrorsOptions", "description": [ - "\nA raw document as represented directly in the saved object index.\n" + "\nOptions to control the \"resolve import\" operation." ], "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 16 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 168 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._id", - "type": "string", - "tags": [], - "label": "_id", - "description": [], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 17 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._source", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", "type": "Object", "tags": [], - "label": "_source", - "description": [], + "label": "readStream", + "description": [ + "The stream of {@link SavedObject | saved objects} to resolve errors from" + ], "signature": [ - "SavedObjectsRawDocSource" + "Readable" ], "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 18 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 170 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._seq_no", - "type": "number", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", + "type": "Array", "tags": [], - "label": "_seq_no", - "description": [], + "label": "retries", + "description": [ + "saved object import references to retry" + ], "signature": [ - "number | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportRetry", + "text": "SavedObjectsImportRetry" + }, + "[]" ], "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 19 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 172 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._primary_term", - "type": "number", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", + "type": "string", "tags": [], - "label": "_primary_term", - "description": [], + "label": "namespace", + "description": [ + "if specified, will import in given namespace" + ], "signature": [ - "number | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 20 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 174 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDocParseOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRawDocParseOptions", - "description": [ - "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" - ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 78 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", - "type": "CompoundType", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", + "type": "boolean", "tags": [], - "label": "namespaceTreatment", - "description": [ - "\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`." - ], - "signature": [ - "\"strict\" | \"lax\" | undefined" + "label": "createNewCopies", + "description": [ + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." ], "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 86 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 176 }, "deprecated": false } @@ -13188,10 +15225,10 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToOptions", + "id": "def-server.SavedObjectsResolveResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsRemoveReferencesToOptions", + "label": "SavedObjectsResolveResponse", "description": [ "\n" ], @@ -13200,39 +15237,67 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 230 + "lineNumber": 305 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", + "id": "def-server.SavedObjectsResolveResponse.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 306 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsResolveResponse.outcome", "type": "CompoundType", "tags": [], - "label": "refresh", + "label": "outcome", "description": [ - "The Elasticsearch Refresh setting for this operation. Defaults to `true`" + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." ], "signature": [ - "boolean | undefined" + "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 232 + "lineNumber": 316 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsResolveResponse.aliasTargetId", + "type": "string", + "tags": [], + "label": "aliasTargetId", + "description": [ + "\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`." + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 320 }, "deprecated": false } @@ -13241,77 +15306,243 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToResponse", + "id": "def-server.SavedObjectsServiceSetup", "type": "Interface", "tags": [], - "label": "SavedObjectsRemoveReferencesToResponse", + "label": "SavedObjectsServiceSetup", "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 239 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 85 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", - "type": "number", + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", + "type": "Function", "tags": [], - "label": "updated", + "label": "setClientFactoryProvider", "description": [ - "The number of objects that have been updated by this operation" + "\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail." + ], + "signature": [ + "(clientFactoryProvider: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" + }, + ") => void" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 241 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 90 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.clientFactoryProvider", + "type": "Function", + "tags": [], + "label": "clientFactoryProvider", + "description": [], + "signature": [ + "(repositoryFactory: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepositoryFactory", + "text": "SavedObjectsRepositoryFactory" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientFactory", + "text": "SavedObjectsClientFactory" + } + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 90 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", + "type": "Function", + "tags": [], + "label": "addClientWrapper", + "description": [ + "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." + ], + "signature": [ + "(priority: number, id: string, factory: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" + }, + ") => void" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 95 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.priority", + "type": "number", + "tags": [], + "label": "priority", + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 96 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 97 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.factory", + "type": "Function", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperOptions", + "text": "SavedObjectsClientWrapperOptions" + }, + ") => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 98 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceSetup.registerType", + "type": "Function", + "tags": [], + "label": "registerType", + "description": [ + "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" + ], + "signature": [ + "(type: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + ") => void" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 144 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.type", + "type": "Object", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + } + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 144 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory", + "id": "def-server.SavedObjectsServiceStart", "type": "Interface", "tags": [], - "label": "SavedObjectsRepositoryFactory", + "label": "SavedObjectsServiceStart", "description": [ - "\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n" + "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n" ], "source": { "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 226 + "lineNumber": 162 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", + "id": "def-server.SavedObjectsServiceStart.getScopedClient", "type": "Function", "tags": [], - "label": "createScopedRepository", + "label": "getScopedClient", "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" + "\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}." ], "signature": [ "(req: ", @@ -13322,33 +15553,98 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", includedHiddenTypes?: string[] | undefined) => Pick<", + ", options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRepository", - "text": "SavedObjectsRepository" + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "source": { "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 234 + "lineNumber": 172 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.req", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 173 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 174 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository", "type": "Function", "tags": [], - "label": "createInternalRepository", + "label": "createScopedRepository", "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" ], "signature": [ - "(includedHiddenTypes?: string[] | undefined) => Pick<", + "(req: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", includedHiddenTypes?: string[] | undefined) => Pick<", { "pluginId": "core", "scope": "server", @@ -13360,493 +15656,835 @@ ], "source": { "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 244 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsResolveImportErrorsOptions", - "description": [ - "\nOptions to control the \"resolve import\" operation." - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 168 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", - "type": "Object", - "tags": [], - "label": "readStream", - "description": [ - "The stream of {@link SavedObject | saved objects} to resolve errors from" - ], - "signature": [ - "Readable" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 170 + "lineNumber": 188 }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", - "type": "Array", - "tags": [], - "label": "retries", - "description": [ - "saved object import references to retry" - ], - "signature": [ + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportRetry", - "text": "SavedObjectsImportRetry" - }, - "[]" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 172 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "if specified, will import in given namespace" - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 174 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", - "type": "boolean", - "tags": [], - "label": "createNewCopies", - "description": [ - "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 176 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsResolveResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - "" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 305 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.saved_object", - "type": "Object", - "tags": [], - "label": "saved_object", - "description": [], - "signature": [ - "SavedObject", - "" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 306 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.outcome", - "type": "CompoundType", - "tags": [], - "label": "outcome", - "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." - ], - "signature": [ - "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 316 - }, - "deprecated": false + "parentPluginId": "core", + "id": "def-server.req", + "type": "Object", + "tags": [], + "label": "req", + "description": [ + "- The request to create the scoped repository from." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 189 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.includedHiddenTypes", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [ + "- A list of additional hidden types the repository should have access to." + ], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 190 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.aliasTargetId", - "type": "string", + "id": "def-server.SavedObjectsServiceStart.createInternalRepository", + "type": "Function", "tags": [], - "label": "aliasTargetId", + "label": "createInternalRepository", "description": [ - "\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`." + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" ], "signature": [ - "string | undefined" + "(includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 320 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 198 }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup", - "type": "Interface", - "tags": [], - "label": "SavedObjectsServiceSetup", - "description": [ - "\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 85 - }, - "deprecated": false, - "children": [ + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.includedHiddenTypes", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [ + "- A list of additional hidden types the repository should have access to." + ], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 198 + }, + "deprecated": false + } + ] + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", + "id": "def-server.SavedObjectsServiceStart.createSerializer", "type": "Function", "tags": [], - "label": "setClientFactoryProvider", + "label": "createSerializer", "description": [ - "\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail." + "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." ], "signature": [ - "(clientFactoryProvider: ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientFactoryProvider", - "text": "SavedObjectsClientFactoryProvider" - }, - ") => void" + "section": "def-server.SavedObjectsSerializer", + "text": "SavedObjectsSerializer" + } ], "source": { "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 90 + "lineNumber": 202 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", + "id": "def-server.SavedObjectsServiceStart.createExporter", "type": "Function", "tags": [], - "label": "addClientWrapper", + "label": "createExporter", "description": [ - "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." + "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." ], "signature": [ - "(priority: number, id: string, factory: ", + "(client: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientWrapperFactory", - "text": "SavedObjectsClientWrapperFactory" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - ") => void" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExporter", + "text": "SavedObjectsExporter" + }, + ", \"exportByTypes\" | \"exportByObjects\">" ], "source": { "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 95 + "lineNumber": 206 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 206 + }, + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.registerType", - "type": "Function", - "tags": [], - "label": "registerType", - "description": [ - "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" - ], - "signature": [ - "(type: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - ") => void" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 144 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart", - "type": "Interface", - "tags": [], - "label": "SavedObjectsServiceStart", - "description": [ - "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 162 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.getScopedClient", + "id": "def-server.SavedObjectsServiceStart.createImporter", "type": "Function", "tags": [], - "label": "getScopedClient", + "label": "createImporter", "description": [ - "\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}." + "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." ], "signature": [ - "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" - }, - " | undefined) => Pick<", + "(client: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 172 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createScopedRepository", - "type": "Function", - "tags": [], - "label": "createScopedRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" - ], - "signature": [ - "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", includedHiddenTypes?: string[] | undefined) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRepository", - "text": "SavedObjectsRepository" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 188 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createInternalRepository", - "type": "Function", - "tags": [], - "label": "createInternalRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" - ], - "signature": [ - "(includedHiddenTypes?: string[] | undefined) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRepository", - "text": "SavedObjectsRepository" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 198 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createSerializer", - "type": "Function", - "tags": [], - "label": "createSerializer", - "description": [ - "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." - ], - "signature": [ - "() => ", + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsSerializer", - "text": "SavedObjectsSerializer" + "section": "def-server.SavedObjectsImporter", + "text": "SavedObjectsImporter" + }, + ", \"import\" | \"resolveImportErrors\">" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 210 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 210 + }, + "deprecated": false } - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 202 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createExporter", - "type": "Function", - "tags": [], - "label": "createExporter", - "description": [ - "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." - ], - "signature": [ - "(client: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExporter", - "text": "SavedObjectsExporter" - }, - ", \"exportByTypes\" | \"exportByObjects\">" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 206 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createImporter", - "type": "Function", - "tags": [], - "label": "createImporter", - "description": [ - "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." - ], - "signature": [ - "(client: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImporter", - "text": "SavedObjectsImporter" - }, - ", \"import\" | \"resolveImportErrors\">" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 210 - }, - "deprecated": false + ] }, { "parentPluginId": "core", @@ -13872,7 +16510,9 @@ "path": "src/core/server/saved_objects/saved_objects_service.ts", "lineNumber": 215 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -13964,13 +16604,7 @@ "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsNamespaceType", - "text": "SavedObjectsNamespaceType" - } + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" ], "source": { "path": "src/core/server/saved_objects/types.ts", @@ -14548,283 +17182,633 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces", - "type": "Array", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces", + "type": "Array", + "tags": [], + "label": "spaces", + "description": [ + "The space(s) that the referenced object exists in" + ], + "signature": [ + "string[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 83 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [ + "Included if there was an error updating this object's spaces" + ], + "signature": [ + "SavedObjectError", + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 85 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 215 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 217 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 219 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 221 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", + "tags": [], + "label": "upsert", + "description": [ + "If specified, will be used to perform an upsert if the document doesn't exist" + ], + "signature": [ + "Attributes | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 223 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + " extends Pick<", + "SavedObject", + ", \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 295 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateResponse.attributes", + "type": "Object", "tags": [], - "label": "spaces", - "description": [ - "The space(s) that the referenced object exists in" - ], + "label": "attributes", + "description": [], "signature": [ - "string[]" + "{ [P in keyof T]?: T[P] | undefined; }" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 83 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 297 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error", - "type": "Object", + "id": "def-server.SavedObjectsUpdateResponse.references", + "type": "Array", "tags": [], - "label": "error", - "description": [ - "Included if there was an error updating this object's spaces" - ], + "label": "references", + "description": [], "signature": [ - "SavedObjectError", - " | undefined" + "SavedObjectReference", + "[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 85 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 298 }, "deprecated": false } ], "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsExporter", + "type": "Type", + "tags": [], + "label": "ISavedObjectsExporter", + "description": [], + "signature": [ + "{ exportByTypes: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + }, + ") => Promise<", + "Readable", + ">; exportByObjects: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + }, + ") => Promise<", + "Readable", + ">; }" + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 30 + }, + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions", - "type": "Interface", + "id": "def-server.ISavedObjectsImporter", + "type": "Type", "tags": [], - "label": "SavedObjectsUpdateOptions", + "label": "ISavedObjectsImporter", + "description": [], + "signature": [ + "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">; }" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository", + "type": "Type", + "tags": [], + "label": "ISavedObjectsRepository", "description": [ - "\n" + "\nSee {@link SavedObjectsRepository}\n" ], "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => 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" + }, + ") => 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" + }, + ">; deleteByNamespace: (namespace: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + ") => 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" + }, + ">; 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.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" }, - " extends ", + ">; updateObjectsSpaces: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 215 - }, - "deprecated": false, - "children": [ + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 217 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" }, + " | undefined) => Promise<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 219 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" }, + ">; bulkUpdate: (objects: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - "boolean | \"wait_for\" | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 221 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" }, + "[], options?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.upsert", - "type": "Uncategorized", - "tags": [], - "label": "upsert", - "description": [ - "If specified, will be used to perform an upsert if the document doesn't exist" - ], - "signature": [ - "Attributes | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 223 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateResponse", - "description": [ - "\n" - ], - "signature": [ + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" }, - " extends Pick<", + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; incrementCounter: (type: string, id: string, counterFields: (string | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + ") => Promise<", "SavedObject", - ", \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 295 - }, - "deprecated": false, - "children": [ + ">; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse.attributes", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Partial" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 297 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" }, + ") => Promise<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 298 - }, - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter", - "type": "Type", - "tags": [], - "label": "ISavedObjectsExporter", - "description": [], - "signature": [ - "{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<", - "Readable", - ">; exportByObjects: (options: SavedObjectsExportByObjectOptions) => Promise<", - "Readable", - ">; }" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 30 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter", - "type": "Type", - "tags": [], - "label": "ISavedObjectsImporter", - "description": [], - "signature": [ - "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }" - ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 24 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsRepository", - "type": "Type", - "tags": [], - "label": "ISavedObjectsRepository", - "description": [ - "\nSee {@link SavedObjectsRepository}\n" - ], - "signature": [ - "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; bulkCreate: (objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsCreateOptions) => Promise>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise; find: (options: SavedObjectsFindOptions) => Promise>; bulkGet: (objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise>; resolve: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; update: (type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions) => Promise>; collectMultiNamespaceReferences: (objects: SavedObjectsCollectMultiNamespaceReferencesObject[], options?: SavedObjectsCollectMultiNamespaceReferencesOptions | undefined) => 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.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" }, - ">; updateObjectsSpaces: (objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], spacesToRemove: string[], options?: SavedObjectsUpdateObjectsSpacesOptions | undefined) => Promise<", + ">; createPointInTimeFinder: (findOptions: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" }, - ">; bulkUpdate: (objects: SavedObjectsBulkUpdateObject[], options?: SavedObjectsBulkUpdateOptions) => Promise>; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise; incrementCounter: (type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise>; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise; createPointInTimeFinder: (findOptions: Pick, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies | undefined) => ISavedObjectsPointInTimeFinder; }" + "; }" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", @@ -14843,7 +17827,39 @@ "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" ], "signature": [ - "{ getType: (type: string) => SavedObjectsType | undefined; getVisibleTypes: () => SavedObjectsType[]; getAllTypes: () => SavedObjectsType[]; getImportableAndExportableTypes: () => SavedObjectsType[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" + "{ getType: (type: string) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + " | undefined; getVisibleTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getAllTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getImportableAndExportableTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" ], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", @@ -14862,7 +17878,7 @@ "\nElasticsearch Refresh setting for mutating operation" ], "signature": [ - "false | true | \"wait_for\"" + "boolean | \"wait_for\"" ], "source": { "path": "src/core/server/saved_objects/types.ts", @@ -14943,7 +17959,17 @@ "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistance and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n" ], "signature": [ - "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", @@ -14951,7 +17977,7 @@ "section": "def-server.SavedObjectsDeleteOptions", "text": "SavedObjectsDeleteOptions" }, - ") => Promise<{}>; create: (type: string, attributes: T, options?: ", + ") => Promise<{}>; create: (type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "server", @@ -14959,7 +17985,9 @@ "section": "def-server.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, - " | undefined) => Promise>; bulkCreate: (objects: ", + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", { "pluginId": "core", "scope": "server", @@ -14982,7 +18010,256 @@ "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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" ], "source": { "path": "src/core/server/saved_objects/types.ts", @@ -15001,7 +18278,7 @@ "\nDescribes the factory used to create instances of the Saved Objects Client." ], "signature": [ - "(__0: { request: ", + "({ request, includedHiddenTypes, }: { request: ", { "pluginId": "core", "scope": "server", @@ -15103,7 +18380,13 @@ "label": "SavedObjectsClosePointInTimeOptions", "description": [], "signature": [ - "SavedObjectsBaseOptions" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", @@ -15120,7 +18403,9 @@ "label": "SavedObjectsCreatePointInTimeFinderOptions", "description": [], "signature": [ - "{ type: string | string[]; filter?: any; aggs?: Record | undefined; fields?: string[] | undefined; preference?: string | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; search?: string | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", + "{ type: string | string[]; filter?: any; aggs?: Record | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; search?: string | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", { "pluginId": "core", "scope": "server", @@ -15136,7 +18421,7 @@ "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, - "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; }" + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; }" ], "source": { "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", @@ -15155,7 +18440,7 @@ "\nTransformation function used to mutate the exported objects of the associated type.\n\nA type's export transform function will be executed once per user-initiated export,\nfor all objects of that type.\n" ], "signature": [ - "(context: ", + "(context: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json index cbef00025320bc..821d298ea1309e 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -42,11 +42,12 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" - } + }, + ">" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 105 + "lineNumber": 87 }, "deprecated": false, "children": [ @@ -62,31 +63,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 106 - }, - "deprecated": false - }, - { - "parentPluginId": "dashboard", - "id": "def-public.DashboardContainer.switchViewMode", - "type": "Function", - "tags": [], - "label": "switchViewMode", - "description": [], - "signature": [ - "((newViewMode: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.ViewMode", - "text": "ViewMode" - }, - ") => void) | undefined" - ], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 107 + "lineNumber": 88 }, "deprecated": false }, @@ -102,7 +79,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 109 + "lineNumber": 90 }, "deprecated": false, "children": [], @@ -120,7 +97,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 113 + "lineNumber": 94 }, "deprecated": false, "children": [ @@ -142,7 +119,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 114 + "lineNumber": 95 }, "deprecated": false, "isRequired": true @@ -159,7 +136,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 115 + "lineNumber": 96 }, "deprecated": false, "isRequired": true @@ -199,7 +176,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 116 + "lineNumber": 97 }, "deprecated": false, "isRequired": false @@ -242,11 +219,12 @@ ", partial?: Partial) => ", - "DashboardPanelState" + "DashboardPanelState", + "" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 129 + "lineNumber": 110 }, "deprecated": false, "children": [ @@ -271,7 +249,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 133 + "lineNumber": 114 }, "deprecated": false, "isRequired": true @@ -288,7 +266,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 134 + "lineNumber": 115 }, "deprecated": false, "isRequired": true @@ -320,7 +298,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 140 + "lineNumber": 122 }, "deprecated": false, "children": [ @@ -344,7 +322,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 141 + "lineNumber": 123 }, "deprecated": false, "isRequired": true @@ -362,7 +340,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 142 + "lineNumber": 124 }, "deprecated": false, "isRequired": false @@ -379,7 +357,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 143 + "lineNumber": 125 }, "deprecated": false, "isRequired": false @@ -417,7 +395,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 181 + "lineNumber": 164 }, "deprecated": false, "children": [ @@ -442,7 +420,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 182 + "lineNumber": 165 }, "deprecated": false, "isRequired": true @@ -467,7 +445,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 183 + "lineNumber": 166 }, "deprecated": false, "isRequired": true @@ -484,7 +462,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 184 + "lineNumber": 167 }, "deprecated": false, "isRequired": false @@ -539,11 +517,28 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(type: string, explicitInput: Partial, embeddableId?: string | undefined) => Promise" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 228 + "lineNumber": 211 }, "deprecated": false, "children": [ @@ -559,7 +554,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 232 + "lineNumber": 215 }, "deprecated": false, "isRequired": true @@ -576,7 +571,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 232 + "lineNumber": 215 }, "deprecated": false, "isRequired": true @@ -593,7 +588,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 232 + "lineNumber": 215 }, "deprecated": false, "isRequired": false @@ -613,7 +608,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 246 + "lineNumber": 229 }, "deprecated": false, "children": [ @@ -629,7 +624,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 246 + "lineNumber": 229 }, "deprecated": false, "isRequired": true @@ -650,7 +645,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 259 + "lineNumber": 242 }, "deprecated": false, "children": [ @@ -666,7 +661,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 259 + "lineNumber": 242 }, "deprecated": false, "isRequired": true @@ -723,11 +718,14 @@ "docId": "kibDashboardPluginApi", "section": "def-public.DashboardContainer", "text": "DashboardContainer" - } + }, + ", ", + "SavedObjectAttributes", + ">" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 34 + "lineNumber": 32 }, "deprecated": false, "children": [ @@ -743,7 +741,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 37 + "lineNumber": 35 }, "deprecated": false }, @@ -759,7 +757,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 38 + "lineNumber": 36 }, "deprecated": false }, @@ -775,7 +773,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 40 + "lineNumber": 38 }, "deprecated": false, "children": [ @@ -793,7 +791,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 41 + "lineNumber": 39 }, "deprecated": false, "isRequired": true @@ -816,7 +814,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 42 + "lineNumber": 40 }, "deprecated": false, "isRequired": true @@ -836,7 +834,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 45 + "lineNumber": 43 }, "deprecated": false, "children": [], @@ -850,11 +848,11 @@ "label": "getDisplayName", "description": [], "signature": [ - "() => any" + "() => string" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 50 + "lineNumber": 48 }, "deprecated": false, "children": [], @@ -880,7 +878,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 56 + "lineNumber": 54 }, "deprecated": false, "children": [], @@ -933,11 +931,20 @@ "docId": "kibDashboardPluginApi", "section": "def-public.DashboardContainer", "text": "DashboardContainer" - } + }, + " | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + ">" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 66 + "lineNumber": 64 }, "deprecated": false, "children": [ @@ -959,7 +966,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 67 + "lineNumber": 65 }, "deprecated": false, "isRequired": true @@ -999,7 +1006,7 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 68 + "lineNumber": 66 }, "deprecated": false, "isRequired": false @@ -1036,9 +1043,45 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 74 + "lineNumber": 72 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dashboard", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "src/plugins/kibana_utils/common/persistable_state/index.ts", + "lineNumber": 40 + }, + "deprecated": false + }, + { + "parentPluginId": "dashboard", + "id": "def-public.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "source": { + "path": "src/plugins/kibana_utils/common/persistable_state/index.ts", + "lineNumber": 40 + }, + "deprecated": false + } + ] }, { "parentPluginId": "dashboard", @@ -1070,9 +1113,28 @@ ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 76 + "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dashboard", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "src/plugins/kibana_utils/common/persistable_state/index.ts", + "lineNumber": 46 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -1091,7 +1153,7 @@ ], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", - "lineNumber": 22 + "lineNumber": 24 }, "deprecated": false, "children": [ @@ -1107,7 +1169,7 @@ ], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", - "lineNumber": 22 + "lineNumber": 24 }, "deprecated": false, "isRequired": false @@ -1124,7 +1186,7 @@ ], "source": { "path": "src/plugins/dashboard/public/dashboard_constants.ts", - "lineNumber": 22 + "lineNumber": 24 }, "deprecated": false, "isRequired": false @@ -1222,8 +1284,8 @@ "<{}>" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 43 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 72 }, "deprecated": false, "children": [ @@ -1239,8 +1301,8 @@ " | undefined" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 44 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 73 }, "deprecated": false }, @@ -1262,8 +1324,8 @@ " | undefined" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 45 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 74 }, "deprecated": false }, @@ -1278,8 +1340,8 @@ "boolean | undefined" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 46 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 75 }, "deprecated": false }, @@ -1291,8 +1353,8 @@ "label": "isFullScreenMode", "description": [], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 47 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 76 }, "deprecated": false }, @@ -1307,8 +1369,8 @@ "string | undefined" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 48 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 77 }, "deprecated": false }, @@ -1320,17 +1382,11 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 49 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 78 }, "deprecated": false }, @@ -1345,8 +1401,8 @@ "string | undefined" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 50 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 79 }, "deprecated": false }, @@ -1358,8 +1414,8 @@ "label": "useMargins", "description": [], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 51 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 80 }, "deprecated": false }, @@ -1374,8 +1430,8 @@ "boolean | undefined" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 52 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 81 }, "deprecated": false }, @@ -1396,8 +1452,8 @@ } ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 53 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 82 }, "deprecated": false }, @@ -1419,8 +1475,8 @@ "[]" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 54 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 83 }, "deprecated": false }, @@ -1432,8 +1488,8 @@ "label": "title", "description": [], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 55 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 84 }, "deprecated": false }, @@ -1445,17 +1501,11 @@ "label": "query", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - } + "{ query: string | { [key: string]: any; }; language: string; }" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 56 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 85 }, "deprecated": false }, @@ -1480,8 +1530,8 @@ " & { [k: string]: unknown; }>; }" ], "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "lineNumber": 57 + "path": "src/plugins/dashboard/public/types.ts", + "lineNumber": 86 }, "deprecated": false } @@ -1543,7 +1593,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 18 + "lineNumber": 19 }, "deprecated": false, "children": [ @@ -1559,7 +1609,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 19 + "lineNumber": 20 }, "deprecated": false }, @@ -1572,7 +1622,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 20 + "lineNumber": 21 }, "deprecated": false }, @@ -1588,7 +1638,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 21 + "lineNumber": 22 }, "deprecated": false }, @@ -1604,7 +1654,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 22 + "lineNumber": 23 }, "deprecated": false }, @@ -1620,7 +1670,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 23 + "lineNumber": 24 }, "deprecated": false }, @@ -1633,7 +1683,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 24 + "lineNumber": 25 }, "deprecated": false }, @@ -1649,7 +1699,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 25 + "lineNumber": 26 }, "deprecated": false }, @@ -1665,7 +1715,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 27 + "lineNumber": 28 }, "deprecated": false }, @@ -1678,7 +1728,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 28 + "lineNumber": 29 }, "deprecated": false }, @@ -1701,7 +1751,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 29 + "lineNumber": 30 }, "deprecated": false }, @@ -1713,7 +1763,157 @@ "label": "searchSource", "description": [], "signature": [ - "Pick<", + "{ create: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; removeField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setFields: (newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getId: () => string; getFields: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; getField: (field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; getOwnField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; createCopy: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; createChild: (options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setParent: (parent?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getParent: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | undefined; fetch$: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">>; fetch: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise<", + "SearchResponse", + ">; onRequestStart: (handler: (searchSource: ", { "pluginId": "data", "scope": "common", @@ -1721,11 +1921,29 @@ "section": "def-common.SearchSource", "text": "SearchSource" }, - ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; serialize: () => { searchSourceJSON: string; references: ", + "SavedObjectReference", + "[]; }; }" ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 30 + "lineNumber": 31 }, "deprecated": false }, @@ -1748,7 +1966,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 31 + "lineNumber": 32 }, "deprecated": false, "children": [], @@ -1774,7 +1992,7 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 32 + "lineNumber": 33 }, "deprecated": false, "children": [], @@ -1792,9 +2010,28 @@ ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "lineNumber": 33 + "lineNumber": 34 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dashboard", + "id": "def-public.editMode", + "type": "CompoundType", + "tags": [], + "label": "editMode", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2100,7 +2337,14 @@ "label": "DashboardUrlGenerator", "description": [], "signature": [ - "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorContract", + "text": "UrlGeneratorContract" + }, + "<\"DASHBOARD_APP_URL_GENERATOR\">" ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", @@ -2119,7 +2363,15 @@ "\nThis should always represent the latest dashboard panel shape, after all possible migrations." ], "signature": [ - "Pick & { readonly id?: string | undefined; readonly type: string; }" + "Pick<", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanel730ToLatest", + "text": "RawSavedDashboardPanel730ToLatest" + }, + ", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", @@ -2246,6 +2498,32 @@ "lineNumber": 19 }, "deprecated": false + }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardConstants.CHANGE_CHECK_DEBOUNCE", + "type": "number", + "tags": [], + "label": "CHANGE_CHECK_DEBOUNCE", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardConstants.CHANGE_APPLY_DEBOUNCE", + "type": "number", + "tags": [], + "label": "CHANGE_APPLY_DEBOUNCE", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 21 + }, + "deprecated": false } ], "initialIsOpen": false @@ -2303,7 +2581,9 @@ "path": "src/plugins/dashboard/public/plugin.tsx", "lineNumber": 127 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "dashboard", @@ -2319,7 +2599,9 @@ "path": "src/plugins/dashboard/public/plugin.tsx", "lineNumber": 128 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "dashboard", @@ -2508,7 +2790,40 @@ "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanelTo60", "text": "SavedDashboardPanelTo60" - } + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel610", + "text": "SavedDashboardPanel610" + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel620", + "text": "SavedDashboardPanel620" + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel630", + "text": "SavedDashboardPanel630" + }, + ")[], version: string, useMargins: boolean, uiState: { [key: string]: { [key: string]: unknown; }; } | undefined) => ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanel730ToLatest", + "text": "RawSavedDashboardPanel730ToLatest" + }, + "[]" ], "source": { "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", @@ -2539,7 +2854,32 @@ "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanelTo60", "text": "SavedDashboardPanelTo60" - } + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel610", + "text": "SavedDashboardPanel610" + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel620", + "text": "SavedDashboardPanel620" + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel630", + "text": "SavedDashboardPanel630" + }, + ")[]" ], "source": { "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", @@ -2821,7 +3161,9 @@ "label": "RawSavedDashboardPanel730ToLatest", "description": [], "signature": [ - "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }" + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }" ], "source": { "path": "src/plugins/dashboard/common/bwc/types.ts", @@ -2838,7 +3180,9 @@ "label": "SavedDashboardPanel610", "description": [], "signature": [ - "Pick & { readonly id: string; readonly type: string; }" + "Pick<", + "RawSavedDashboardPanel610", + ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", @@ -2855,7 +3199,9 @@ "label": "SavedDashboardPanel620", "description": [], "signature": [ - "Pick & { readonly id: string; readonly type: string; }" + "Pick<", + "RawSavedDashboardPanel620", + ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", @@ -2872,7 +3218,9 @@ "label": "SavedDashboardPanel630", "description": [], "signature": [ - "Pick & { readonly id: string; readonly type: string; }" + "Pick<", + "RawSavedDashboardPanel620", + ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", @@ -2889,7 +3237,9 @@ "label": "SavedDashboardPanel640To720", "description": [], "signature": [ - "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", @@ -2906,7 +3256,15 @@ "label": "SavedDashboardPanel730ToLatest", "description": [], "signature": [ - "Pick & { readonly id?: string | undefined; readonly type: string; }" + "Pick<", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanel730ToLatest", + "text": "RawSavedDashboardPanel730ToLatest" + }, + ", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", @@ -2923,7 +3281,9 @@ "label": "SavedDashboardPanelTo60", "description": [], "signature": [ - "Pick & { readonly id: string; readonly type: string; }" + "Pick<", + "RawSavedDashboardPanelTo60", + ", \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json index 087fc838bb959e..b1ce19250a597d 100644 --- a/api_docs/dashboard_enhanced.json +++ b/api_docs/dashboard_enhanced.json @@ -118,7 +118,9 @@ "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 40 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "dashboardEnhanced", @@ -219,7 +221,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "() => any" + "() => string" ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", @@ -253,12 +255,13 @@ "label": "CollectConfig", "description": [], "signature": [ + "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.UiComponent", - "text": "UiComponent" + "section": "def-common.UiComponentInstance", + "text": "UiComponentInstance" }, "<", { @@ -290,7 +293,9 @@ "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 54 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "dashboardEnhanced", @@ -510,12 +515,13 @@ "description": [], "signature": [ { - "pluginId": "dashboard", + "pluginId": "share", "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.DashboardUrlGenerator", - "text": "DashboardUrlGenerator" - } + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorContract", + "text": "UrlGeneratorContract" + }, + "<\"DASHBOARD_APP_URL_GENERATOR\">" ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", @@ -550,12 +556,13 @@ "label": "start", "description": [], "signature": [ + "() => ", { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.StartServicesGetter", - "text": "StartServicesGetter" + "section": "def-public.StartServices", + "text": "StartServices" }, "<{ uiActionsEnhanced: ", { @@ -588,13 +595,16 @@ "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" - } + }, + ">" ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -664,13 +674,19 @@ "label": "share", "description": [], "signature": [ + "{ register: (shareMenuProvider: ", { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", - "section": "def-public.SharePluginSetup", - "text": "SharePluginSetup" - } + "section": "def-public.ShareMenuProvider", + "text": "ShareMenuProvider" + }, + ") => void; } & { urlGenerators: ", + "UrlGeneratorsSetup", + "; url: ", + "UrlService", + "; }" ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", @@ -768,13 +784,19 @@ "label": "share", "description": [], "signature": [ + "{ toggleShareContextMenu: (options: ", { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", - "section": "def-public.SharePluginStart", - "text": "SharePluginStart" - } + "section": "def-public.ShowShareMenuOptions", + "text": "ShowShareMenuOptions" + }, + ") => void; } & { urlGenerators: ", + "UrlGeneratorsStart", + "; url: ", + "UrlService", + "; }" ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", diff --git a/api_docs/data.json b/api_docs/data.json index 83e706e9a0f540..75b5a3c98b778d 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -27,15 +27,7 @@ "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" ], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ".ensureIds" + "(list: any[]) => any[]" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -79,7 +71,7 @@ "\nCalculate the next id based on the ids in this list\n" ], "signature": [ - "typeof ", + "(list: ", { "pluginId": "data", "scope": "common", @@ -87,7 +79,7 @@ "section": "def-common.AggConfig", "text": "AggConfig" }, - ".nextId" + "[]) => number" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -1170,9 +1162,34 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -1192,9 +1209,34 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -1690,7 +1732,8 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" - } + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">, { addToAggConfigs }?: { addToAggConfigs?: boolean | undefined; }) => T" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -2556,7 +2599,44 @@ "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.agg", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; schema?: string | undefined; } | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2653,7 +2733,10 @@ "text": "DataPublicPluginStart" }, ", ", - "DataSetupDependencies" + "DataSetupDependencies", + ", ", + "DataStartDependencies", + ">" ], "source": { "path": "src/plugins/data/public/plugin.ts", @@ -3489,15 +3572,10 @@ "label": "from", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ".from" + "(convertFn: ", + "FieldFormatConvertFunction", + ") => ", + "FieldFormatInstanceType" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -3552,15 +3630,14 @@ "label": "isInstanceOfFieldFormat", "description": [], "signature": [ - "typeof ", + "(fieldFormat: any) => fieldFormat is ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FieldFormat", "text": "FieldFormat" - }, - ".isInstanceOfFieldFormat" + } ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -3658,7 +3735,7 @@ "label": "fieldFormatMap", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", @@ -3789,7 +3866,42 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 64 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 64 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -3799,13 +3911,45 @@ "label": "formatField", "description": [], "signature": [ - "FormatFieldFn" + "(hit: Record, fieldName: string) => any" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -3821,7 +3965,42 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.deep", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5716,13 +5895,15 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "EnsureDefaultIndexPattern" + "() => Promise | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -5784,7 +5965,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -5822,7 +6005,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -5925,7 +6110,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -5963,7 +6150,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "optionally clear a single id" + ], "signature": [ "string | undefined" ], @@ -6358,7 +6547,9 @@ "type": "Array", "tags": [], "label": "fields", - "description": [], + "description": [ + ": FieldSpec[]" + ], "signature": [ { "pluginId": "data", @@ -6382,7 +6573,9 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [], + "description": [ + ": FieldAttrs" + ], "signature": [ { "pluginId": "data", @@ -7145,7 +7338,7 @@ "\nsets value to a single search source field" ], "signature": [ - "(field: K, value: ", + "(field: K, value: ", { "pluginId": "data", "scope": "common", @@ -7219,7 +7412,7 @@ "\nremove field" ], "signature": [ - "(field: K) => this" + "(field: K) => this" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", @@ -7362,7 +7555,7 @@ "\nGets a single field from the fields" ], "signature": [ - "(field: K, recurse?: boolean) => ", + "(field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", @@ -7425,7 +7618,7 @@ "\nGet the field from our own fields, don't traverse up the chain" ], "signature": [ - "(field: K) => ", + "(field: K) => ", { "pluginId": "data", "scope": "common", @@ -8312,19 +8505,45 @@ "label": "getConfig", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - } + "(key: string, defaultOverride?: T | undefined) => T" ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 35 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] } ] } @@ -8957,7 +9176,44 @@ "label": "aggFilter", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilter\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"filter\">, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -8973,7 +9229,44 @@ "label": "aggFilters", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilters\", any, Pick, \"enabled\" | \"id\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"schema\" | \"json\" | \"timeShift\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -8989,7 +9282,44 @@ "label": "aggSignificantTerms", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSignificantTerms\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BUCKET_TYPES", + "text": "BUCKET_TYPES" + }, + ".SIGNIFICANT_TERMS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9005,7 +9335,44 @@ "label": "aggIpRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggIpRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ipRangeType\" | \"ranges\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9021,7 +9388,44 @@ "label": "aggDateRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ranges\" | \"time_zone\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9037,7 +9441,44 @@ "label": "aggRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ranges\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9053,7 +9494,44 @@ "label": "aggGeoTile", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoTile\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BUCKET_TYPES", + "text": "BUCKET_TYPES" + }, + ".GEOTILE_GRID>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9069,7 +9547,44 @@ "label": "aggGeoHash", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoHash\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\" | \"boundingBox\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9085,7 +9600,44 @@ "label": "aggHistogram", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, \"extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\" | \"extended_bounds\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9101,7 +9653,44 @@ "label": "aggDateHistogram", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, \"timeRange\" | \"extended_bounds\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"timeRange\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"extended_bounds\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9117,7 +9706,48 @@ "label": "aggTerms", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggTerms\", any, Pick, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\"> & Pick<{ orderAgg?: ", + "AggExpressionType", + " | undefined; }, \"orderAgg\"> & Pick<{ orderAgg?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"orderAgg\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9133,23 +9763,105 @@ "label": "aggAvg", "description": [], "signature": [ - "FunctionDefinition" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 - }, - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggBucketAvg", - "type": "Object", - "tags": [], - "label": "aggBucketAvg", - "description": [], + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggAvg\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".AVG>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggFunctionsMapping.aggBucketAvg", + "type": "Object", + "tags": [], + "label": "aggBucketAvg", + "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9165,7 +9877,52 @@ "label": "aggBucketMax", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketMax\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9181,7 +9938,52 @@ "label": "aggBucketMin", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketMin\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9197,7 +9999,52 @@ "label": "aggBucketSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9213,7 +10060,52 @@ "label": "aggFilteredMetric", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilteredMetric\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9229,7 +10121,44 @@ "label": "aggCardinality", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCardinality\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".CARDINALITY>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9245,7 +10174,44 @@ "label": "aggCount", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCount\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".COUNT>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9261,7 +10227,48 @@ "label": "aggCumulativeSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCumulativeSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9277,7 +10284,48 @@ "label": "aggDerivative", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDerivative\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9293,7 +10341,44 @@ "label": "aggGeoBounds", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoBounds\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".GEO_BOUNDS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9309,7 +10394,44 @@ "label": "aggGeoCentroid", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoCentroid\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".GEO_CENTROID>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9325,7 +10447,44 @@ "label": "aggMax", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMax\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MAX>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9341,7 +10500,44 @@ "label": "aggMedian", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMedian\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MEDIAN>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9357,7 +10553,44 @@ "label": "aggSinglePercentile", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSinglePercentile\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".SINGLE_PERCENTILE>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9373,7 +10606,44 @@ "label": "aggMin", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMin\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MIN>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9389,7 +10659,48 @@ "label": "aggMovingAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMovingAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9405,7 +10716,44 @@ "label": "aggPercentileRanks", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggPercentileRanks\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".PERCENTILE_RANKS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9421,7 +10769,44 @@ "label": "aggPercentiles", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggPercentiles\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".PERCENTILES>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9437,7 +10822,48 @@ "label": "aggSerialDiff", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSerialDiff\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9453,7 +10879,44 @@ "label": "aggStdDeviation", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggStdDeviation\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".STD_DEV>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9469,7 +10932,44 @@ "label": "aggSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSum\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".SUM>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -9485,8 +10985,45 @@ "label": "aggTopHit", "description": [], "signature": [ - "FunctionDefinition" - ], + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggTopHit\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".TOP_HITS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 230 @@ -9714,7 +11251,26 @@ "path": "src/plugins/data/public/types.ts", "lineNumber": 60 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "ValueClickDataContext" + ], + "source": { + "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.ts", + "lineNumber": 121 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -9724,14 +11280,42 @@ "label": "createFiltersFromRangeSelectAction", "description": [], "signature": [ - "typeof ", - "createFiltersFromRangeSelectAction" + "(event: ", + "RangeSelectDataContext", + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]>" ], "source": { "path": "src/plugins/data/public/types.ts", "lineNumber": 61 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.event", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "RangeSelectDataContext" + ], + "source": { + "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -9759,7 +11343,15 @@ "label": "IndexPatternSelect", "description": [], "signature": [ - "React.ComponentType<", + "React.ComponentClass<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.IndexPatternSelectProps", + "text": "IndexPatternSelectProps" + }, + ", any> | React.FunctionComponent<", { "pluginId": "data", "scope": "public", @@ -9783,7 +11375,15 @@ "label": "SearchBar", "description": [], "signature": [ - "React.ComponentType<", + "React.ComponentClass<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.StatefulSearchBarProps", + "text": "StatefulSearchBarProps" + }, + ", any> | React.FunctionComponent<", { "pluginId": "data", "scope": "public", @@ -9836,7 +11436,7 @@ "label": "queryStringOptions", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -9910,7 +11510,7 @@ "label": "params", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -11336,14 +12936,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 6 + "lineNumber": 5 } }, { @@ -11364,14 +12964,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 18 + "lineNumber": 17 } }, { @@ -11448,28 +13048,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 7 + "lineNumber": 6 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 9 + "lineNumber": 8 } }, { @@ -11532,14 +13132,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 10 + "lineNumber": 9 } }, { @@ -12319,6 +13919,20 @@ "lineNumber": 380 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts", + "lineNumber": 2 + } + }, { "plugin": "securitySolution", "link": { @@ -12816,7 +14430,8 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - } + }, + ") | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", @@ -13822,6 +15437,20 @@ "lineNumber": 36 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts", + "lineNumber": 66 + } + }, { "plugin": "infra", "link": { @@ -13864,6 +15493,27 @@ "lineNumber": 12 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts", + "lineNumber": 10 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts", + "lineNumber": 23 + } + }, { "plugin": "infra", "link": { @@ -13896,28 +15546,126 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "lineNumber": 6 + "lineNumber": 5 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts", + "lineNumber": 3 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts", + "lineNumber": 25 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts", + "lineNumber": 55 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts", + "lineNumber": 20 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts", + "lineNumber": 21 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts", + "lineNumber": 3 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts", + "lineNumber": 9 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts", + "lineNumber": 40 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts", + "lineNumber": 10 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts", + "lineNumber": 25 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 12 + "lineNumber": 11 } }, { @@ -14575,7 +16323,7 @@ "plugin": "maps", "link": { "path": "x-pack/plugins/maps/public/embeddable/types.ts", - "lineNumber": 45 + "lineNumber": 44 } }, { @@ -15572,7 +17320,8 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - } + }, + ">" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", @@ -16526,7 +18275,33 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -16552,7 +18327,9 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 35 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -16682,7 +18459,32 @@ "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17105,7 +18907,16 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirectionNumeric", "text": "SortDirectionNumeric" - } + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionFormat", + "text": "SortDirectionFormat" + }, + ">[] | undefined" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -17565,7 +19376,17 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + "{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -17599,7 +19420,22 @@ "label": "AggParam", "description": [], "signature": [ - "BaseParamType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", @@ -17639,11 +19475,59 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, - ") => string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick string | undefined; datatableUtilities: { getIndexPattern: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined>; getAggConfig: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined>; isFilterable: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => boolean; }; createAggConfigs: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", configStates?: Pick & Pick<{ type: string | ", { @@ -17661,7 +19545,17 @@ "section": "def-common.IAggType", "text": "IAggType" }, - "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + "; types: ", + "AggTypesRegistryStart", + "; }" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -17695,7 +19589,14 @@ "label": "CustomFilter", "description": [], "signature": [ - "Filter & { query: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { query: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", @@ -17729,7 +19630,14 @@ "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -17764,23 +19672,14 @@ "label": "EsdslExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"esdsl\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - "> | null, Arguments, Output, ", + "<\"esdsl\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -17797,7 +19696,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/esdsl.ts", @@ -17814,7 +19714,31 @@ "label": "EsQuerySortValue", "description": [], "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" + "{ [x: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionNumeric", + "text": "SortDirectionNumeric" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionFormat", + "text": "SortDirectionFormat" + }, + "; }" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -17831,7 +19755,30 @@ "label": "EsRawResponseExpressionTypeDefinition", "description": [], "signature": [ - "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "<\"es_raw_response\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", @@ -17848,7 +19795,39 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + "{ filters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined; query?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[] | undefined; timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -17865,7 +19844,30 @@ "label": "ExistsFilter", "description": [], "signature": [ - "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; exists?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterExistsProperty", + "text": "FilterExistsProperty" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", @@ -17882,15 +19884,14 @@ "label": "ExpressionFunctionKibana", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ExecutionContextSearch> | null, object, ", + "<\"kibana\", Input, object, ", { "pluginId": "expressions", "scope": "common", @@ -17898,7 +19899,39 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -17915,15 +19948,14 @@ "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + "<\"kibana_context\", Input, Arguments, Promise<", { "pluginId": "expressions", "scope": "common", @@ -17931,7 +19963,39 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", @@ -17948,7 +20012,14 @@ "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -18001,7 +20072,7 @@ "label": "FieldFormatsGetConfigFn", "description": [], "signature": [ - "(key: string, defaultOverride: T | undefined) => T" + "(key: string, defaultOverride?: T | undefined) => T" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -18018,7 +20089,23 @@ "label": "Filter", "description": [], "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -18038,7 +20125,13 @@ "label": "IAggConfig", "description": [], "signature": [ - "AggConfig" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -18055,7 +20148,38 @@ "label": "IAggType", "description": [], "signature": [ - "AggType>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -18072,7 +20196,16 @@ "label": "IEsSearchResponse", "description": [], "signature": [ - "IKibanaSearchResponse>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -18089,7 +20222,13 @@ "label": "IFieldFormat", "description": [], "signature": [ - "FieldFormat" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -18127,7 +20266,176 @@ "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" - } + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" + }, + "; getType: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getTypeWithoutMetaParams: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getDefaultType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + "FieldFormatInstanceType", + " | undefined; getTypeNameByEsTypes: (esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + " | undefined; getDefaultTypeName: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "; getInstance: ((formatId: string, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; getDefaultInstancePlain: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; getDefaultInstanceCacheResolver: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]) => string; getByFieldType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ") => ", + "FieldFormatInstanceType", + "[]; getDefaultInstance: ((fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; parseDefaultTypeMap: (value: any) => void; }" ], "source": { "path": "src/plugins/data/common/field_formats/index.ts", @@ -18144,7 +20452,13 @@ "label": "IFieldParamType", "description": [], "signature": [ - "FieldParamType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldParamType", + "text": "FieldParamType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -18161,7 +20475,22 @@ "label": "IMetricAggType", "description": [], "signature": [ - "MetricAggType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", @@ -18178,7 +20507,14 @@ "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -18213,7 +20549,175 @@ "label": "IndexPatternsContract", "description": [], "signature": [ - "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; find: (search: string, size?: number) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + "{ get: (id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; delete: (indexPatternId: string) => Promise<{}>; create: (spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; find: (search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>; ensureDefaultIndexPattern: ", + "EnsureDefaultIndexPattern", + "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", + "SavedObject", + "<", + "IndexPatternSavedObjectAttrs", + ">[] | null | undefined>; getDefault: () => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; getFieldsForWildcard: (options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise; getFieldsForIndexPattern: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise; refreshFields: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise; fieldArrayToMap: (fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record; savedObjectToSpec: (savedObject: ", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + "; createAndSave: (spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; createSavedObject: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; updateSavedObject: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", @@ -18230,7 +20734,39 @@ "label": "ISearchGeneric", "description": [], "signature": [ - "(request: SearchStrategyRequest, options: ", + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", SearchStrategyResponse extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", @@ -18259,12 +20795,132 @@ "\nsearch source interface" ], "signature": [ - "{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ", + "{ create: () => ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.ISearchOptions", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; removeField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setFields: (newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getId: () => string; getFields: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; getField: (field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; getOwnField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; createCopy: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; createChild: (options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setParent: (parent?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getParent: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | undefined; fetch$: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", @@ -18272,9 +20928,9 @@ "<", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.IKibanaSearchResponse", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", @@ -18282,11 +20938,40 @@ ">>; fetch: (options?: ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.ISearchOptions", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", "text": "ISearchOptions" - } + }, + ") => Promise<", + "SearchResponse", + ">; onRequestStart: (handler: (searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; serialize: () => { searchSourceJSON: string; references: ", + "SavedObjectReference", + "[]; }; }" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -18303,7 +20988,14 @@ "label": "KibanaContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -18320,7 +21012,22 @@ "label": "MatchAllFilter", "description": [], "signature": [ - "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MatchAllFilterMeta", + "text": "MatchAllFilterMeta" + }, + "; match_all: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", @@ -18337,7 +21044,9 @@ "label": "ParsedInterval", "description": [], "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + "{ value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", @@ -18354,12 +21063,27 @@ "label": "PhraseFilter", "description": [], "signature": [ - "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" - ], - "source": { - "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", - "lineNumber": 21 - }, + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilterMeta", + "text": "PhraseFilterMeta" + }, + "; script?: { script: { source?: any; lang?: string | undefined; params: any; }; } | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 21 + }, "deprecated": false, "initialIsOpen": false }, @@ -18371,7 +21095,22 @@ "label": "PhrasesFilter", "description": [], "signature": [ - "Filter & { meta: PhrasesFilterMeta; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilterMeta", + "text": "PhrasesFilterMeta" + }, + "; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", @@ -18405,7 +21144,30 @@ "label": "RangeFilter", "description": [], "signature": [ - "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsRangeFilter", + "text": "EsRangeFilter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterMeta", + "text": "RangeFilterMeta" + }, + "; script?: { script: { params: any; lang: string; source: any; }; } | undefined; match_all?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", @@ -18422,7 +21184,22 @@ "label": "RangeFilterMeta", "description": [], "signature": [ - "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + " & { params: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + "; field?: any; formattedValue?: string | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", @@ -18466,13 +21243,10 @@ { "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 @@ -18482,13 +21256,10 @@ { "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 @@ -18498,13 +21269,10 @@ { "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.None", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.None]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 @@ -18522,7 +21290,7 @@ "label": "AggGroupNames", "description": [], "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -18560,7 +21328,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 57 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "FilterLabelProps" + ], + "source": { + "path": "src/plugins/data/public/ui/filter_bar/index.tsx", + "lineNumber": 15 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18578,7 +21365,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 58 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.props", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "FilterItemProps" + ], + "source": { + "path": "src/plugins/data/public/ui/filter_bar/index.tsx", + "lineNumber": 24 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18647,7 +21453,39 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.isPinned", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 53 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18686,7 +21524,70 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 64 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 35 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.params", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 36 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 37 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18725,7 +21626,54 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 65 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18764,7 +21712,70 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 66 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 61 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 62 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 63 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18787,7 +21798,52 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.query", + "type": "Any", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.alias", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18834,7 +21890,92 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 94 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 95 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 96 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.formattedValue", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 97 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18857,7 +21998,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 70 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18880,7 +22040,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18903,7 +22082,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 72 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18926,7 +22124,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 73 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 73 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18949,7 +22166,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 21 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18972,7 +22208,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 75 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18995,7 +22250,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 76 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19019,14 +22293,49 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 77 }, - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.toggleFilterNegated", - "type": "Function", - "tags": [], - "label": "toggleFilterNegated", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.toggleFilterNegated", + "type": "Function", + "tags": [], + "label": "toggleFilterNegated", "description": [], "signature": [ "(filter: ", @@ -19051,7 +22360,42 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 79 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 78 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19082,7 +22426,42 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 80 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 95 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19106,7 +22485,41 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 81 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilterMeta", + "text": "PhraseFilterMeta" + }, + "; script?: { script: { source?: any; lang?: string | undefined; params: any; }; } | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19130,7 +22543,41 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 82 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilterMeta", + "text": "PhraseFilterMeta" + }, + "; script?: { script: { source?: any; lang?: string | undefined; params: any; }; } | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 54 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19140,20 +22587,87 @@ "label": "getDisplayValueFromFilter", "description": [], "signature": [ - "typeof ", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.getDisplayValueFromFilter", - "text": "getDisplayValueFromFilter" - } + "section": "def-common.Filter", + "text": "Filter" + }, + ", indexPatterns: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]) => string" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 83 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPatterns", + "type": "Array", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19202,13 +22716,101 @@ "docId": "kibDataQueryPluginApi", "section": "def-common.FilterCompareOptions", "text": "FilterCompareOptions" - } + }, + ") => boolean" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 85 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.first", + "type": "CompoundType", + "tags": [], + "label": "first", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 65 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.second", + "type": "CompoundType", + "tags": [], + "label": "second", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 66 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.comparatorOptions", + "type": "Object", + "tags": [], + "label": "comparatorOptions", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" + } + ], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19240,14 +22842,127 @@ "label": "generateFilters", "description": [], "signature": [ - "typeof ", - "generateFilters" + "(filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + ", field: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", values: any, operation: string, index: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 87 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filterManager", + "type": "Object", + "tags": [], + "label": "filterManager", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + } + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "lineNumber": 69 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.values", + "type": "Any", + "tags": [], + "label": "values", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "lineNumber": 70 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.operation", + "type": "string", + "tags": [], + "label": "operation", + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "lineNumber": 71 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "lineNumber": 72 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19279,7 +22994,56 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 88 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.newFilters", + "type": "Array", + "tags": [], + "label": "newFilters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/only_disabled.ts", + "lineNumber": 19 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.oldFilters", + "type": "Array", + "tags": [], + "label": "oldFilters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/only_disabled.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19289,14 +23053,211 @@ "label": "changeTimeFilter", "description": [], "signature": [ - "typeof ", - "changeTimeFilter" + "(timeFilter: Pick<", + "Timefilter", + ", \"isTimeRangeSelectorEnabled\" | \"isAutoRefreshSelectorEnabled\" | \"isTimeTouched\" | \"getEnabledUpdated$\" | \"getTimeUpdate$\" | \"getRefreshIntervalUpdate$\" | \"getAutoRefreshFetch$\" | \"getFetch$\" | \"getTime\" | \"getAbsoluteTime\" | \"setTime\" | \"getRefreshInterval\" | \"setRefreshInterval\" | \"createFilter\" | \"getBounds\" | \"calculateBounds\" | \"getActiveBounds\" | \"enableTimeRangeSelector\" | \"disableTimeRangeSelector\" | \"enableAutoRefreshSelector\" | \"disableAutoRefreshSelector\" | \"getTimeDefaults\" | \"getRefreshIntervalDefaults\">, filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + ") => void" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 90 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.timeFilter", + "type": "Object", + "tags": [], + "label": "timeFilter", + "description": [], + "signature": [ + "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ", + "Observable", + "; getTimeUpdate$: () => ", + "Observable", + "; getRefreshIntervalUpdate$: () => ", + "Observable", + "; getAutoRefreshFetch$: () => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.AutoRefreshDoneFn", + "text": "AutoRefreshDoneFn" + }, + ">; getFetch$: () => ", + "Observable", + "; getTime: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; getAbsoluteTime: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; setTime: (time: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.InputTimeRange", + "text": "InputTimeRange" + }, + ") => void; getRefreshInterval: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; setRefreshInterval: (refreshInterval: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + ">) => void; createFilter: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined; getBounds: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + "; calculateBounds: (timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + "; getActiveBounds: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; getRefreshIntervalDefaults: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; }" + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", + "lineNumber": 32 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsRangeFilter", + "text": "EsRangeFilter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterMeta", + "text": "RangeFilterMeta" + }, + "; script?: { script: { params: any; lang: string; source: any; }; } | undefined; match_all?: any; }" + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", + "lineNumber": 32 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19306,14 +23267,70 @@ "label": "convertRangeFilterToTimeRangeString", "description": [], "signature": [ - "typeof ", - "convertRangeFilterToTimeRangeString" + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 91 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsRangeFilter", + "text": "EsRangeFilter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterMeta", + "text": "RangeFilterMeta" + }, + "; script?: { script: { params: any; lang: string; source: any; }; } | undefined; match_all?: any; }" + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19345,7 +23362,33 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 92 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filters", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", + "lineNumber": 13 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19355,14 +23398,76 @@ "label": "extractTimeFilter", "description": [], "signature": [ - "typeof ", - "extractTimeFilter" + "(timeFieldName: string, filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]) => { restOfFilters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; timeRangeFilter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 93 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "lineNumber": 13 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.filters", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "lineNumber": 13 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19372,14 +23477,79 @@ "label": "extractTimeRange", "description": [], "signature": [ - "typeof ", - "extractTimeRange" + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], timeFieldName?: string | undefined) => { restOfFilters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 94 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filters", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "lineNumber": 31 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "lineNumber": 32 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -19442,7 +23612,42 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 125 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.expression", + "type": "Any", + "tags": [], + "label": "expression", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.parseOptions", + "type": "Object", + "tags": [], + "label": "parseOptions", + "description": [], + "signature": [ + "{ helpers?: { [key: string]: any; } | undefined; startRule?: string | undefined; allowLeadingWildcards?: boolean | undefined; cursorSymbol?: string | undefined; parseCursor?: boolean | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 46 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19481,7 +23686,87 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 126 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.node", + "type": "Object", + "tags": [], + "label": "node", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 67 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 69 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -19507,20 +23792,195 @@ "label": "buildEsQuery", "description": [], "signature": [ - "typeof ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, queries: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[], filters: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.buildEsQuery", - "text": "buildEsQuery" - } + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], config?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" + }, + ") => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 130 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.queries", + "type": "CompoundType", + "tags": [], + "label": "queries", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 40 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.filters", + "type": "CompoundType", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 41 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19530,20 +23990,39 @@ "label": "getEsQueryConfig", "description": [], "signature": [ - "typeof ", + "(config: KibanaConfig) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.getEsQueryConfig", - "text": "getEsQueryConfig" + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 131 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "KibanaConfig" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19591,7 +24070,69 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 132 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filters", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 48 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "tags": [], + "label": "ignoreFilterIfFieldNotInIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19601,20 +24142,39 @@ "label": "luceneStringToDsl", "description": [], "signature": [ - "typeof ", + "(query: any) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.luceneStringToDsl", - "text": "luceneStringToDsl" + "section": "def-common.DslQuery", + "text": "DslQuery" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 133 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.query", + "type": "Any", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", + "lineNumber": 12 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19624,20 +24184,87 @@ "label": "decorateQuery", "description": [], "signature": [ - "typeof ", + "(query: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.decorateQuery", - "text": "decorateQuery" + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + ", queryStringOptions: string | Record, dateFormatTZ?: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 134 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "DslRangeQuery", + " | ", + "DslMatchQuery", + " | ", + "DslQueryStringQuery", + " | ", + "DslMatchAllQuery", + " | ", + "DslTermQuery" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 22 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.queryStringOptions", + "type": "CompoundType", + "tags": [], + "label": "queryStringOptions", + "description": [], + "signature": [ + "string | Record" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.dateFormatTZ", + "type": "string", + "tags": [], + "label": "dateFormatTZ", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -19663,20 +24290,62 @@ "label": "datatableToCSV", "description": [], "signature": [ - "typeof ", + "({ columns, rows }: ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.datatableToCSV", - "text": "datatableToCSV" - } + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 214 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.__1", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "CSVOptions" + ], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 43 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19777,13 +24446,7 @@ "label": "HTML_CONTEXT_TYPE", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "\"html\" | \"text\"" ], "source": { "path": "src/plugins/data/public/index.ts", @@ -19799,13 +24462,7 @@ "label": "TEXT_CONTEXT_TYPE", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "\"html\" | \"text\"" ], "source": { "path": "src/plugins/data/public/index.ts", @@ -20288,7 +24945,32 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 243 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/lib/is_default.ts", + "lineNumber": 11 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20298,20 +24980,46 @@ "label": "isFilterable", "description": [], "signature": [ - "typeof ", + "(field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.isFilterable", - "text": "isFilterable" - } + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => boolean" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 244 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20321,20 +25029,46 @@ "label": "isNestedField", "description": [], "signature": [ - "typeof ", + "(field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.isNestedField", - "text": "isNestedField" - } + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => boolean" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 245 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20344,14 +25078,29 @@ "label": "validate", "description": [], "signature": [ - "typeof ", - "validateIndexPattern" + "(indexPattern: string) => Record" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 246 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "string", + "tags": [], + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/lib/validate_index_pattern.ts", + "lineNumber": 26 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20361,14 +25110,78 @@ "label": "flattenHitWrapper", "description": [], "signature": [ - "typeof ", - "flattenHitWrapper" + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", metaFields?: {}, cache?: WeakMap) => (hit: Record, deep?: boolean) => Record" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 247 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/flatten_hit.ts", + "lineNumber": 108 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.metaFields", + "type": "Object", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "{}" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/flatten_hit.ts", + "lineNumber": 109 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.cache", + "type": "Object", + "tags": [], + "label": "cache", + "description": [], + "signature": [ + "WeakMap" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/flatten_hit.ts", + "lineNumber": 110 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20378,14 +25191,62 @@ "label": "formatHitProvider", "description": [], "signature": [ - "typeof ", - "formatHitProvider" + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", defaultFormat: any) => { (hit: Record, type?: string): any; formatField(hit: Record, fieldName: string): any; }" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 248 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/format_hit.ts", + "lineNumber": 18 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.defaultFormat", + "type": "Any", + "tags": [], + "label": "defaultFormat", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/format_hit.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -20447,20 +25308,29 @@ "label": "dateHistogramInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.dateHistogramInterval", - "text": "dateHistogramInterval" - } + "(interval: string) => Interval" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 410 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20470,7 +25340,7 @@ "label": "intervalOptions", "description": [], "signature": [ - "({ display: any; val: string; enabled(agg: ", + "({ display: string; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", @@ -20478,7 +25348,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean; } | { display: any; val: string; })[]" + "): boolean; } | { display: string; val: string; })[]" ], "source": { "path": "src/plugins/data/public/index.ts", @@ -20563,20 +25433,39 @@ "label": "isDateHistogramBucketAggConfig", "description": [], "signature": [ - "typeof ", + "(agg: any) => agg is ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.isDateHistogramBucketAggConfig", - "text": "isDateHistogramBucketAggConfig" + "section": "def-common.IBucketDateHistogramAggConfig", + "text": "IBucketDateHistogramAggConfig" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 415 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.agg", + "type": "Any", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 57 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20600,7 +25489,32 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 416 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20624,7 +25538,32 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 417 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20648,7 +25587,26 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 418 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 13 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20658,20 +25616,29 @@ "label": "isValidEsInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.isValidEsInterval", - "text": "isValidEsInterval" - } + "(interval: string) => boolean" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 419 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20681,31 +25648,53 @@ "label": "isValidInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.isValidInterval", - "text": "isValidInterval" - } + "(value: string, baseInterval?: string | undefined) => boolean" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 420 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.baseInterval", + "type": "string", + "tags": [], + "label": "baseInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.search.aggs.parentPipelineType", - "type": "Any", + "type": "string", "tags": [], "label": "parentPipelineType", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 421 @@ -20720,20 +25709,31 @@ "label": "parseEsInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.parseEsInterval", - "text": "parseEsInterval" - } + "(interval: string) => { value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 422 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20743,20 +25743,29 @@ "label": "parseInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.parseInterval", - "text": "parseInterval" - } + "(interval: string) => moment.Duration | null" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 423 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20766,31 +25775,40 @@ "label": "propFilter", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.propFilter", - "text": "propFilter" - } + "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 424 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.prop", + "type": "Uncategorized", + "tags": [], + "label": "prop", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.search.aggs.siblingPipelineType", - "type": "Any", + "type": "string", "tags": [], "label": "siblingPipelineType", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 425 @@ -20821,20 +25839,40 @@ "label": "toAbsoluteDates", "description": [], "signature": [ - "typeof ", + "(range: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.toAbsoluteDates", - "text": "toAbsoluteDates" - } + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => { from: Date; to: Date; } | undefined" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 427 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.range", + "type": "Object", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20844,7 +25882,7 @@ "label": "boundsDescendingRaw", "description": [], "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: any; intervalLabel: any; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: any; intervalLabel: any; })[]" + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" ], "source": { "path": "src/plugins/data/public/index.ts", @@ -20874,7 +25912,32 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 429 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.column", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20906,7 +25969,32 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 430 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.column", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] } ] }, @@ -20918,20 +26006,74 @@ "label": "getResponseInspectorStats", "description": [], "signature": [ - "typeof ", + "(resp?: ", + "SearchResponse", + " | undefined, searchSource?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.getResponseInspectorStats", - "text": "getResponseInspectorStats" + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 432 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.resp", + "type": "Object", + "tags": [], + "label": "resp", + "description": [], + "signature": [ + "SearchResponse", + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "lineNumber": 53 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.searchSource", + "type": "Object", + "tags": [], + "label": "searchSource", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "lineNumber": 54 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20941,20 +26083,89 @@ "label": "tabifyAggResponse", "description": [], "signature": [ - "typeof ", + "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.tabifyAggResponse", - "text": "tabifyAggResponse" + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", esResponse: Record, respOpts?: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 433 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.aggConfigs", + "type": "Object", + "tags": [], + "label": "aggConfigs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esResponse", + "type": "Object", + "tags": [], + "label": "esResponse", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 21 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.respOpts", + "type": "Object", + "tags": [], + "label": "respOpts", + "description": [], + "signature": [ + "Partial<", + "TabbedResponseWriterOptions", + "> | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -20964,20 +26175,62 @@ "label": "tabifyGetColumns", "description": [], "signature": [ - "typeof ", + "(aggs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.tabifyGetColumns", - "text": "tabifyGetColumns" - } + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[], minimalColumns: boolean) => ", + "TabbedAggColumn", + "[]" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 434 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.aggs", + "type": "Array", + "tags": [], + "label": "aggs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.minimalColumns", + "type": "boolean", + "tags": [], + "label": "minimalColumns", + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -21069,15 +26322,9 @@ "label": "fieldFormats", "description": [], "signature": [ - "Pick<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsRegistry", - "text": "FieldFormatsRegistry" - }, - ", \"register\">" + "{ register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -21114,7 +26361,16 @@ "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStateChange", "text": "QueryStateChange" - } + }, + "; state: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + }, + "; }>; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -21203,15 +26459,175 @@ "\nindex patterns service\n{@link IndexPatternsContract}" ], "signature": [ - "Pick<", + "{ get: (id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; delete: (indexPatternId: string) => Promise<{}>; create: (spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; find: (search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>; ensureDefaultIndexPattern: ", + "EnsureDefaultIndexPattern", + "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", + "SavedObject", + "<", + "IndexPatternSavedObjectAttrs", + ">[] | null | undefined>; getDefault: () => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; getFieldsForWildcard: (options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise; getFieldsForIndexPattern: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise; refreshFields: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise; fieldArrayToMap: (fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record; savedObjectToSpec: (savedObject: ", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + "; createAndSave: (spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; createSavedObject: (indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; updateSavedObject: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -21253,13 +26669,17 @@ "\nfield formats service\n{@link FieldFormatsStart}" ], "signature": [ + "Pick<", { "pluginId": "data", - "scope": "public", + "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-public.FieldFormatsStart", - "text": "FieldFormatsStart" - } + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\"> & { deserialize: ", + "FormatFactory", + "; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -21304,7 +26724,66 @@ "text": "SavedQueryService" }, "; state$: ", - "Observable" + "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: ", + "TimefilterSetup", + "; getEsQuery: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -21344,9 +26823,7 @@ "label": "nowProvider", "description": [], "signature": [ - "Pick, \"get\">" + "{ get: () => Date; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -21408,7 +26885,44 @@ "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.agg", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; schema?: string | undefined; } | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -21505,7 +27019,10 @@ "text": "DataPluginStart" }, ", ", - "DataPluginSetupDependencies" + "DataPluginSetupDependencies", + ", ", + "DataPluginStartDependencies", + ">" ], "source": { "path": "src/plugins/data/server/plugin.ts", @@ -21585,7 +27102,18 @@ ">, { bfetch, expressions, usageCollection }: ", "DataPluginSetupDependencies", ") => { __enhance: (enhancements: ", - "DataEnhancements" + "DataEnhancements", + ") => void; search: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchSetup", + "text": "ISearchSetup" + }, + "; fieldFormats: { register: (customFieldFormat: ", + "FieldFormatInstanceType", + ") => number; }; }" ], "source": { "path": "src/plugins/data/server/plugin.ts", @@ -21694,7 +27222,40 @@ "docId": "kibCorePluginApi", "section": "def-server.ElasticsearchClient", "text": "ElasticsearchClient" - } + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ">; }; search: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStart", + "text": "ISearchStart" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">; }" ], "source": { "path": "src/plugins/data/server/plugin.ts", @@ -21816,7 +27377,7 @@ "label": "fieldFormatMap", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", @@ -21947,7 +27508,42 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 64 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 64 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -21957,13 +27553,45 @@ "label": "formatField", "description": [], "signature": [ - "FormatFieldFn" + "(hit: Record, fieldName: string) => any" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -21979,7 +27607,42 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.deep", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -23217,13 +28880,15 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "EnsureDefaultIndexPattern" + "() => Promise | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -23285,7 +28950,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -23323,7 +28990,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -23426,7 +29095,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -23464,7 +29135,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "optionally clear a single id" + ], "signature": [ "string | undefined" ], @@ -23859,7 +29532,9 @@ "type": "Array", "tags": [], "label": "fields", - "description": [], + "description": [ + ": FieldSpec[]" + ], "signature": [ { "pluginId": "data", @@ -23883,7 +29558,9 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [], + "description": [ + ": FieldAttrs" + ], "signature": [ { "pluginId": "data", @@ -24424,13 +30101,15 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "EnsureDefaultIndexPattern" + "() => Promise | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -24492,7 +30171,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -24530,7 +30211,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -24633,7 +30316,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -24671,7 +30356,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "optionally clear a single id" + ], "signature": [ "string | undefined" ], @@ -25066,7 +30753,9 @@ "type": "Array", "tags": [], "label": "fields", - "description": [], + "description": [ + ": FieldSpec[]" + ], "signature": [ { "pluginId": "data", @@ -25090,7 +30779,9 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [], + "description": [ + ": FieldAttrs" + ], "signature": [ { "pluginId": "data", @@ -25961,7 +31652,44 @@ "label": "aggFilter", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilter\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"filter\">, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -25977,7 +31705,44 @@ "label": "aggFilters", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilters\", any, Pick, \"enabled\" | \"id\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"schema\" | \"json\" | \"timeShift\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -25993,7 +31758,44 @@ "label": "aggSignificantTerms", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSignificantTerms\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BUCKET_TYPES", + "text": "BUCKET_TYPES" + }, + ".SIGNIFICANT_TERMS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26009,7 +31811,44 @@ "label": "aggIpRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggIpRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ipRangeType\" | \"ranges\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26025,7 +31864,44 @@ "label": "aggDateRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ranges\" | \"time_zone\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26041,7 +31917,44 @@ "label": "aggRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ranges\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26057,7 +31970,44 @@ "label": "aggGeoTile", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoTile\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BUCKET_TYPES", + "text": "BUCKET_TYPES" + }, + ".GEOTILE_GRID>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26073,7 +32023,44 @@ "label": "aggGeoHash", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoHash\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\" | \"boundingBox\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26089,7 +32076,44 @@ "label": "aggHistogram", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, \"extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\" | \"extended_bounds\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26105,7 +32129,44 @@ "label": "aggDateHistogram", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, \"timeRange\" | \"extended_bounds\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"timeRange\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"extended_bounds\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26121,7 +32182,48 @@ "label": "aggTerms", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggTerms\", any, Pick, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\"> & Pick<{ orderAgg?: ", + "AggExpressionType", + " | undefined; }, \"orderAgg\"> & Pick<{ orderAgg?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"orderAgg\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26137,7 +32239,44 @@ "label": "aggAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggAvg\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".AVG>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26153,7 +32292,52 @@ "label": "aggBucketAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26169,7 +32353,52 @@ "label": "aggBucketMax", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketMax\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26185,7 +32414,52 @@ "label": "aggBucketMin", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketMin\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26201,7 +32475,52 @@ "label": "aggBucketSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26217,7 +32536,52 @@ "label": "aggFilteredMetric", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilteredMetric\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26233,7 +32597,44 @@ "label": "aggCardinality", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCardinality\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".CARDINALITY>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26249,7 +32650,44 @@ "label": "aggCount", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCount\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".COUNT>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26265,7 +32703,48 @@ "label": "aggCumulativeSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCumulativeSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26281,7 +32760,48 @@ "label": "aggDerivative", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDerivative\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26297,7 +32817,44 @@ "label": "aggGeoBounds", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoBounds\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".GEO_BOUNDS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26313,7 +32870,44 @@ "label": "aggGeoCentroid", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoCentroid\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".GEO_CENTROID>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26329,7 +32923,44 @@ "label": "aggMax", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMax\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MAX>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26345,7 +32976,44 @@ "label": "aggMedian", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMedian\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MEDIAN>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26361,7 +33029,44 @@ "label": "aggSinglePercentile", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSinglePercentile\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".SINGLE_PERCENTILE>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26377,7 +33082,44 @@ "label": "aggMin", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMin\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MIN>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26393,7 +33135,48 @@ "label": "aggMovingAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMovingAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26409,7 +33192,44 @@ "label": "aggPercentileRanks", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggPercentileRanks\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".PERCENTILE_RANKS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26425,7 +33245,44 @@ "label": "aggPercentiles", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggPercentiles\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".PERCENTILES>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26441,7 +33298,48 @@ "label": "aggSerialDiff", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSerialDiff\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26457,7 +33355,44 @@ "label": "aggStdDeviation", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggStdDeviation\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".STD_DEV>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26473,7 +33408,44 @@ "label": "aggSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSum\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".SUM>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26489,7 +33461,44 @@ "label": "aggTopHit", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggTopHit\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".TOP_HITS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -26626,7 +33635,7 @@ "label": "queryStringOptions", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -26700,7 +33709,7 @@ "label": "params", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -27923,14 +34932,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 6 + "lineNumber": 5 } }, { @@ -27951,14 +34960,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 18 + "lineNumber": 17 } }, { @@ -28035,28 +35044,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 7 + "lineNumber": 6 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 9 + "lineNumber": 8 } }, { @@ -28119,14 +35128,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 10 + "lineNumber": 9 } }, { @@ -28906,6 +35915,20 @@ "lineNumber": 380 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts", + "lineNumber": 2 + } + }, { "plugin": "securitySolution", "link": { @@ -29403,7 +36426,8 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - } + }, + ") | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", @@ -29897,7 +36921,32 @@ "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -30012,7 +37061,17 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + "{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -30046,7 +37105,22 @@ "label": "AggParam", "description": [], "signature": [ - "BaseParamType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", @@ -30080,7 +37154,14 @@ "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -30115,7 +37196,39 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + "{ filters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined; query?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[] | undefined; timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -30132,15 +37245,14 @@ "label": "ExpressionFunctionKibana", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ExecutionContextSearch> | null, object, ", + "<\"kibana\", Input, object, ", { "pluginId": "expressions", "scope": "common", @@ -30148,7 +37260,39 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -30165,15 +37309,14 @@ "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + "<\"kibana_context\", Input, Arguments, Promise<", { "pluginId": "expressions", "scope": "common", @@ -30181,7 +37324,39 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", @@ -30198,7 +37373,14 @@ "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -30215,7 +37397,7 @@ "label": "FieldFormatsGetConfigFn", "description": [], "signature": [ - "(key: string, defaultOverride: T | undefined) => T" + "(key: string, defaultOverride?: T | undefined) => T" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -30232,7 +37414,23 @@ "label": "Filter", "description": [], "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -30252,7 +37450,13 @@ "label": "IAggConfig", "description": [], "signature": [ - "AggConfig" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -30269,7 +37473,38 @@ "label": "IAggType", "description": [], "signature": [ - "AggType>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -30286,7 +37521,16 @@ "label": "IEsSearchResponse", "description": [], "signature": [ - "IKibanaSearchResponse>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -30324,7 +37568,176 @@ "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" - } + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" + }, + "; getType: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getTypeWithoutMetaParams: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getDefaultType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + "FieldFormatInstanceType", + " | undefined; getTypeNameByEsTypes: (esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + " | undefined; getDefaultTypeName: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "; getInstance: ((formatId: string, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; getDefaultInstancePlain: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; getDefaultInstanceCacheResolver: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]) => string; getByFieldType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ") => ", + "FieldFormatInstanceType", + "[]; getDefaultInstance: ((fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; parseDefaultTypeMap: (value: any) => void; }" ], "source": { "path": "src/plugins/data/common/field_formats/index.ts", @@ -30341,7 +37754,13 @@ "label": "IFieldParamType", "description": [], "signature": [ - "FieldParamType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldParamType", + "text": "FieldParamType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -30358,7 +37777,22 @@ "label": "IMetricAggType", "description": [], "signature": [ - "MetricAggType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", @@ -30375,7 +37809,14 @@ "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -30410,7 +37851,14 @@ "label": "KibanaContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -30427,7 +37875,9 @@ "label": "ParsedInterval", "description": [], "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + "{ value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", @@ -30488,13 +37938,10 @@ { "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.Buckets", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 @@ -30504,13 +37951,10 @@ { "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.Metrics", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 @@ -30520,13 +37964,10 @@ { "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.None", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.None]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 @@ -30544,7 +37985,7 @@ "label": "AggGroupNames", "description": [], "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -30587,7 +38028,52 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.query", + "type": "Any", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.alias", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30597,20 +38083,124 @@ "label": "buildCustomFilter", "description": [], "signature": [ - "typeof ", + "(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.buildCustomFilter", - "text": "buildCustomFilter" + "section": "def-common.Filter", + "text": "Filter" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.indexPatternString", + "type": "string", + "tags": [], + "label": "indexPatternString", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.queryDsl", + "type": "Any", + "tags": [], + "label": "queryDsl", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.disabled", + "type": "boolean", + "tags": [], + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.negate", + "type": "boolean", + "tags": [], + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.alias", + "type": "CompoundType", + "tags": [], + "label": "alias", + "description": [], + "signature": [ + "string | null" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 46 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.store", + "type": "Enum", + "tags": [], + "label": "store", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 47 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30628,12 +38218,44 @@ "section": "def-common.Filter", "text": "Filter" } - ], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 32 - }, - "deprecated": false + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 32 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.isPinned", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 53 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30672,7 +38294,54 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30682,20 +38351,202 @@ "label": "buildFilter", "description": [], "signature": [ - "typeof ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.buildFilter", - "text": "buildFilter" + "section": "def-common.FILTERS", + "text": "FILTERS" + }, + ", negate: boolean, disabled: boolean, params: any, alias: string | null, store?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + " | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 34 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 22 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.type", + "type": "Enum", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FILTERS", + "text": "FILTERS" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.negate", + "type": "boolean", + "tags": [], + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 25 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.disabled", + "type": "boolean", + "tags": [], + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.params", + "type": "Any", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.alias", + "type": "CompoundType", + "tags": [], + "label": "alias", + "description": [], + "signature": [ + "string | null" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.store", + "type": "CompoundType", + "tags": [], + "label": "store", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30734,7 +38585,70 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 35 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 61 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 62 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 63 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30773,7 +38687,70 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 36 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 35 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.params", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 36 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 37 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30820,7 +38797,92 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 37 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 94 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 95 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 96 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.formattedValue", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 97 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30844,7 +38906,42 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 38 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 38 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -30907,7 +39004,42 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 66 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.expression", + "type": "Any", + "tags": [], + "label": "expression", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.parseOptions", + "type": "Object", + "tags": [], + "label": "parseOptions", + "description": [], + "signature": [ + "{ helpers?: { [key: string]: any; } | undefined; startRule?: string | undefined; allowLeadingWildcards?: boolean | undefined; cursorSymbol?: string | undefined; parseCursor?: boolean | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 46 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -30946,7 +39078,87 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.node", + "type": "Object", + "tags": [], + "label": "node", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 67 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 69 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -31010,7 +39222,69 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.filters", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 48 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "tags": [], + "label": "ignoreFilterIfFieldNotInIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 49 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31020,20 +39294,39 @@ "label": "getEsQueryConfig", "description": [], "signature": [ - "typeof ", + "(config: KibanaConfig) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.getEsQueryConfig", - "text": "getEsQueryConfig" + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 72 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "KibanaConfig" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31043,20 +39336,195 @@ "label": "buildEsQuery", "description": [], "signature": [ - "typeof ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, queries: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[], filters: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.buildEsQuery", - "text": "buildEsQuery" - } + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], config?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" + }, + ") => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 73 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.queries", + "type": "CompoundType", + "tags": [], + "label": "queries", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 40 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.filters", + "type": "CompoundType", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 41 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -31082,20 +39550,62 @@ "label": "datatableToCSV", "description": [], "signature": [ - "typeof ", + "({ columns, rows }: ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.datatableToCSV", - "text": "datatableToCSV" - } + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 47 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.__1", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "CSVOptions" + ], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 43 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31518,20 +40028,46 @@ "label": "isFilterable", "description": [], "signature": [ - "typeof ", + "(field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.isFilterable", - "text": "isFilterable" - } + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => boolean" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 129 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31541,20 +40077,46 @@ "label": "isNestedField", "description": [], "signature": [ - "typeof ", + "(field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.isNestedField", - "text": "isNestedField" - } + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => boolean" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 130 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -31616,20 +40178,29 @@ "label": "dateHistogramInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.dateHistogramInterval", - "text": "dateHistogramInterval" - } + "(interval: string) => Interval" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 247 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31639,7 +40210,7 @@ "label": "intervalOptions", "description": [], "signature": [ - "({ display: any; val: string; enabled(agg: ", + "({ display: string; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", @@ -31647,7 +40218,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean; } | { display: any; val: string; })[]" + "): boolean; } | { display: string; val: string; })[]" ], "source": { "path": "src/plugins/data/server/index.ts", @@ -31746,7 +40317,32 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 252 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31770,7 +40366,32 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 253 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31794,7 +40415,26 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 254 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 13 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31804,20 +40444,29 @@ "label": "isValidEsInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.isValidEsInterval", - "text": "isValidEsInterval" - } + "(interval: string) => boolean" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 255 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31827,31 +40476,53 @@ "label": "isValidInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.isValidInterval", - "text": "isValidInterval" - } + "(value: string, baseInterval?: string | undefined) => boolean" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 256 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.baseInterval", + "type": "string", + "tags": [], + "label": "baseInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-server.search.aggs.parentPipelineType", - "type": "Any", + "type": "string", "tags": [], "label": "parentPipelineType", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 257 @@ -31866,20 +40537,31 @@ "label": "parseEsInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.parseEsInterval", - "text": "parseEsInterval" - } + "(interval: string) => { value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 258 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31889,20 +40571,29 @@ "label": "parseInterval", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.parseInterval", - "text": "parseInterval" - } + "(interval: string) => moment.Duration | null" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 259 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31912,31 +40603,40 @@ "label": "propFilter", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.propFilter", - "text": "propFilter" - } + "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 260 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.prop", + "type": "Uncategorized", + "tags": [], + "label": "prop", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "lineNumber": 20 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-server.search.aggs.siblingPipelineType", - "type": "Any", + "type": "string", "tags": [], "label": "siblingPipelineType", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 261 @@ -31967,20 +40667,40 @@ "label": "toAbsoluteDates", "description": [], "signature": [ - "typeof ", + "(range: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.toAbsoluteDates", - "text": "toAbsoluteDates" - } + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => { from: Date; to: Date; } | undefined" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 263 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.range", + "type": "Object", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -31990,20 +40710,42 @@ "label": "calcAutoIntervalLessThan", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.calcAutoIntervalLessThan", - "text": "calcAutoIntervalLessThan" - } + "(maxBucketCount: number, duration: number) => moment.Duration" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 264 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.maxBucketCount", + "type": "number", + "tags": [], + "label": "maxBucketCount", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.duration", + "type": "number", + "tags": [], + "label": "duration", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252 + }, + "deprecated": false + } + ] } ] }, @@ -32015,20 +40757,89 @@ "label": "tabifyAggResponse", "description": [], "signature": [ - "typeof ", + "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.tabifyAggResponse", - "text": "tabifyAggResponse" + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", esResponse: Record, respOpts?: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 266 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.aggConfigs", + "type": "Object", + "tags": [], + "label": "aggConfigs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esResponse", + "type": "Object", + "tags": [], + "label": "esResponse", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 21 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.respOpts", + "type": "Object", + "tags": [], + "label": "respOpts", + "description": [], + "signature": [ + "Partial<", + "TabbedResponseWriterOptions", + "> | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -32038,20 +40849,62 @@ "label": "tabifyGetColumns", "description": [], "signature": [ - "typeof ", + "(aggs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.tabifyGetColumns", - "text": "tabifyGetColumns" - } + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[], minimalColumns: boolean) => ", + "TabbedAggColumn", + "[]" ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 267 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.aggs", + "type": "Array", + "tags": [], + "label": "aggs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.minimalColumns", + "type": "boolean", + "tags": [], + "label": "minimalColumns", + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -32706,7 +41559,40 @@ "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" - } + }, + "[], config: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" + }, + ") => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -33775,7 +42661,9 @@ "type": "Object", "tags": [], "label": "filter", - "description": [], + "description": [ + "The filter to clean" + ], "signature": [ { "pluginId": "data", @@ -36430,7 +45318,7 @@ "label": "queryStringOptions", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -36563,13 +45451,32 @@ "label": "convert", "description": [], "signature": [ - "FilterFormatterFunction" + "(value: any) => string" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 21 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -36585,7 +45492,23 @@ "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 22 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 22 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -37336,7 +46259,14 @@ "label": "CustomFilter", "description": [], "signature": [ - "Filter & { query: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { query: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", @@ -37387,7 +46317,30 @@ "label": "ExistsFilter", "description": [], "signature": [ - "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; exists?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterExistsProperty", + "text": "FilterExistsProperty" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", @@ -37459,6 +46412,30 @@ "docId": "kibDataPluginApi", "section": "def-common.MatchAllFilter", "text": "MatchAllFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MissingFilter", + "text": "MissingFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" } ], "source": { @@ -37476,7 +46453,23 @@ "label": "Filter", "description": [], "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + "{ $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -37510,7 +46503,15 @@ "label": "FilterState", "description": [], "signature": [ - "{ store: FilterStateStore; }" + "{ store: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + "; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -37527,7 +46528,22 @@ "label": "GeoBoundingBoxFilter", "description": [], "signature": [ - "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoBoundingBoxFilterMeta", + "text": "GeoBoundingBoxFilterMeta" + }, + "; geo_bounding_box: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", @@ -37544,7 +46560,30 @@ "label": "GeoBoundingBoxFilterMeta", "description": [], "signature": [ - "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + " & { params: { bottom_right: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.LatLon", + "text": "LatLon" + }, + "; top_left: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.LatLon", + "text": "LatLon" + }, + "; }; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", @@ -37561,7 +46600,22 @@ "label": "GeoPolygonFilter", "description": [], "signature": [ - "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoPolygonFilterMeta", + "text": "GeoPolygonFilterMeta" + }, + "; geo_polygon: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", @@ -37578,7 +46632,22 @@ "label": "GeoPolygonFilterMeta", "description": [], "signature": [ - "FilterMeta & { params: { points: LatLon[];}; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + " & { params: { points: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.LatLon", + "text": "LatLon" + }, + "[]; }; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", @@ -37597,7 +46666,7 @@ "\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible." ], "signature": [ - "(key: string, defaultOverride: T | undefined) => T" + "(key: string, defaultOverride?: T | undefined) => T" ], "source": { "path": "src/plugins/data/common/types.ts", @@ -37631,7 +46700,22 @@ "label": "MatchAllFilter", "description": [], "signature": [ - "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MatchAllFilterMeta", + "text": "MatchAllFilterMeta" + }, + "; match_all: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", @@ -37648,7 +46732,22 @@ "label": "MissingFilter", "description": [], "signature": [ - "Filter & { meta: MissingFilterMeta; missing: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; missing: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", @@ -37682,7 +46781,22 @@ "label": "PhraseFilter", "description": [], "signature": [ - "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilterMeta", + "text": "PhraseFilterMeta" + }, + "; script?: { script: { source?: any; lang?: string | undefined; params: any; }; } | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", @@ -37699,7 +46813,14 @@ "label": "PhraseFilterMeta", "description": [], "signature": [ - "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + " & { params?: { query: string; } | undefined; field?: any; index?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", @@ -37716,7 +46837,22 @@ "label": "PhrasesFilter", "description": [], "signature": [ - "Filter & { meta: PhrasesFilterMeta; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilterMeta", + "text": "PhrasesFilterMeta" + }, + "; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", @@ -37733,7 +46869,14 @@ "label": "PhrasesFilterMeta", "description": [], "signature": [ - "FilterMeta & { params: string[]; field?: string | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + " & { params: string[]; field?: string | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", @@ -37750,7 +46893,22 @@ "label": "QueryStringFilter", "description": [], "signature": [ - "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: { query_string: { query: string; }; } | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", @@ -37784,7 +46942,30 @@ "label": "RangeFilter", "description": [], "signature": [ - "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsRangeFilter", + "text": "EsRangeFilter" + }, + " & { meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterMeta", + "text": "RangeFilterMeta" + }, + "; script?: { script: { params: any; lang: string; source: any; }; } | undefined; match_all?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", @@ -37801,7 +46982,22 @@ "label": "RangeFilterMeta", "description": [], "signature": [ - "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + " & { params: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + "; field?: any; formattedValue?: string | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", diff --git a/api_docs/data_autocomplete.json b/api_docs/data_autocomplete.json index d74fb2eee1677c..25bda08157358d 100644 --- a/api_docs/data_autocomplete.json +++ b/api_docs/data_autocomplete.json @@ -356,7 +356,17 @@ "label": "AutocompleteStart", "description": [], "signature": [ - "{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }" + "{ getQuerySuggestions: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", + "ValueSuggestionsGetFn", + "; }" ], "source": { "path": "src/plugins/data/public/autocomplete/autocomplete_service.ts", diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json index ddbccef9e7d70a..a5fba87c20169b 100644 --- a/api_docs/data_field_formats.json +++ b/api_docs/data_field_formats.json @@ -37,7 +37,17 @@ "label": "FieldFormatsStart", "description": [], "signature": [ - "Pick & { deserialize: FormatFactory; }" + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\"> & { deserialize: ", + "FormatFactory", + "; }" ], "source": { "path": "src/plugins/data/public/field_formats/field_formats_service.ts", @@ -114,13 +124,10 @@ { "parentPluginId": "data", "id": "def-common.BoolFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/boolean.ts", "lineNumber": 17 @@ -238,13 +245,10 @@ { "parentPluginId": "data", "id": "def-common.BytesFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 15 @@ -276,13 +280,10 @@ { "parentPluginId": "data", "id": "def-common.BytesFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 20 @@ -360,13 +361,10 @@ { "parentPluginId": "data", "id": "def-common.ColorFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/color.tsx", "lineNumber": 21 @@ -544,13 +542,10 @@ { "parentPluginId": "data", "id": "def-common.DurationFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", "lineNumber": 213 @@ -587,7 +582,7 @@ "label": "inputFormats", "description": [], "signature": [ - "{ text: any; kind: string; }[]" + "{ text: string; kind: string; }[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", @@ -603,7 +598,7 @@ "label": "outputFormats", "description": [], "signature": [ - "({ text: any; method: string; shortText?: undefined; } | { text: any; shortText: any; method: string; })[]" + "({ text: string; method: string; shortText?: undefined; } | { text: string; shortText: string; method: string; })[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", @@ -1246,15 +1241,10 @@ "label": "from", "description": [], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ".from" + "(convertFn: ", + "FieldFormatConvertFunction", + ") => ", + "FieldFormatInstanceType" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -1309,15 +1299,14 @@ "label": "isInstanceOfFieldFormat", "description": [], "signature": [ - "typeof ", + "(fieldFormat: any) => fieldFormat is ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FieldFormat", "text": "FieldFormat" - }, - ".isInstanceOfFieldFormat" + } ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -1716,7 +1705,9 @@ "type": "Enum", "tags": [], "label": "fieldType", - "description": [], + "description": [ + "- the field type" + ], "signature": [ { "pluginId": "data", @@ -1739,7 +1730,9 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [], + "description": [ + "- Array of ES data types" + ], "signature": [ { "pluginId": "data", @@ -1788,7 +1781,9 @@ "type": "string", "tags": [], "label": "formatId", - "description": [], + "description": [ + "- the format id" + ], "signature": [ "string" ], @@ -1907,7 +1902,9 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [], + "description": [ + "- Array of ES data types" + ], "signature": [ { "pluginId": "data", @@ -1970,7 +1967,9 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [], + "description": [ + "- Array of ES data types" + ], "signature": [ { "pluginId": "data", @@ -2118,7 +2117,39 @@ "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 162 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.formatId", + "type": "string", + "tags": [], + "label": "formatId", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 163 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 163 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2414,7 +2445,71 @@ "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 242 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.fieldType", + "type": "Enum", + "tags": [], + "label": "fieldType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 187 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 188 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 189 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2571,13 +2666,10 @@ { "parentPluginId": "data", "id": "def-common.HistogramFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 20 @@ -2609,13 +2701,10 @@ { "parentPluginId": "data", "id": "def-common.HistogramFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 25 @@ -2747,13 +2836,10 @@ { "parentPluginId": "data", "id": "def-common.IpFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/ip.ts", "lineNumber": 16 @@ -2870,13 +2956,10 @@ { "parentPluginId": "data", "id": "def-common.NumberFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 15 @@ -2908,13 +2991,10 @@ { "parentPluginId": "data", "id": "def-common.NumberFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 20 @@ -2986,13 +3066,10 @@ { "parentPluginId": "data", "id": "def-common.PercentFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 16 @@ -3024,13 +3101,10 @@ { "parentPluginId": "data", "id": "def-common.PercentFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 21 @@ -3162,13 +3236,10 @@ { "parentPluginId": "data", "id": "def-common.RelativeDateFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", "lineNumber": 17 @@ -3473,13 +3544,10 @@ { "parentPluginId": "data", "id": "def-common.StaticLookupFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", "lineNumber": 26 @@ -3621,13 +3689,10 @@ { "parentPluginId": "data", "id": "def-common.StringFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", "lineNumber": 64 @@ -3665,7 +3730,7 @@ "label": "transformOptions", "description": [], "signature": [ - "({ kind: boolean; text: any; } | { kind: string; text: any; })[]" + "({ kind: boolean; text: string; } | { kind: string; text: string; })[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", @@ -3785,13 +3850,10 @@ { "parentPluginId": "data", "id": "def-common.TruncateFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/truncate.ts", "lineNumber": 19 @@ -3914,13 +3976,10 @@ { "parentPluginId": "data", "id": "def-common.UrlFormat.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 48 @@ -3958,7 +4017,7 @@ "label": "urlTypes", "description": [], "signature": [ - "{ kind: string; text: any; }[]" + "{ kind: string; text: string; }[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", @@ -4207,7 +4266,7 @@ "label": "params", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -4314,7 +4373,7 @@ "label": "FieldFormatsGetConfigFn", "description": [], "signature": [ - "(key: string, defaultOverride: T | undefined) => T" + "(key: string, defaultOverride?: T | undefined) => T" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -4331,7 +4390,19 @@ "label": "FieldFormatsStartCommon", "description": [], "signature": [ - "{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ", + "{ init: (getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "FieldFormatInstanceType", + "[]) => void; register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; deserialize: ", "FormatFactory", "; getDefaultConfig: (fieldType: ", { @@ -4349,7 +4420,19 @@ "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, - "[] | undefined) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (fieldType: ", + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" + }, + "; getType: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getTypeWithoutMetaParams: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getDefaultType: (fieldType: ", { "pluginId": "data", "scope": "common", @@ -4364,7 +4447,140 @@ "docId": "kibDataPluginApi", "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" - } + }, + "[] | undefined) => ", + "FieldFormatInstanceType", + " | undefined; getTypeNameByEsTypes: (esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + " | undefined; getDefaultTypeName: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "; getInstance: ((formatId: string, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; getDefaultInstancePlain: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; getDefaultInstanceCacheResolver: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]) => string; getByFieldType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ") => ", + "FieldFormatInstanceType", + "[]; getDefaultInstance: ((fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; parseDefaultTypeMap: (value: any) => void; }" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -4381,13 +4597,7 @@ "label": "HTML_CONTEXT_TYPE", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "\"html\" | \"text\"" ], "source": { "path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts", @@ -4404,7 +4614,13 @@ "label": "IFieldFormat", "description": [], "signature": [ - "FieldFormat" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -4442,7 +4658,176 @@ "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" - } + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" + }, + "; getType: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getTypeWithoutMetaParams: (formatId: string) => ", + "FieldFormatInstanceType", + " | undefined; getDefaultType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + "FieldFormatInstanceType", + " | undefined; getTypeNameByEsTypes: (esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + " | undefined; getDefaultTypeName: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "; getInstance: ((formatId: string, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; getDefaultInstancePlain: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; getDefaultInstanceCacheResolver: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]) => string; getByFieldType: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ") => ", + "FieldFormatInstanceType", + "[]; getDefaultInstance: ((fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction; parseDefaultTypeMap: (value: any) => void; }" ], "source": { "path": "src/plugins/data/common/field_formats/index.ts", @@ -4459,13 +4844,7 @@ "label": "TEXT_CONTEXT_TYPE", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "\"html\" | \"text\"" ], "source": { "path": "src/plugins/data/common/field_formats/content_types/text_content_type.ts", diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json index cc8c83dc935da1..0a74a65fb4d34a 100644 --- a/api_docs/data_index_patterns.json +++ b/api_docs/data_index_patterns.json @@ -523,7 +523,8 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" - } + }, + ">; }" ], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", @@ -1170,7 +1171,7 @@ "label": "fieldFormatMap", "description": [], "signature": [ - "Record" + "{ [x: string]: any; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", @@ -1301,7 +1302,42 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 64 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 64 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -1311,13 +1347,45 @@ "label": "formatField", "description": [], "signature": [ - "FormatFieldFn" + "(hit: Record, fieldName: string) => any" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -1333,7 +1401,42 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.hit", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.deep", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -3228,13 +3331,15 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "EnsureDefaultIndexPattern" + "() => Promise | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -3296,7 +3401,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -3334,7 +3441,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -3437,7 +3546,9 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [], + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], @@ -3475,7 +3586,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "optionally clear a single id" + ], "signature": [ "string | undefined" ], @@ -3870,7 +3983,9 @@ "type": "Array", "tags": [], "label": "fields", - "description": [], + "description": [ + ": FieldSpec[]" + ], "signature": [ { "pluginId": "data", @@ -3894,7 +4009,9 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [], + "description": [ + ": FieldAttrs" + ], "signature": [ { "pluginId": "data", @@ -4508,7 +4625,7 @@ "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", "text": "IndexPatternLoadExpressionFunctionDefinition" }, - ", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"disabled\" | \"help\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">" + ", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"help\" | \"disabled\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">" ], "source": { "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", @@ -6592,14 +6709,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 6 + "lineNumber": 5 } }, { @@ -6620,14 +6737,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 18 + "lineNumber": 17 } }, { @@ -6704,28 +6821,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 7 + "lineNumber": 6 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 9 + "lineNumber": 8 } }, { @@ -6788,14 +6905,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 10 + "lineNumber": 9 } }, { @@ -7575,6 +7692,20 @@ "lineNumber": 380 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts", + "lineNumber": 2 + } + }, { "plugin": "securitySolution", "link": { @@ -8072,7 +8203,8 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - } + }, + ") | undefined" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", @@ -9078,6 +9210,20 @@ "lineNumber": 36 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts", + "lineNumber": 66 + } + }, { "plugin": "infra", "link": { @@ -9120,6 +9266,27 @@ "lineNumber": 12 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts", + "lineNumber": 10 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts", + "lineNumber": 23 + } + }, { "plugin": "infra", "link": { @@ -9152,123 +9319,221 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "lineNumber": 2 + "lineNumber": 1 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "lineNumber": 6 + "lineNumber": 5 } }, { - "plugin": "infra", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 2 + "path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts", + "lineNumber": 3 } }, { - "plugin": "infra", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 12 + "path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts", + "lineNumber": 25 } }, { - "plugin": "infra", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts", + "path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts", + "lineNumber": 55 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts", "lineNumber": 1 } }, { - "plugin": "infra", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts", - "lineNumber": 4 + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts", + "lineNumber": 20 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts", - "lineNumber": 2 + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts", + "lineNumber": 21 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts", + "path": "x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts", "lineNumber": 3 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts", - "lineNumber": 4 + "path": "x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts", + "lineNumber": 9 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx", - "lineNumber": 12 + "path": "x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts", + "lineNumber": 2 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx", - "lineNumber": 412 + "path": "x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts", + "lineNumber": 40 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_delete/use_delete_action.tsx", - "lineNumber": 12 + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts", + "lineNumber": 2 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_delete/use_delete_action.tsx", - "lineNumber": 60 + "path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts", + "lineNumber": 10 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts", - "lineNumber": 8 + "path": "x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts", + "lineNumber": 1 } }, { - "plugin": "ml", + "plugin": "securitySolution", "link": { - "path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts", - "lineNumber": 37 + "path": "x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts", + "lineNumber": 25 } }, { - "plugin": "ml", + "plugin": "infra", "link": { - "path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts", - "lineNumber": 8 + "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", + "lineNumber": 1 } }, { - "plugin": "ml", + "plugin": "infra", "link": { - "path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts", + "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", "lineNumber": 11 } }, { - "plugin": "ml", + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "infra", + "link": { + "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts", + "lineNumber": 4 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts", + "lineNumber": 3 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts", + "lineNumber": 4 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx", + "lineNumber": 12 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx", + "lineNumber": 412 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_delete/use_delete_action.tsx", + "lineNumber": 12 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_delete/use_delete_action.tsx", + "lineNumber": 60 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts", + "lineNumber": 8 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts", + "lineNumber": 37 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts", + "lineNumber": 8 + } + }, + { + "plugin": "ml", + "link": { + "path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts", + "lineNumber": 11 + } + }, + { + "plugin": "ml", "link": { "path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx", "lineNumber": 25 @@ -9831,7 +10096,7 @@ "plugin": "maps", "link": { "path": "x-pack/plugins/maps/public/embeddable/types.ts", - "lineNumber": 45 + "lineNumber": 44 } }, { @@ -10828,7 +11093,8 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - } + }, + ">" ], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", @@ -10940,7 +11206,32 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 136 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptionsTimePattern", + "text": "GetFieldsOptionsTimePattern" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 136 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -10964,7 +11255,32 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 137 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 137 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -11506,7 +11822,7 @@ "label": "type", "description": [], "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"ip\" | \"double\"" + "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\"" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", @@ -11570,7 +11886,32 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 103 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 103 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -11588,7 +11929,36 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 104 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 104 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 104 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -11606,7 +11976,68 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 105 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 106 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 107 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 108 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 109 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -11624,7 +12055,55 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 111 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 112 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 113 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 114 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -11640,7 +12119,36 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 116 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 116 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 116 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -11845,7 +12353,23 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 88 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 88 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -11861,7 +12385,9 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 89 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -11877,7 +12403,39 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 90 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 90 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 90 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -11893,7 +12451,23 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 91 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 91 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -11926,7 +12500,15 @@ "label": "FieldFormatMap", "description": [], "signature": [ - "{ [x: string]: SerializedFieldFormat>; }" + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">; }" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", @@ -11960,7 +12542,15 @@ "label": "IndexPatternFieldMap", "description": [], "signature": [ - "{ [x: string]: FieldSpec; }" + "{ [x: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "; }" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", @@ -11977,7 +12567,14 @@ "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -12012,7 +12609,175 @@ "label": "IndexPatternsContract", "description": [], "signature": [ - "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; find: (search: string, size?: number) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + "{ get: (id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; delete: (indexPatternId: string) => Promise<{}>; create: (spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; find: (search: string, size?: number) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>; ensureDefaultIndexPattern: ", + "EnsureDefaultIndexPattern", + "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", + "SavedObject", + "<", + "IndexPatternSavedObjectAttrs", + ">[] | null | undefined>; getDefault: () => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; getFieldsForWildcard: (options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise; getFieldsForIndexPattern: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise; refreshFields: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise; fieldArrayToMap: (fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record; savedObjectToSpec: (savedObject: ", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + "; createAndSave: (spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; createSavedObject: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">; updateSavedObject: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", @@ -12079,7 +12844,7 @@ "label": "RuntimeType", "description": [], "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"ip\" | \"double\"" + "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\"" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", diff --git a/api_docs/data_query.json b/api_docs/data_query.json index c8fff2616931ef..a9c17111369510 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -528,15 +528,23 @@ "label": "setFiltersStore", "description": [], "signature": [ - "typeof ", + "(filters: ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" }, - ".setFiltersStore" + "[], store: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + ", shouldOverrideStore?: boolean) => void" ], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", @@ -794,7 +802,114 @@ "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQueryService", "text": "SavedQueryService" - } + }, + "; 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: ", + "TimefilterSetup", + "; getEsQuery: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }; } | { filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; timefilter: ", + "TimefilterSetup", + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; 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\">, stateContainer: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.BaseStateContainer", + "text": "BaseStateContainer" + }, + ", syncConfig: { time?: boolean | undefined; refreshInterval?: boolean | undefined; filters?: boolean | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + " | undefined; query?: boolean | undefined; }) => () => void" ], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", @@ -837,7 +952,96 @@ "text": "SavedQueryService" }, "; state$: ", - "Observable" + "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: ", + "TimefilterSetup", + "; getEsQuery: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }; } | { filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; timefilter: ", + "TimefilterSetup", + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; 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\">" ], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", @@ -852,7 +1056,9 @@ "type": "Object", "tags": [], "label": "stateContainer", - "description": [], + "description": [ + "to use for syncing" + ], "signature": [ { "pluginId": "kibanaUtils", @@ -1099,7 +1305,104 @@ "text": "SavedQueryService" }, "; state$: ", - "Observable" + "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: ", + "TimefilterSetup", + "; getEsQuery: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }; } | { filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; timefilter: ", + "TimefilterSetup", + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; 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\">, kbnUrlStateStorage: ", + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + }, + ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" ], "source": { "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", @@ -1142,7 +1445,96 @@ "text": "SavedQueryService" }, "; state$: ", - "Observable" + "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: ", + "TimefilterSetup", + "; getEsQuery: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }; } | { filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; timefilter: ", + "TimefilterSetup", + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; 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\">" ], "source": { "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", @@ -1157,7 +1549,9 @@ "type": "Object", "tags": [], "label": "kbnUrlStateStorage", - "description": [], + "description": [ + "to use for syncing" + ], "signature": [ { "pluginId": "kibanaUtils", @@ -1430,7 +1824,42 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "SavedQueryAttributes" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 30 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "{ overwrite: boolean; } | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -1454,7 +1883,9 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -1472,13 +1903,64 @@ "section": "def-public.SavedQuery", "text": "SavedQuery" }, - "[]; }>" - ], - "source": { - "path": "src/plugins/data/public/query/saved_query/types.ts", - "lineNumber": 34 - }, - "deprecated": false + "[]; }>" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 34 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.searchText", + "type": "string", + "tags": [], + "label": "searchText", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 35 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 36 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.activePage", + "type": "number", + "tags": [], + "label": "activePage", + "description": [], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 37 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -1502,7 +1984,23 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 39 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 39 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -1518,7 +2016,23 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 40 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 40 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -1534,7 +2048,9 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 41 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1595,15 +2111,25 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, - ") => void; filterManager: FilterManager; queryString: Pick; savedQueries: ", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; queryString: Pick<", + "QueryStringManager", + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", "section": "def-public.SavedQueryService", "text": "SavedQueryService" }, @@ -1613,7 +2139,7 @@ { "pluginId": "data", "scope": "public", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-public.QueryStateChange", "text": "QueryStateChange" }, @@ -1621,10 +2147,53 @@ { "pluginId": "data", "scope": "public", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-public.QueryState", "text": "QueryState" - } + }, + "; }>; timefilter: ", + "TimefilterSetup", + "; getEsQuery: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: { must: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + "[]; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; should: never[]; must_not: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; }; }; }" ], "source": { "path": "src/plugins/data/public/query/query_service.ts", @@ -1641,7 +2210,22 @@ "label": "SavedQueryTimeFilter", "description": [], "signature": [ - "TimeRange & { refreshInterval: RefreshInterval; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " & { refreshInterval: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; }" ], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", @@ -1666,8 +2250,129 @@ "Observable", "; getAutoRefreshFetch$: () => ", "Observable", - "; getFetch$: () => ", - "Observable" + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.AutoRefreshDoneFn", + "text": "AutoRefreshDoneFn" + }, + ">; getFetch$: () => ", + "Observable", + "; getTime: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; getAbsoluteTime: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; setTime: (time: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.InputTimeRange", + "text": "InputTimeRange" + }, + ") => void; getRefreshInterval: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; setRefreshInterval: (refreshInterval: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + ">) => void; createFilter: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined; getBounds: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + "; calculateBounds: (timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + "; getActiveBounds: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; getRefreshIntervalDefaults: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; }" ], "source": { "path": "src/plugins/data/public/query/timefilter/timefilter.ts", @@ -1684,7 +2389,23 @@ "label": "TimeHistoryContract", "description": [], "signature": [ - "{ add: (time: TimeRange) => void; get: () => TimeRange[]; }" + "{ add: (time: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => void; get: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "[]; }" ], "source": { "path": "src/plugins/data/public/query/timefilter/time_history.ts", @@ -1831,7 +2552,8 @@ "docId": "kibDataQueryPluginApi", "section": "def-common.FilterCompareOptions", "text": "FilterCompareOptions" - } + }, + ") => boolean" ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", @@ -1845,7 +2567,9 @@ "type": "CompoundType", "tags": [], "label": "first", - "description": [], + "description": [ + "The first filter or filter array to compare" + ], "signature": [ { "pluginId": "data", @@ -1877,7 +2601,9 @@ "type": "CompoundType", "tags": [], "label": "second", - "description": [], + "description": [ + "The second filter or filter array to compare" + ], "signature": [ { "pluginId": "data", @@ -1909,7 +2635,9 @@ "type": "Object", "tags": [], "label": "comparatorOptions", - "description": [], + "description": [ + "Parameters to use for comparison" + ], "signature": [ { "pluginId": "data", @@ -1988,7 +2716,9 @@ "type": "Array", "tags": [], "label": "existingFilters", - "description": [], + "description": [ + "- The filters to compare to" + ], "signature": [ { "pluginId": "data", @@ -2012,7 +2742,9 @@ "type": "Array", "tags": [], "label": "filters", - "description": [], + "description": [ + "- The filters being added" + ], "signature": [ { "pluginId": "data", @@ -2036,7 +2768,9 @@ "type": "Object", "tags": [], "label": "comparatorOptions", - "description": [], + "description": [ + "- Parameters to use for comparison" + ], "signature": [ { "pluginId": "data", @@ -2414,7 +3148,9 @@ "type": "Array", "tags": [], "label": "filters", - "description": [], + "description": [ + "The filters to remove duplicates from" + ], "signature": [ { "pluginId": "data", @@ -2438,7 +3174,9 @@ "type": "Any", "tags": [], "label": "comparatorOptions", - "description": [], + "description": [ + "- Parameters to use for comparison" + ], "signature": [ "any" ], diff --git a/api_docs/data_search.json b/api_docs/data_search.json index ba115706cb0631..81fa9660d32fe7 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -815,9 +815,45 @@ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ - "Pick<", - "SessionService", - ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + "{ start: () => string; destroy: () => void; readonly state$: ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionState", + "text": "SearchSessionState" + }, + ">; readonly sessionMeta$: ", + "Observable", + "<", + "SessionMeta", + ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", + "TrackSearchDescriptor", + ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", + "Observable", + "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionInfoProvider", + "text": "SearchSessionInfoProvider" + }, + ", searchSessionIndicatorUiConfig?: ", + "SearchSessionIndicatorUiConfig", + " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", + "SearchSessionIndicatorUiConfig", + "; }" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -835,9 +871,75 @@ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "signature": [ - "Pick<", - "SessionsClient", - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" + "{ get: (sessionId: string) => Promise<", + "SearchSessionSavedObject", + ">; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise<", + "SearchSessionSavedObject", + ">; find: (options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; update: (sessionId: string, attributes: unknown) => 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" + }, + ">>; rename: (sessionId: string, newName: string) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">>; extend: (sessionId: string, expires: string) => 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>>; }" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -873,13 +975,91 @@ "\nagg config sub service\n{@link AggsStart}\n" ], "signature": [ - "Pick & Pick<{ types: ", - "AggTypesRegistryStart", - "; }, \"types\"> & Pick<{ types: ", + "{ calculateAutoTimeExpression: (range: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => string | undefined; datatableUtilities: { getIndexPattern: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined>; getAggConfig: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined>; isFilterable: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => boolean; }; createAggConfigs: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", configStates?: Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + "; types: ", "AggTypesRegistryStart", - "; }, never>, \"calculateAutoTimeExpression\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" + "; }" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -897,19 +1077,97 @@ "\nlow level search\n{@link ISearchGeneric}" ], "signature": [ + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", SearchStrategyResponse extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">(request: SearchStrategyRequest, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 53 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.request", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -925,7 +1183,26 @@ "path": "src/plugins/data/public/search/types.ts", "lineNumber": 55 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.e", + "type": "Object", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "Error" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 55 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -961,9 +1238,45 @@ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ - "Pick<", - "SessionService", - ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + "{ start: () => string; destroy: () => void; readonly state$: ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionState", + "text": "SearchSessionState" + }, + ">; readonly sessionMeta$: ", + "Observable", + "<", + "SessionMeta", + ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", + "TrackSearchDescriptor", + ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", + "Observable", + "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionInfoProvider", + "text": "SearchSessionInfoProvider" + }, + ", searchSessionIndicatorUiConfig?: ", + "SearchSessionIndicatorUiConfig", + " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", + "SearchSessionIndicatorUiConfig", + "; }" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -981,9 +1294,75 @@ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "signature": [ - "Pick<", - "SessionsClient", - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" + "{ get: (sessionId: string) => Promise<", + "SearchSessionSavedObject", + ">; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise<", + "SearchSessionSavedObject", + ">; find: (options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; update: (sessionId: string, attributes: unknown) => 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" + }, + ">>; rename: (sessionId: string, newName: string) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">>; extend: (sessionId: string, expires: string) => 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>>; }" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -1227,15 +1606,153 @@ "label": "toasts", "description": [], "signature": [ - "Pick<", + "{ get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastsApi", - "text": "ToastsApi" + "section": "def-public.Toast", + "text": "Toast" }, - ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + "; }" ], "source": { "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", @@ -1268,9 +1785,45 @@ "label": "session", "description": [], "signature": [ - "Pick<", - "SessionService", - ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + "{ start: () => string; destroy: () => void; readonly state$: ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionState", + "text": "SearchSessionState" + }, + ">; readonly sessionMeta$: ", + "Observable", + "<", + "SessionMeta", + ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", + "TrackSearchDescriptor", + ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", + "Observable", + "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionInfoProvider", + "text": "SearchSessionInfoProvider" + }, + ", searchSessionIndicatorUiConfig?: ", + "SearchSessionIndicatorUiConfig", + " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", + "SearchSessionIndicatorUiConfig", + "; }" ], "source": { "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", @@ -1322,7 +1875,9 @@ "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 46 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -1372,7 +1927,9 @@ "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 54 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1455,7 +2012,16 @@ "label": "IEsError", "description": [], "signature": [ - "KibanaServerError" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KibanaServerError", + "text": "KibanaServerError" + }, + "<", + "IEsErrorAttributes", + ">" ], "source": { "path": "src/plugins/data/public/search/errors/types.ts", @@ -1472,7 +2038,75 @@ "label": "ISessionsClient", "description": [], "signature": [ - "{ get: (sessionId: string) => Promise; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise; find: (options: Pick) => Promise>; update: (sessionId: string, attributes: unknown) => Promise>; rename: (sessionId: string, newName: string) => Promise>>; extend: (sessionId: string, expires: string) => Promise>; }" + "{ get: (sessionId: string) => Promise<", + "SearchSessionSavedObject", + ">; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise<", + "SearchSessionSavedObject", + ">; find: (options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; update: (sessionId: string, attributes: unknown) => 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" + }, + ">>; rename: (sessionId: string, newName: string) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">>; extend: (sessionId: string, expires: string) => 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>>; }" ], "source": { "path": "src/plugins/data/public/search/session/sessions_client.ts", @@ -1489,7 +2123,45 @@ "label": "ISessionService", "description": [], "signature": [ - "{ start: () => string; destroy: () => void; readonly state$: Observable; readonly sessionMeta$: Observable; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => () => void; getSessionId: () => string | undefined; getSession$: () => Observable; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }" + "{ start: () => string; destroy: () => void; readonly state$: ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionState", + "text": "SearchSessionState" + }, + ">; readonly sessionMeta$: ", + "Observable", + "<", + "SessionMeta", + ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", + "TrackSearchDescriptor", + ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", + "Observable", + "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionInfoProvider", + "text": "SearchSessionInfoProvider" + }, + ", searchSessionIndicatorUiConfig?: ", + "SearchSessionIndicatorUiConfig", + " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", + "SearchSessionIndicatorUiConfig", + "; }" ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", @@ -1501,15 +2173,12 @@ { "parentPluginId": "data", "id": "def-public.noSearchSessionStorageCapabilityMessage", - "type": "Any", + "type": "string", "tags": [], "label": "noSearchSessionStorageCapabilityMessage", "description": [ "\nMessage to display in case storing\nsession session is disabled due to turned off capability" ], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/public/search/session/i18n.ts", "lineNumber": 15 @@ -1612,7 +2281,8 @@ ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>) => Pick<", "Search", "<", - "RequestBody" + "RequestBody", + ">>, \"timeout\">" ], "source": { "path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts", @@ -2040,7 +2710,39 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 91 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ [P in keyof T]?: T[P] | undefined; }" + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 28 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2058,7 +2760,23 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 92 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2076,7 +2794,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"pit\">) => Promise<", + ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", @@ -2090,7 +2808,52 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 93 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ filter?: any; aggs?: Record | undefined; fields?: string[] | undefined; searchAfter?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; search?: string | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; pit?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" + }, + " | undefined; }" + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2114,7 +2877,39 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 94 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 31 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ [P in keyof T]?: T[P] | undefined; }" + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2130,7 +2925,23 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 95 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 32 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2146,7 +2957,23 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 96 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 33 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2170,7 +2997,39 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 97 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 34 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.expires", + "type": "Object", + "tags": [], + "label": "expires", + "description": [], + "signature": [ + "Date" + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2230,7 +3089,32 @@ "path": "src/plugins/data/server/search/session/types.ts", "lineNumber": 39 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 39 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2313,13 +3197,53 @@ "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStrategy", "text": "ISearchStrategy" - } + }, + ") => void" ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 53 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.strategy", + "type": "Object", + "tags": [], + "label": "strategy", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStrategy", + "text": "ISearchStrategy" + }, + "" + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 54 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2412,7 +3336,26 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 110 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 111 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2443,7 +3386,33 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 113 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 113 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2537,7 +3506,70 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 76 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.request", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 77 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 78 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.deps", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" + } + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 79 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -2627,15 +3659,307 @@ "label": "savedObjectsClient", "description": [], "signature": [ - "Pick<", + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + "; }" ], "source": { "path": "src/plugins/data/server/search/types.ts", @@ -2811,7 +4135,13 @@ "label": "SearchRequestHandlerContext", "description": [], "signature": [ - "IScopedSearchClient" + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.IScopedSearchClient", + "text": "IScopedSearchClient" + } ], "source": { "path": "src/plugins/data/server/search/types.ts", @@ -2850,15 +4180,7 @@ "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" ], "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ".ensureIds" + "(list: any[]) => any[]" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -2902,7 +4224,7 @@ "\nCalculate the next id based on the ids in this list\n" ], "signature": [ - "typeof ", + "(list: ", { "pluginId": "data", "scope": "common", @@ -2910,7 +4232,7 @@ "section": "def-common.AggConfig", "text": "AggConfig" }, - ".nextId" + "[]) => number" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -3993,9 +5315,34 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -4015,9 +5362,34 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -4513,7 +5885,8 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" - } + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">, { addToAggConfigs }?: { addToAggConfigs?: boolean | undefined; }) => T" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -5379,7 +6752,44 @@ "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; schema?: string | undefined; } | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5666,7 +7076,7 @@ "\nThe type the values produced by this agg will have in the final data table.\nIf not specified, the type of the field is used." ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -5692,7 +7102,30 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 112 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "- label that can be used in the ui to describe the aggConfig" + ], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [ + "- an agg config of this type" + ], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 112 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5806,7 +7239,28 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 165 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "- an array of aggConfig objects\n that should replace this one,\n or undefined" + ], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 165 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5826,7 +7280,28 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 176 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "- an array of aggConfig objects\n that should replace this one,\n or undefined" + ], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 176 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5844,7 +7319,9 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 181 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -5858,13 +7335,356 @@ "\nA function that needs to be called after the main request has been made\nand should return an updated response" ], "signature": [ - "PostFlightRequestFn" + "(resp: ", + "SearchResponse", + ", aggConfigs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", aggConfig: TAggConfig, searchSource: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise<", + "SearchResponse", + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 194 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.resp", + "type": "Object", + "tags": [], + "label": "resp", + "description": [ + "- Response to the main request" + ], + "signature": [ + "SearchResponse", + "" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.aggConfigs", + "type": "Object", + "tags": [], + "label": "aggConfigs", + "description": [ + "- agg config array used to produce main request" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 25 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [ + "- AggConfig that requested the post flight request" + ], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.searchSource", + "type": "Object", + "tags": [], + "label": "searchSource", + "description": [], + "signature": [ + "{ create: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; removeField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setFields: (newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getId: () => string; getFields: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; getField: (field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; getOwnField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; createCopy: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; createChild: (options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setParent: (parent?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getParent: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | undefined; fetch$: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">>; fetch: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise<", + "SearchResponse", + ">; onRequestStart: (handler: (searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; serialize: () => { searchSourceJSON: string; references: ", + "SavedObjectReference", + "[]; }; }" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.inspectorRequestAdapter", + "type": "Object", + "tags": [], + "label": "inspectorRequestAdapter", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.abortSignal", + "type": "Object", + "tags": [], + "label": "abortSignal", + "description": [ + "- `AbortSignal` to abort the request" + ], + "signature": [ + "AbortSignal | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 29 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.searchSessionId", + "type": "string", + "tags": [], + "label": "searchSessionId", + "description": [ + "- searchSessionId to be used for grouping requests into a single search session" + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5892,7 +7712,28 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 204 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [ + "- the agg to pick a format for" + ], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 204 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -5908,7 +7749,42 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 206 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 206 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.bucket", + "type": "Any", + "tags": [], + "label": "bucket", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 206 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -6324,7 +8200,81 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 21 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 22 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.output", + "type": "Object", + "tags": [], + "label": "output", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.aggConfigs", + "type": "Object", + "tags": [], + "label": "aggConfigs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.locals", + "type": "Object", + "tags": [], + "label": "locals", + "description": [], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -6340,7 +8290,42 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 27 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -6356,7 +8341,42 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 28 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 28 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -6446,7 +8466,73 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 45 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.aggConfig", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 46 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.searchSource", + "type": "Object", + "tags": [], + "label": "searchSource", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 48 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -6540,7 +8626,58 @@ "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 44 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.bucket", + "type": "Any", + "tags": [], + "label": "bucket", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "Any", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TBucketAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 44 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -6962,10 +9099,19 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldTypes", - "text": "FieldTypes" - } + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | \"*\" | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -7492,7 +9638,9 @@ "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 43 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -7932,7 +10080,7 @@ "\nsets value to a single search source field" ], "signature": [ - "(field: K, value: ", + "(field: K, value: ", { "pluginId": "data", "scope": "common", @@ -8006,7 +10154,7 @@ "\nremove field" ], "signature": [ - "(field: K) => this" + "(field: K) => this" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", @@ -8149,7 +10297,7 @@ "\nGets a single field from the fields" ], "signature": [ - "(field: K, recurse?: boolean) => ", + "(field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", @@ -8212,7 +10360,7 @@ "\nGet the field from our own fields, don't traverse up the chain" ], "signature": [ - "(field: K) => ", + "(field: K) => ", { "pluginId": "data", "scope": "common", @@ -8898,7 +11046,8 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" - } + }, + "; }" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", @@ -10018,7 +12167,9 @@ "type": "Object", "tags": [], "label": "indexPatterns", - "description": [], + "description": [ + "The index patterns contract of the data plugin" + ], "signature": [ "Pick<", { @@ -10924,7 +13075,26 @@ "path": "src/plugins/data/common/search/expressions/esdsl.ts", "lineNumber": 45 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getKibanaRequest", + "type": "Any", + "tags": [], + "label": "getKibanaRequest", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] } ] } @@ -10991,7 +13161,23 @@ "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 27 + }, + "deprecated": false + } + ] } ] } @@ -12000,19 +14186,45 @@ "label": "getConfig", "description": [], "signature": [ + "(key: string, defaultOverride?: T | undefined) => T" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 + }, + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "lineNumber": 35 - }, - "deprecated": false + ] } ] } @@ -12778,6 +14990,31 @@ "lineNumber": 21 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12857,6 +15094,31 @@ "lineNumber": 23 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12882,6 +15144,31 @@ "lineNumber": 22 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 14 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -13884,7 +16171,44 @@ "label": "aggFilter", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilter\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"filter\">, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13900,7 +16224,44 @@ "label": "aggFilters", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilters\", any, Pick, \"enabled\" | \"id\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"schema\" | \"json\" | \"timeShift\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13916,7 +16277,44 @@ "label": "aggSignificantTerms", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSignificantTerms\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BUCKET_TYPES", + "text": "BUCKET_TYPES" + }, + ".SIGNIFICANT_TERMS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13932,7 +16330,44 @@ "label": "aggIpRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggIpRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ipRangeType\" | \"ranges\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13948,7 +16383,44 @@ "label": "aggDateRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ranges\" | \"time_zone\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13964,7 +16436,44 @@ "label": "aggRange", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"ranges\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13980,7 +16489,44 @@ "label": "aggGeoTile", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoTile\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BUCKET_TYPES", + "text": "BUCKET_TYPES" + }, + ".GEOTILE_GRID>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -13996,7 +16542,44 @@ "label": "aggGeoHash", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoHash\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\" | \"boundingBox\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14012,7 +16595,44 @@ "label": "aggHistogram", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, \"extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\" | \"extended_bounds\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14028,7 +16648,44 @@ "label": "aggDateHistogram", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, \"timeRange\" | \"extended_bounds\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"timeRange\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"extended_bounds\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14044,7 +16701,48 @@ "label": "aggTerms", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggTerms\", any, Pick, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\"> & Pick<{ orderAgg?: ", + "AggExpressionType", + " | undefined; }, \"orderAgg\"> & Pick<{ orderAgg?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"orderAgg\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14060,7 +16758,44 @@ "label": "aggAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggAvg\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".AVG>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14076,7 +16811,52 @@ "label": "aggBucketAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14092,7 +16872,52 @@ "label": "aggBucketMax", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketMax\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14108,7 +16933,52 @@ "label": "aggBucketMin", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketMin\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14124,7 +16994,52 @@ "label": "aggBucketSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggBucketSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14140,7 +17055,52 @@ "label": "aggFilteredMetric", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilteredMetric\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", + "AggExpressionType", + " | undefined; customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14156,7 +17116,44 @@ "label": "aggCardinality", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCardinality\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".CARDINALITY>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14172,7 +17169,44 @@ "label": "aggCount", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCount\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".COUNT>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14188,7 +17222,48 @@ "label": "aggCumulativeSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggCumulativeSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14204,7 +17279,48 @@ "label": "aggDerivative", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDerivative\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14220,7 +17336,44 @@ "label": "aggGeoBounds", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoBounds\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".GEO_BOUNDS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14236,7 +17389,44 @@ "label": "aggGeoCentroid", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggGeoCentroid\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".GEO_CENTROID>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14252,7 +17442,44 @@ "label": "aggMax", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMax\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MAX>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14268,7 +17495,44 @@ "label": "aggMedian", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMedian\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MEDIAN>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14284,7 +17548,44 @@ "label": "aggSinglePercentile", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSinglePercentile\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".SINGLE_PERCENTILE>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14300,7 +17601,44 @@ "label": "aggMin", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMin\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".MIN>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14316,7 +17654,48 @@ "label": "aggMovingAvg", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggMovingAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14332,7 +17711,44 @@ "label": "aggPercentileRanks", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggPercentileRanks\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".PERCENTILE_RANKS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14348,7 +17764,44 @@ "label": "aggPercentiles", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggPercentiles\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".PERCENTILES>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14364,7 +17817,48 @@ "label": "aggSerialDiff", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSerialDiff\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", + "AggExpressionType", + " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14380,7 +17874,44 @@ "label": "aggStdDeviation", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggStdDeviation\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".STD_DEV>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14396,7 +17927,44 @@ "label": "aggSum", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSum\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".SUM>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -14412,7 +17980,44 @@ "label": "aggTopHit", "description": [], "signature": [ - "FunctionDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggTopHit\", any, ", + "AggExpressionFunctionArgs", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.METRIC_TYPES", + "text": "METRIC_TYPES" + }, + ".TOP_HITS>, ", + "AggExpressionType", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -15793,7 +19398,7 @@ "label": "interval", "description": [], "signature": [ - "React.ReactText" + "string | number" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", @@ -17192,7 +20797,7 @@ "label": "valueType", "description": [], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -17560,13 +21165,47 @@ "label": "calculateBounds", "description": [], "signature": [ - "CalculateBoundsFn" + "(timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 48 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.timeRange", + "type": "Object", + "tags": [], + "label": "timeRange", + "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -17582,7 +21221,9 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -17598,7 +21239,23 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 50 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 50 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17630,7 +21287,9 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "data", @@ -17646,7 +21305,23 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 28 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 28 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17672,7 +21347,7 @@ "label": "from", "description": [], "signature": [ - "React.ReactText" + "string | number" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", @@ -17688,7 +21363,7 @@ "label": "to", "description": [], "signature": [ - "React.ReactText" + "string | number" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", @@ -17838,19 +21513,45 @@ "label": "getConfig", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - } + "(key: string, defaultOverride?: T | undefined) => T" ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 22 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -17884,7 +21585,49 @@ "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 27 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17916,7 +21659,23 @@ "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 33 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17948,7 +21707,23 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -17972,7 +21747,9 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 32 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -18193,7 +21970,32 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 36 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.bounds", + "type": "Object", + "tags": [], + "label": "bounds", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AutoBounds", + "text": "AutoBounds" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 36 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18216,7 +22018,9 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 37 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -18642,19 +22446,97 @@ "label": "search", "description": [], "signature": [ + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", SearchStrategyResponse extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchGeneric", - "text": "ISearchGeneric" - } + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">(request: SearchStrategyRequest, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.request", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18666,19 +22548,60 @@ "\nUsed to cancel an in-progress search request." ], "signature": [ + "(id: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchCancelGeneric", - "text": "ISearchCancelGeneric" - } + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 21 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 21 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18690,19 +22613,73 @@ "\nUsed to extend the TTL of an in-progress search request." ], "signature": [ + "(id: string, keepAlive: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchExtendGeneric", - "text": "ISearchExtendGeneric" - } + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 37 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.keepAlive", + "type": "string", + "tags": [], + "label": "keepAlive", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -18928,7 +22905,33 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -18954,7 +22957,9 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 35 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -18997,7 +23002,39 @@ "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 28 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.fieldDisplayName", + "type": "string", + "tags": [], + "label": "fieldDisplayName", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 28 + }, + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19013,7 +23050,9 @@ "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -19243,7 +23282,32 @@ "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.agg", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -19283,7 +23347,9 @@ "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -19323,7 +23389,9 @@ "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 26 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -20020,7 +24088,7 @@ "\nMapping of search request hashes to their corresponsing info (async search id, etc.)" ], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/data/common/search/session/types.ts", @@ -20142,19 +24210,97 @@ "label": "search", "description": [], "signature": [ + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", SearchStrategyResponse extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchGeneric", - "text": "ISearchGeneric" - } + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 123 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.request", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 18 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -20313,7 +24459,16 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirectionNumeric", "text": "SortDirectionNumeric" - } + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionFormat", + "text": "SortDirectionFormat" + }, + ">[] | undefined" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -21165,7 +25320,17 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + "{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -21505,7 +25670,22 @@ "label": "AggParam", "description": [], "signature": [ - "BaseParamType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", @@ -21630,11 +25810,59 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, - ") => string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick string | undefined; datatableUtilities: { getIndexPattern: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined>; getAggConfig: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined>; isFilterable: (column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => boolean; }; createAggConfigs: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", configStates?: Pick & Pick<{ type: string | ", { @@ -21652,7 +25880,17 @@ "section": "def-common.IAggType", "text": "IAggType" }, - "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + "; types: ", + "AggTypesRegistryStart", + "; }" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -21737,7 +25975,27 @@ "label": "AggTypesRegistrySetup", "description": [], "signature": [ - "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" + "{ registerBucket: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + ">(name: N, type: T) => void; registerMetric: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + ">(name: N, type: T) => void; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", @@ -21771,7 +26029,7 @@ "label": "boundsDescendingRaw", "description": [], "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: any; intervalLabel: any; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: any; intervalLabel: any; })[]" + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", @@ -21788,7 +26046,15 @@ "label": "CreateAggConfigParams", "description": [], "signature": [ - "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", "SerializableState", " | undefined; }" ], @@ -21841,7 +26107,8 @@ "label": "EqlRequestParams", "description": [], "signature": [ - "EqlSearch>" + "EqlSearch", + ">" ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", @@ -21858,7 +26125,16 @@ "label": "EqlSearchStrategyResponse", "description": [], "signature": [ - "IKibanaSearchResponse>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "ApiResponse", + ">" ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", @@ -21892,7 +26168,14 @@ "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -21927,23 +26210,14 @@ "label": "EsdslExpressionFunctionDefinition", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"esdsl\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "> | null, Arguments, Output, ", + "<\"esdsl\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -21960,7 +26234,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/esdsl.ts", @@ -21977,11 +26252,7 @@ "label": "EsQuerySearchAfter", "description": [], "signature": [ - "[", - "ReactText", - ", ", - "ReactText", - "]" + "[React.ReactText, React.ReactText]" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -21998,7 +26269,31 @@ "label": "EsQuerySortValue", "description": [], "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" + "{ [x: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionNumeric", + "text": "SortDirectionNumeric" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionFormat", + "text": "SortDirectionFormat" + }, + "; }" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -22015,7 +26310,30 @@ "label": "EsRawResponseExpressionTypeDefinition", "description": [], "signature": [ - "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "<\"es_raw_response\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", @@ -22032,7 +26350,39 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + "{ filters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined; query?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[] | undefined; timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -22049,7 +26399,14 @@ "label": "ExpressionFunctionExistsFilter", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"existsFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"existsFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22082,7 +26439,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", @@ -22099,7 +26457,14 @@ "label": "ExpressionFunctionField", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"field\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"field\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22110,9 +26475,9 @@ "<\"kibana_field\", ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.IndexPatternField", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", "text": "IndexPatternField" }, ">, ", @@ -22132,7 +26497,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", @@ -22149,15 +26515,14 @@ "label": "ExpressionFunctionKibana", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ExecutionContextSearch> | null, object, ", + "<\"kibana\", Input, object, ", { "pluginId": "expressions", "scope": "common", @@ -22165,7 +26530,39 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -22182,15 +26579,14 @@ "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + "<\"kibana_context\", Input, Arguments, Promise<", { "pluginId": "expressions", "scope": "common", @@ -22198,7 +26594,39 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", @@ -22215,7 +26643,14 @@ "label": "ExpressionFunctionKibanaFilter", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kibanaFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"kibanaFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22226,9 +26661,9 @@ "<\"kibana_filter\", ", { "pluginId": "data", - "scope": "public", + "scope": "common", "docId": "kibDataPluginApi", - "section": "def-public.Filter", + "section": "def-common.Filter", "text": "Filter" }, ">, ", @@ -22248,7 +26683,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", @@ -22265,7 +26701,38 @@ "label": "ExpressionFunctionKibanaTimerange", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"timerange\", null, TimeRange, ExpressionValueBoxed<\"timerange\", TimeRange>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"timerange\", null, ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"timerange\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ">, ", { "pluginId": "expressions", "scope": "common", @@ -22300,7 +26767,14 @@ "label": "ExpressionFunctionKql", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"kql\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"kql\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22312,7 +26786,7 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, @@ -22333,7 +26807,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", @@ -22350,7 +26825,14 @@ "label": "ExpressionFunctionLucene", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"lucene\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"lucene\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22362,7 +26844,7 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", + "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, @@ -22383,7 +26865,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", @@ -22400,7 +26883,14 @@ "label": "ExpressionFunctionPhraseFilter", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"rangeFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"rangeFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22433,7 +26923,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", @@ -22450,7 +26941,22 @@ "label": "ExpressionFunctionRange", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"range\", null, Arguments, ExpressionValueBoxed<\"kibana_range\", Arguments>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"range\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_range\", Arguments>, ", { "pluginId": "expressions", "scope": "common", @@ -22485,7 +26991,14 @@ "label": "ExpressionFunctionRangeFilter", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"rangeFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"rangeFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -22518,7 +27031,8 @@ "text": "Adapters" }, ", ", - "SerializableState" + "SerializableState", + ">>" ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", @@ -22535,7 +27049,14 @@ "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -22559,23 +27080,7 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, - "._SOURCE | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - }, - ".ATTACHMENT | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - }, - ".BOOLEAN | ", + " | \"*\" | ", { "pluginId": "data", "scope": "common", @@ -22583,14 +27088,7 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, - ".DATE | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - } + "[]" ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -22607,15 +27105,71 @@ "label": "GenericBucket", "description": [], "signature": [ + "(", "CompositeBucketKeys", " & { [property: string]: ", "Aggregate", - "; } | { [property: string]: ", + "; }) | ({ [property: string]: ", "Aggregate", "; } & { [property: string]: ", "Aggregate", - "; } | ", - "DateHistogramBucketKeys" + "; }) | (", + "DateHistogramBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | (", + "FiltersBucketItemKeys", + " & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | (", + "IpRangeBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | (", + "RangeBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | (", + "RareTermsBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | (", + "SignificantTermsBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; }) | ({ [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; }) | (", + "KeyedBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; })" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -22635,7 +27189,13 @@ "label": "IAggConfig", "description": [], "signature": [ - "AggConfig" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -22652,7 +27212,38 @@ "label": "IAggType", "description": [], "signature": [ - "AggType>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -22669,7 +27260,16 @@ "label": "IEsSearchResponse", "description": [], "signature": [ - "IKibanaSearchResponse>" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -22686,7 +27286,13 @@ "label": "IFieldParamType", "description": [], "signature": [ - "FieldParamType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldParamType", + "text": "FieldParamType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -22703,7 +27309,22 @@ "label": "IMetricAggType", "description": [], "signature": [ - "MetricAggType" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", @@ -22720,7 +27341,7 @@ "label": "intervalOptions", "description": [], "signature": [ - "({ display: any; val: string; enabled(agg: ", + "({ display: string; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", @@ -22728,7 +27349,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean; } | { display: any; val: string; })[]" + "): boolean; } | { display: string; val: string; })[]" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", @@ -22810,7 +27431,7 @@ "label": "ISearchCancelGeneric", "description": [], "signature": [ - "(id: string, options: ", + "(id: string, options?: ", { "pluginId": "data", "scope": "common", @@ -22835,7 +27456,7 @@ "label": "ISearchExtendGeneric", "description": [], "signature": [ - "(id: string, keepAlive: string, options: ", + "(id: string, keepAlive: string, options?: ", { "pluginId": "data", "scope": "common", @@ -22860,7 +27481,39 @@ "label": "ISearchGeneric", "description": [], "signature": [ - "(request: SearchStrategyRequest, options: ", + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", SearchStrategyResponse extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", @@ -22906,7 +27559,8 @@ "label": "ISearchRequestParams", "description": [], "signature": [ - "{ trackTotalHits?: boolean | undefined; } & estypes.SearchRequest" + "{ trackTotalHits?: boolean | undefined; } & ", + "SearchRequest" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -22925,12 +27579,132 @@ "\nsearch source interface" ], "signature": [ - "{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ", + "{ create: () => ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.ISearchOptions", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; removeField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setFields: (newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getId: () => string; getFields: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; getField: (field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; getOwnField: (field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]; createCopy: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; createChild: (options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; setParent: (parent?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + "; getParent: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | undefined; fetch$: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", @@ -22938,9 +27712,9 @@ "<", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.IKibanaSearchResponse", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", @@ -22948,11 +27722,40 @@ ">>; fetch: (options?: ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.ISearchOptions", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", "text": "ISearchOptions" - } + }, + ") => Promise<", + "SearchResponse", + ">; onRequestStart: (handler: (searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "; serialize: () => { searchSourceJSON: string; references: ", + "SavedObjectReference", + "[]; }; }" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -22986,7 +27789,14 @@ "label": "KibanaContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -23003,7 +27813,14 @@ "label": "KibanaField", "description": [], "signature": [ - "{ type: \"kibana_field\"; } & IndexPatternField" + "{ type: \"kibana_field\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -23020,7 +27837,14 @@ "label": "KibanaFilter", "description": [], "signature": [ - "{ type: \"kibana_filter\"; } & Filter" + "{ type: \"kibana_filter\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -23037,7 +27861,14 @@ "label": "KibanaQueryOutput", "description": [], "signature": [ - "{ type: \"kibana_query\"; } & Query" + "{ type: \"kibana_query\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -23071,7 +27902,14 @@ "label": "KibanaTimerangeOutput", "description": [], "signature": [ - "{ type: \"timerange\"; } & TimeRange" + "{ type: \"timerange\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", @@ -23083,13 +27921,10 @@ { "parentPluginId": "data", "id": "def-common.parentPipelineType", - "type": "Any", + "type": "string", "tags": [], "label": "parentPipelineType", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 28 @@ -23105,7 +27940,9 @@ "label": "ParsedInterval", "description": [], "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + "{ value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", @@ -23168,13 +28005,10 @@ { "parentPluginId": "data", "id": "def-common.siblingPipelineType", - "type": "Any", + "type": "string", "tags": [], "label": "siblingPipelineType", - "description": [], - "signature": [ - "any" - ], + "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 35 @@ -23217,13 +28051,10 @@ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Buckets", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 @@ -23233,13 +28064,10 @@ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Metrics", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 @@ -23249,13 +28077,10 @@ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.None", - "type": "Any", + "type": "string", "tags": [], "label": "[AggGroupNames.None]", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 @@ -23273,7 +28098,7 @@ "label": "AggGroupNames", "description": [], "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -23444,13 +28269,10 @@ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 31 @@ -23518,13 +28340,10 @@ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 38 @@ -23581,13 +28400,10 @@ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 45 @@ -23734,13 +28550,10 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 30 @@ -23808,13 +28621,10 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 37 @@ -23871,13 +28681,10 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 44 @@ -23918,13 +28725,10 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.script.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 50 @@ -24071,13 +28875,10 @@ { "parentPluginId": "data", "id": "def-common.kibana.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 32 @@ -24145,7 +28946,8 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" - } + }, + ">" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -24392,13 +29194,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 29 @@ -24482,13 +29281,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 37 @@ -24545,13 +29341,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 44 @@ -24682,13 +29475,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 26 @@ -24756,13 +29546,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 33 @@ -24819,13 +29606,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 40 @@ -24882,13 +29666,10 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 47 @@ -25033,13 +29814,10 @@ { "parentPluginId": "data", "id": "def-common.kqlFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 28 @@ -25123,13 +29901,10 @@ { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 36 @@ -25260,13 +30035,10 @@ { "parentPluginId": "data", "id": "def-common.luceneFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 28 @@ -25350,13 +30122,10 @@ { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 36 @@ -25431,15 +30200,33 @@ "label": "migrateIncludeExcludeFormat", "description": [], "signature": [ - "Partial<", + "{ scriptable?: boolean | undefined; filterFieldTypes?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + " | \"*\" | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[] | undefined; makeAgg?: ((agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.BucketAggParam", - "text": "BucketAggParam" + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" }, - "<", + ", state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; schema?: string | undefined; } | undefined) => ", { "pluginId": "data", "scope": "common", @@ -25447,7 +30234,87 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - ">>" + ") | undefined; allowedAggs?: string[] | undefined; name?: string | undefined; type?: string | undefined; displayName?: string | undefined; required?: boolean | undefined; advanced?: boolean | undefined; default?: any; write?: ((aggConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ", output: Record, aggConfigs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined, locals?: Record | undefined) => void) | undefined; serialize?: ((value: any, aggConfig?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + " | undefined) => any) | undefined; deserialize?: ((value: any, aggConfig?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + " | undefined) => any) | undefined; toExpressionAst?: ((value: any) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined) | undefined; options?: any[] | undefined; valueType?: any; onChange?: ((agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ") => void) | undefined; shouldShow?: ((agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ") => boolean) | undefined; modifyAggConfigOnSearchRequestStart?: ((aggConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ", searchSource?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => void) | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", @@ -25472,13 +30339,10 @@ { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.subtype", - "type": "Any", + "type": "string", "tags": [], "label": "subtype", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 36 @@ -25636,13 +30500,10 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 32 @@ -25710,13 +30571,10 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 39 @@ -25789,13 +30647,10 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 47 @@ -25852,13 +30707,10 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 54 @@ -26005,13 +30857,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 33 @@ -26079,13 +30928,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 40 @@ -26142,13 +30988,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 47 @@ -26205,13 +31048,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 54 @@ -26358,13 +31198,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 32 @@ -26416,13 +31253,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 38 @@ -26463,13 +31297,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 44 @@ -26510,13 +31341,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 50 @@ -26557,13 +31385,10 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 56 @@ -26646,13 +31471,10 @@ { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.subtype", - "type": "Any", + "type": "string", "tags": [], "label": "subtype", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 43 diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json index f7a679350fa3b3..4a532af99a115f 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -101,13 +101,7 @@ "label": "query", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - } + "{ query: string | { [key: string]: any; }; language: string; }" ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", @@ -514,7 +508,11 @@ "label": "IndexPatternSelectProps", "description": [], "signature": [ - "Pick, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\"> & globalThis.Required, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; onNoIndexPatterns?: (() => void) | undefined; }" + "Pick, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"data-test-subj\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"autoFocus\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"data-test-subj\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"autoFocus\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\"> & Required, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"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-label\" | \"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\" | \"css\" | \"data-test-subj\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"autoFocus\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; onNoIndexPatterns?: (() => void) | undefined; }" ], "source": { "path": "src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx", @@ -526,12 +524,28 @@ { "parentPluginId": "data", "id": "def-public.SearchBar", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "SearchBar", "description": [], "signature": [ - "any" + "React.ComponentClass, \"filters\" | \"query\" | \"placeholder\" | \"iconType\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"isClearable\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>; }" ], "source": { "path": "src/plugins/data/public/ui/search_bar/index.tsx", @@ -548,7 +562,8 @@ "label": "SearchBarProps", "description": [], "signature": [ - "SearchBarOwnProps & SearchBarInjectedDeps" + "SearchBarOwnProps", + " & SearchBarInjectedDeps" ], "source": { "path": "src/plugins/data/public/ui/search_bar/search_bar.tsx", @@ -565,7 +580,8 @@ "label": "StatefulSearchBarProps", "description": [], "signature": [ - "SearchBarOwnProps & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" + "SearchBarOwnProps", + " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" ], "source": { "path": "src/plugins/data/public/ui/search_bar/create_search_bar.tsx", diff --git a/api_docs/deprecations.mdx b/api_docs/deprecations.mdx index d1f7f56bfb9c14..36acb26d4b9917 100644 --- a/api_docs/deprecations.mdx +++ b/api_docs/deprecations.mdx @@ -82,8 +82,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| -| | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts#L1) | 7.16 | -| | [types.d.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/target/types/server/types.d.ts#L30) | 7.16 | | | [plugin.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L16) | 7.16 | | | [plugin.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L27) | 7.16 | @@ -99,20 +97,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [saved_objects.ts#L13](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#L13) | - | | | [saved_dashboards.ts#L12](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboards.ts#L12) | - | | | [saved_dashboards.ts#L31](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboards.ts#L31) | - | -| | [types.ts#L25](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/types.ts#L25) | - | -| | [types.ts#L74](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/types.ts#L74) | - | +| | [types.ts#L33](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#L33) | - | +| | [types.ts#L186](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#L186) | - | | | [plugin.tsx#L42](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#L42) | - | | | [plugin.tsx#L127](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#L127) | - | | | [url_generator.ts#L19](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/url_generator.ts#L19) | - | | | [url_generator.ts#L95](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/url_generator.ts#L95) | - | | | [saved_objects.ts#L11](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#L11) | - | | | [saved_dashboard.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L10) | - | -| | [saved_dashboard.ts#L18](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L18) | - | +| | [saved_dashboard.ts#L19](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L19) | - | +| | [dashboard_tagging.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#L10) | - | +| | [dashboard_tagging.ts#L15](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#L15) | - | | | [clone_panel_action.tsx#L14](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#L14) | - | | | [clone_panel_action.tsx#L98](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#L98) | - | | | [clone_panel_action.tsx#L126](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#L126) | - | -| | [use_dashboard_state_manager.ts#L23](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/hooks/use_dashboard_state_manager.ts#L23) | - | -| | [use_dashboard_state_manager.ts#L35](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/hooks/use_dashboard_state_manager.ts#L35) | - | @@ -155,7 +153,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| | | [attribute_service.tsx#L13](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L13) | - | -| | [attribute_service.tsx#L167](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L167) | - | +| | [attribute_service.tsx#L165](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L165) | - | @@ -235,13 +233,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [types.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L9) | 7.16 | | | [types.ts#L39](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L39) | 7.16 | | | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L1) | 7.16 | -| | [types.d.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L25) | 7.16 | +| | [types.d.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L24) | 7.16 | | | [types.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L10) | 7.16 | | | [types.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L42) | 7.16 | | | [types.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L49) | 7.16 | | | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L1) | 7.16 | -| | [types.d.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L27) | 7.16 | -| | [types.d.ts#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L33) | 7.16 | +| | [types.d.ts#L26](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L26) | 7.16 | +| | [types.d.ts#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#L32) | 7.16 | @@ -356,10 +354,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [expression_chart.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_chart.d.ts#L7) | - | | | [use_metrics_explorer_chart_data.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.d.ts#L1) | - | | | [use_metrics_explorer_chart_data.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.d.ts#L4) | - | -| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L2) | - | -| | [index.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L6) | - | -| | [use_metric_explorer_state.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L2) | - | -| | [use_metric_explorer_state.d.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L12) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L1) | - | +| | [index.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L5) | - | +| | [use_metric_explorer_state.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L1) | - | +| | [use_metric_explorer_state.d.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L11) | - | | | [use_metrics_explorer_data.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts#L1) | - | | | [use_metrics_explorer_data.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts#L4) | - | | | [index.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/index.tsx#L14) | - | @@ -400,30 +398,30 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [metrics.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/metrics.tsx#L21) | - | | | [group_by_expression.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts#L2) | - | | | [group_by_expression.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts#L5) | - | -| | [selector.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L2) | - | -| | [selector.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L6) | - | +| | [selector.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L1) | - | +| | [selector.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L5) | - | | | [expression.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts#L2) | - | | | [expression.d.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts#L37) | - | -| | [metric.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L2) | - | -| | [metric.d.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L18) | - | +| | [metric.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L1) | - | +| | [metric.d.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L17) | - | | | [expression_row.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts#L2) | - | | | [expression_row.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts#L6) | - | | | [criteria.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts#L2) | - | | | [criteria.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts#L6) | - | | | [criterion.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts#L2) | - | | | [criterion.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts#L7) | - | -| | [group_by.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L2) | - | -| | [group_by.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L7) | - | -| | [metrics.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L2) | - | -| | [metrics.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L9) | - | +| | [group_by.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L1) | - | +| | [group_by.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L6) | - | +| | [metrics.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L1) | - | +| | [metrics.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L8) | - | | | [custom_field_panel.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts#L2) | - | | | [custom_field_panel.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts#L6) | - | | | [waffle_group_by_controls.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts#L2) | - | | | [waffle_group_by_controls.d.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts#L16) | - | | | [custom_metric_form.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L2) | - | | | [custom_metric_form.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L8) | - | -| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L2) | - | -| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L10) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L1) | - | +| | [index.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L9) | - | | | [group_by.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/group_by.tsx#L12) | - | | | [group_by.tsx#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/group_by.tsx#L18) | - | | | [expression_row.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.tsx#L21) | - | @@ -456,30 +454,30 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [metrics.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/metrics.tsx#L21) | - | | | [group_by_expression.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts#L2) | - | | | [group_by_expression.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts#L5) | - | -| | [selector.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L2) | - | -| | [selector.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L6) | - | +| | [selector.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L1) | - | +| | [selector.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L5) | - | | | [expression.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts#L2) | - | | | [expression.d.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts#L37) | - | -| | [metric.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L2) | - | -| | [metric.d.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L18) | - | +| | [metric.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L1) | - | +| | [metric.d.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L17) | - | | | [expression_row.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts#L2) | - | | | [expression_row.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts#L6) | - | | | [criteria.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts#L2) | - | | | [criteria.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts#L6) | - | | | [criterion.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts#L2) | - | | | [criterion.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts#L7) | - | -| | [group_by.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L2) | - | -| | [group_by.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L7) | - | -| | [metrics.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L2) | - | -| | [metrics.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L9) | - | +| | [group_by.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L1) | - | +| | [group_by.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L6) | - | +| | [metrics.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L1) | - | +| | [metrics.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L8) | - | | | [custom_field_panel.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts#L2) | - | | | [custom_field_panel.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts#L6) | - | | | [waffle_group_by_controls.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts#L2) | - | | | [waffle_group_by_controls.d.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts#L16) | - | | | [custom_metric_form.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L2) | - | | | [custom_metric_form.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L8) | - | -| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L2) | - | -| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L10) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L1) | - | +| | [index.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L9) | - | | | [with_kuery_autocompletion.tsx#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/with_kuery_autocompletion.tsx#L9) | - | | | [with_kuery_autocompletion.tsx#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/containers/with_kuery_autocompletion.tsx#L24) | - | | | [kuery_bar.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/kuery_bar.tsx#L15) | - | @@ -512,10 +510,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [expression_chart.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_chart.d.ts#L7) | - | | | [use_metrics_explorer_chart_data.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.d.ts#L1) | - | | | [use_metrics_explorer_chart_data.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.d.ts#L4) | - | -| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L2) | - | -| | [index.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L6) | - | -| | [use_metric_explorer_state.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L2) | - | -| | [use_metric_explorer_state.d.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L12) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L1) | - | +| | [index.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts#L5) | - | +| | [use_metric_explorer_state.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L1) | - | +| | [use_metric_explorer_state.d.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts#L11) | - | | | [use_metrics_explorer_data.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts#L1) | - | | | [use_metrics_explorer_data.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts#L4) | - | | | [index.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/index.tsx#L14) | - | @@ -556,32 +554,30 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [metrics.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/metrics.tsx#L21) | - | | | [group_by_expression.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts#L2) | - | | | [group_by_expression.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts#L5) | - | -| | [selector.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L2) | - | -| | [selector.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L6) | - | +| | [selector.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L1) | - | +| | [selector.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts#L5) | - | | | [expression.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts#L2) | - | | | [expression.d.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts#L37) | - | -| | [metric.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L2) | - | -| | [metric.d.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L18) | - | +| | [metric.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L1) | - | +| | [metric.d.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts#L17) | - | | | [expression_row.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts#L2) | - | | | [expression_row.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts#L6) | - | | | [criteria.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts#L2) | - | | | [criteria.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts#L6) | - | | | [criterion.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts#L2) | - | | | [criterion.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts#L7) | - | -| | [group_by.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L2) | - | -| | [group_by.d.ts#L7](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L7) | - | -| | [metrics.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L2) | - | -| | [metrics.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L9) | - | +| | [group_by.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L1) | - | +| | [group_by.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts#L6) | - | +| | [metrics.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L1) | - | +| | [metrics.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts#L8) | - | | | [custom_field_panel.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts#L2) | - | | | [custom_field_panel.d.ts#L6](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts#L6) | - | | | [waffle_group_by_controls.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts#L2) | - | | | [waffle_group_by_controls.d.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts#L16) | - | | | [custom_metric_form.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L2) | - | | | [custom_metric_form.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L8) | - | -| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L2) | - | -| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L10) | - | -| | [log_entry_categories_analysis.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts#L1) | 7.16 | -| | [log_entry_categories_analysis.d.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts#L58) | 7.16 | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L1) | - | +| | [index.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L9) | - | @@ -928,6 +924,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [get_call_cluster.mock.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts#L9) | 7.16 | | | [get_call_cluster.mock.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts#L27) | 7.16 | | | [get_call_cluster.mock.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/server/schemas/common/get_call_cluster.mock.ts#L31) | 7.16 | +| | [get_call_cluster.mock.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/target/types/server/schemas/common/get_call_cluster.mock.d.ts#L2) | 7.16 | +| | [get_call_cluster.mock.d.ts#L4](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/target/types/server/schemas/common/get_call_cluster.mock.d.ts#L4) | 7.16 | +| | [get_call_cluster.mock.d.ts#L5](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lists/target/types/server/schemas/common/get_call_cluster.mock.d.ts#L5) | 7.16 | @@ -936,7 +935,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| | | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L8) | - | -| | [types.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L45) | - | +| | [types.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L44) | - | | | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - | | | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - | | | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - | @@ -1126,7 +1125,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [get_docvalue_source_fields.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L10) | - | | | [get_docvalue_source_fields.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L12) | - | | | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L8) | - | -| | [types.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L45) | - | +| | [types.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L44) | - | | | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - | | | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - | | | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - | @@ -1617,6 +1616,25 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.tsx#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx#L44) | - | | | [index.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx#L21) | - | | | [index.tsx#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx#L33) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts#L1) | - | +| | [index.d.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts#L66) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts#L1) | - | +| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts#L10) | - | +| | [index.d.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts#L23) | - | +| | [types.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts#L3) | - | +| | [types.d.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts#L25) | - | +| | [types.d.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts#L55) | - | +| | [columns.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts#L1) | - | +| | [columns.d.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts#L20) | - | +| | [columns.d.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts#L21) | - | +| | [index.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts#L3) | - | +| | [index.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts#L9) | - | +| | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts#L2) | - | +| | [types.d.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts#L40) | - | +| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts#L2) | - | +| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts#L10) | - | +| | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts#L1) | - | +| | [types.d.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts#L25) | - | | | [types.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/navigation/types.ts#L9) | - | | | [types.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/navigation/types.ts#L35) | - | | | [types.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/navigation/types.ts#L53) | - | @@ -1696,6 +1714,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [helpers.test.ts#L363](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L363) | - | | | [helpers.test.ts#L371](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L371) | - | | | [helpers.test.ts#L380](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L380) | - | +| | [helpers.test.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts#L1) | - | +| | [helpers.test.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts#L2) | - | | | [index.tsx#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L32) | - | | | [index.tsx#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L86) | - | | | [index.tsx#L305](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L305) | - | @@ -1746,6 +1766,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [helpers.test.ts#L363](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L363) | - | | | [helpers.test.ts#L371](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L371) | - | | | [helpers.test.ts#L380](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L380) | - | +| | [helpers.test.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts#L1) | - | +| | [helpers.test.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts#L2) | - | | | [index.tsx#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L32) | - | | | [index.tsx#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L86) | - | | | [index.tsx#L305](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L305) | - | @@ -1808,6 +1830,25 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.tsx#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx#L44) | - | | | [index.tsx#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx#L21) | - | | | [index.tsx#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx#L33) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts#L1) | - | +| | [index.d.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts#L66) | - | +| | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts#L1) | - | +| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts#L10) | - | +| | [index.d.ts#L23](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts#L23) | - | +| | [types.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts#L3) | - | +| | [types.d.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts#L25) | - | +| | [types.d.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts#L55) | - | +| | [columns.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts#L1) | - | +| | [columns.d.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts#L20) | - | +| | [columns.d.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts#L21) | - | +| | [index.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts#L3) | - | +| | [index.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts#L9) | - | +| | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts#L2) | - | +| | [types.d.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts#L40) | - | +| | [index.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts#L2) | - | +| | [index.d.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts#L10) | - | +| | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts#L1) | - | +| | [types.d.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts#L25) | - | | | [types.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/navigation/types.ts#L9) | - | | | [types.ts#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/navigation/types.ts#L35) | - | | | [types.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/navigation/types.ts#L53) | - | @@ -1887,6 +1928,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [helpers.test.ts#L363](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L363) | - | | | [helpers.test.ts#L371](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L371) | - | | | [helpers.test.ts#L380](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/helpers.test.ts#L380) | - | +| | [helpers.test.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts#L1) | - | +| | [helpers.test.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/target/types/public/common/components/exceptions/helpers.test.d.ts#L2) | - | | | [index.tsx#L32](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L32) | - | | | [index.tsx#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L86) | - | | | [index.tsx#L305](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L305) | - | diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json index 5f9212c1bfca98..e06a7b38613719 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -204,7 +204,30 @@ "path": "src/plugins/dev_tools/public/plugin.ts", "lineNumber": 32 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "devTools", + "id": "def-public.devTool", + "type": "CompoundType", + "tags": [], + "label": "devTool", + "description": [ + "The dev tools descriptor" + ], + "signature": [ + "Pick<", + "DevToolApp", + ", \"title\" | \"id\" | \"order\" | \"mount\" | \"tooltipContent\" | \"enableRouting\"> & { disabled?: boolean | undefined; }" + ], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 32 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", diff --git a/api_docs/discover.json b/api_docs/discover.json index e7ba58f16fb9f7..3ded38e306768e 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -539,7 +539,9 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 22 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "discover", @@ -563,7 +565,32 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 23 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "discover", + "id": "def-public.saveOptions", + "type": "Object", + "tags": [], + "label": "saveOptions", + "description": [], + "signature": [ + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectSaveOpts", + "text": "SavedObjectSaveOpts" + } + ], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "discover", @@ -651,7 +678,23 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "discover", + "id": "def-public.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "discover", @@ -667,7 +710,23 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "discover", + "id": "def-public.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -710,13 +769,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" ], "source": { "path": "src/plugins/discover/public/application/embeddable/types.ts", diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json index 7c7d8b78607eb1..e575671b5ef226 100644 --- a/api_docs/discover_enhanced.json +++ b/api_docs/discover_enhanced.json @@ -344,7 +344,8 @@ "text": "Action" }, "<", - "ExploreDataChartActionContext" + "ExploreDataChartActionContext", + ">" ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", @@ -724,15 +725,41 @@ "label": "uiActions", "description": [], "signature": [ - "Pick<", + "{ readonly addTriggerAction: (triggerId: string, action: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", - "section": "def-public.UiActionsService", - "text": "UiActionsService" + "section": "def-public.ActionDefinition", + "text": "ActionDefinition" }, - ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" + ") => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: >(definition: A) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "<", + "ActionContext", + ">; readonly registerTrigger: (trigger: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Trigger", + "text": "Trigger" + }, + ") => void; readonly unregisterAction: (actionId: string) => void; }" ], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", @@ -849,7 +876,7 @@ "label": "uiActions", "description": [], "signature": [ - "Pick<", + "{ readonly clear: () => void; readonly fork: () => ", { "pluginId": "uiActions", "scope": "public", @@ -857,17 +884,77 @@ "section": "def-public.UiActionsService", "text": "UiActionsService" }, - ", ", - "MethodKeysOf", + "; readonly addTriggerAction: (triggerId: string, action: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionDefinition", + "text": "ActionDefinition" + }, + ") => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: >(definition: A) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, "<", + "ActionContext", + ">; readonly registerTrigger: (trigger: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", - "section": "def-public.UiActionsService", - "text": "UiActionsService" + "section": "def-public.Trigger", + "text": "Trigger" + }, + ") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ", + "TriggerContract", + "; readonly hasAction: (actionId: string) => boolean; readonly getAction: >(id: string) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "<", + "ActionContext", + ">; readonly getTriggerActions: (triggerId: string) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" }, - ">>" + "[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise; }" ], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json index 9d77663b21731f..d560148f35b136 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -128,7 +128,26 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", @@ -184,7 +203,18 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - } + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">, ", + "SavedObjectAttributes", + ">>" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", @@ -267,7 +297,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "() => any" + "() => string" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", @@ -580,7 +610,18 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - } + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">, ", + "SavedObjectAttributes", + ">) | undefined" ], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", @@ -1072,7 +1113,26 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", @@ -1258,7 +1318,24 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(type: string, explicitInput: Partial) => Promise" ], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", @@ -1596,7 +1673,8 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" - } + }, + "" ], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", @@ -1906,7 +1984,26 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", @@ -1973,7 +2070,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "({ embeddable }: ActionContext) => any" + "({ embeddable }: ActionContext) => string" ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", @@ -2691,7 +2788,16 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" - } + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", @@ -3741,7 +3847,9 @@ "type": "string", "tags": [], "label": "appId", - "description": [], + "description": [ + "- The id of the app to fetch the title for" + ], "signature": [ "string" ], @@ -4505,7 +4613,36 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ", T extends ", + "SavedObjectAttributes", + " = ", + "SavedObjectAttributes", + ">(def: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" + }, + ") => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", @@ -4581,7 +4718,9 @@ "type": "CompoundType", "tags": [], "label": "props", - "description": [], + "description": [ + "- {@link EmbeddableRendererProps}" + ], "signature": [ { "pluginId": "embeddable", @@ -4832,7 +4971,32 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.RangeSelectContext", "text": "RangeSelectContext" - } + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">>" ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", @@ -5150,7 +5314,32 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.ValueClickContext", "text": "ValueClickContext" - } + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">>" ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", @@ -5257,70 +5446,186 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - } - ], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 16 - }, - "deprecated": false, - "children": [ + }, + ", O extends ", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.options", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 16 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.options.embeddable", - "type": "Object", - "tags": [], - "label": "embeddable", - "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" - }, - ">" - ], - "source": { - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "lineNumber": 17 - }, - "deprecated": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.options.getFactory", - "type": "Function", + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", E extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined; getAllFactories: () => IterableIterator<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">, ", + "SavedObjectAttributes", + ">>; overlays: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayStart", + "text": "OverlayStart" + }, + "; notifications: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + }, + "; SavedObjectFinder: React.ComponentType; showCreateNewMenu?: boolean | undefined; }) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout.$1.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout.$1.options.embeddable", + "type": "Object", + "tags": [], + "label": "embeddable", + "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" + }, + ">" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout.$1.options.getFactory", + "type": "Function", "tags": [], "label": "getFactory", "description": [], @@ -5364,13 +5669,48 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 18 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.embeddableFactoryId", + "type": "string", + "tags": [], + "label": "embeddableFactoryId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 81 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -5419,13 +5759,26 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - } + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">, ", + "SavedObjectAttributes", + ">>" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 19 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "embeddable", @@ -5479,7 +5832,7 @@ "label": "SavedObjectFinder", "description": [], "signature": [ - "React.ComponentType" + "React.ComponentClass | React.FunctionComponent" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", @@ -5856,7 +6209,7 @@ "label": "PanelComponent", "description": [], "signature": [ - "React.FC<{ embeddable: ", + "React.FunctionComponent<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", @@ -5886,7 +6239,42 @@ "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 22 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 554 + }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 554 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -6073,7 +6461,9 @@ "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 48 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "embeddable", @@ -6827,15 +7217,41 @@ "label": "uiActions", "description": [], "signature": [ - "Pick<", + "{ readonly addTriggerAction: (triggerId: string, action: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", - "section": "def-public.UiActionsService", - "text": "UiActionsService" + "section": "def-public.ActionDefinition", + "text": "ActionDefinition" }, - ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" + ") => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: >(definition: A) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "<", + "ActionContext", + ">; readonly registerTrigger: (trigger: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Trigger", + "text": "Trigger" + }, + ") => void; readonly unregisterAction: (actionId: string) => void; }" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", @@ -6867,7 +7283,7 @@ "label": "uiActions", "description": [], "signature": [ - "Pick<", + "{ readonly clear: () => void; readonly fork: () => ", { "pluginId": "uiActions", "scope": "public", @@ -6875,17 +7291,77 @@ "section": "def-public.UiActionsService", "text": "UiActionsService" }, - ", ", - "MethodKeysOf", + "; readonly addTriggerAction: (triggerId: string, action: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionDefinition", + "text": "ActionDefinition" + }, + ") => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: >(definition: A) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, "<", + "ActionContext", + ">; readonly registerTrigger: (trigger: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", - "section": "def-public.UiActionsService", - "text": "UiActionsService" + "section": "def-public.Trigger", + "text": "Trigger" }, - ">>" + ") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ", + "TriggerContract", + "; readonly hasAction: (actionId: string) => boolean; readonly getAction: >(id: string) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "<", + "ActionContext", + ">; readonly getTriggerActions: (triggerId: string) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise; }" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", @@ -7224,7 +7700,16 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - } + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">>(id: string) => E" ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", @@ -7339,7 +7824,24 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.Embeddable", "text": "Embeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + ">(type: string, explicitInput: Partial) => Promise<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | E>" ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", @@ -7785,7 +8287,16 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" - } + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", @@ -8206,7 +8717,26 @@ "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 24 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.input", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "ValTypeInput | RefTypeInput" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 24 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -8224,7 +8754,9 @@ "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "embeddable", @@ -8242,7 +8774,9 @@ "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 34 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -8494,7 +9028,23 @@ "label": "EmbeddableFactoryDefinition", "description": [], "signature": [ - "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" + "Pick<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + ", \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts", @@ -8511,7 +9061,23 @@ "label": "EmbeddableInput", "description": [], "signature": [ - "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" + "{ viewMode?: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.ViewMode", + "text": "ViewMode" + }, + " | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" ], "source": { "path": "src/plugins/embeddable/common/types.ts", @@ -8528,7 +9094,7 @@ "label": "EmbeddablePanelHOC", "description": [], "signature": [ - "(props: React.PropsWithChildren<{ embeddable: ", + "React.FunctionComponent<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", @@ -8552,7 +9118,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">; hideHeader?: boolean | undefined; }>, context: any) => React.ReactElement | null" + ">; hideHeader?: boolean | undefined; }>" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", @@ -8679,13 +9245,10 @@ { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 50 @@ -8695,13 +9258,10 @@ { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.description", - "type": "Any", + "type": "string", "tags": [], "label": "description", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 53 @@ -8740,13 +9300,10 @@ { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 61 @@ -8756,13 +9313,10 @@ { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.description", - "type": "Any", + "type": "string", "tags": [], "label": "description", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 64 @@ -8801,13 +9355,10 @@ { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.title", - "type": "Any", + "type": "string", "tags": [], "label": "title", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 72 @@ -8817,13 +9368,10 @@ { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.description", - "type": "Any", + "type": "string", "tags": [], "label": "description", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 75 @@ -8894,13 +9442,78 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactoryDefinition", "text": "EmbeddableFactoryDefinition" - } + }, + ") => () => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.factory", + "type": "CompoundType", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + ", \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 69 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -8932,7 +9545,41 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.enhancement", + "type": "Object", + "tags": [], + "label": "enhancement", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" + }, + "<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">" + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 71 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -8950,7 +9597,94 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 72 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.customProvider", + "type": "Function", + "tags": [], + "label": "customProvider", + "description": [], + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ", T extends ", + "SavedObjectAttributes", + " = ", + "SavedObjectAttributes", + ">(def: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" + }, + ") => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "" + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 72 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", @@ -9042,13 +9776,48 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" - } + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 76 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.embeddableFactoryId", + "type": "string", + "tags": [], + "label": "embeddableFactoryId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 81 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -9097,13 +9866,26 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - } + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">, ", + "SavedObjectAttributes", + ">>" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 83 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "embeddable", @@ -9113,7 +9895,7 @@ "label": "EmbeddablePanel", "description": [], "signature": [ - "React.FC<{ embeddable: ", + "React.FunctionComponent<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", @@ -9143,7 +9925,42 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 84 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 554 + }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 554 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -9174,7 +9991,33 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 85 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.storage", + "type": "Object", + "tags": [], + "label": "storage", + "description": [], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.Storage", + "text": "Storage" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 85 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -9217,13 +10060,55 @@ "text": "SavedObjectEmbeddableInput" }, ">(type: string, options: ", - "AttributeServiceOptions" + "AttributeServiceOptions", + ") => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.AttributeService", + "text": "AttributeService" + }, + "" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 86 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 93 + }, + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "AttributeServiceOptions", + "" + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 94 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -9401,7 +10286,41 @@ "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-server.factory", + "type": "Object", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EmbeddableRegistryDefinition", + "text": "EmbeddableRegistryDefinition" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">" + ], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -9433,7 +10352,41 @@ "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-server.enhancement", + "type": "Object", + "tags": [], + "label": "enhancement", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" + }, + "<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">" + ], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -9449,7 +10402,9 @@ "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "lifecycle": "setup", @@ -9463,7 +10418,22 @@ "label": "EmbeddableStart", "description": [], "signature": [ - "PersistableStateService" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">" ], "source": { "path": "src/plugins/embeddable/server/plugin.ts", @@ -10042,7 +11012,23 @@ "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 70 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-common.embeddableFactoryId", + "type": "string", + "tags": [], + "label": "embeddableFactoryId", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ] }, { "parentPluginId": "embeddable", @@ -10058,7 +11044,23 @@ "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-common.enhancementId", + "type": "string", + "tags": [], + "label": "enhancementId", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 71 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -10190,7 +11192,23 @@ "label": "EmbeddableInput", "description": [], "signature": [ - "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" + "{ viewMode?: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.ViewMode", + "text": "ViewMode" + }, + " | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" ], "source": { "path": "src/plugins/embeddable/common/types.ts", @@ -10207,7 +11225,22 @@ "label": "EmbeddablePersistableStateService", "description": [], "signature": [ - "PersistableStateService" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">" ], "source": { "path": "src/plugins/embeddable/common/types.ts", @@ -10224,7 +11257,14 @@ "label": "EmbeddableStateWithType", "description": [], "signature": [ - "EmbeddableInput & { type: string; }" + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " & { type: string; }" ], "source": { "path": "src/plugins/embeddable/common/types.ts", diff --git a/api_docs/embeddable_enhanced.json b/api_docs/embeddable_enhanced.json index 5edce68bbb31f5..d5e7bb8526bcc1 100644 --- a/api_docs/embeddable_enhanced.json +++ b/api_docs/embeddable_enhanced.json @@ -95,14 +95,6 @@ "label": "embeddable", "description": [], "signature": [ - { - "pluginId": "embeddableEnhanced", - "scope": "public", - "docId": "kibEmbeddableEnhancedPluginApi", - "section": "def-public.EnhancedEmbeddable", - "text": "EnhancedEmbeddable" - }, - "<", { "pluginId": "embeddable", "scope": "public", @@ -126,7 +118,15 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">>" + "> & { enhancements: { dynamicActions: ", + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.DynamicActionManager", + "text": "DynamicActionManager" + }, + "; }; }" ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", @@ -268,13 +268,7 @@ "label": "drilldownGrouping", "description": [], "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.PresentableGrouping", - "text": "PresentableGrouping" - }, + "PresentableGroup", "<{ embeddable?: ", { "pluginId": "embeddable", @@ -299,7 +293,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - "> | undefined; }>" + "> | undefined; }>[]" ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts", @@ -316,7 +310,15 @@ "label": "EnhancedEmbeddable", "description": [], "signature": [ - "E & { enhancements: { dynamicActions: DynamicActionManager;}; }" + "E & { enhancements: { dynamicActions: ", + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.DynamicActionManager", + "text": "DynamicActionManager" + }, + "; }; }" ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json index 82e9d314075b4f..6a699e3534d4bd 100644 --- a/api_docs/encrypted_saved_objects.json +++ b/api_docs/encrypted_saved_objects.json @@ -181,7 +181,59 @@ "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "lineNumber": 41 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 42 + }, + "deprecated": false + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 44 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -305,7 +357,32 @@ "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 36 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.typeRegistration", + "type": "Object", + "tags": [], + "label": "typeRegistration", + "description": [], + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectTypeRegistration", + "text": "EncryptedSavedObjectTypeRegistration" + } + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 36 + }, + "deprecated": false + } + ] }, { "parentPluginId": "encryptedSavedObjects", @@ -315,13 +392,166 @@ "label": "createMigration", "description": [], "signature": [ - "CreateEncryptedSavedObjectsMigrationFn" + "(isMigrationNeededPredicate: IsMigrationNeededPredicate, migration: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationFn", + "text": "SavedObjectMigrationFn" + }, + ", inputType?: ", + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectTypeRegistration", + "text": "EncryptedSavedObjectTypeRegistration" + }, + " | undefined, migratedType?: ", + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectTypeRegistration", + "text": "EncryptedSavedObjectTypeRegistration" + }, + " | undefined) => SavedObjectOptionalMigrationFn" ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 37 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.isMigrationNeededPredicate", + "type": "Function", + "tags": [], + "label": "isMigrationNeededPredicate", + "description": [], + "signature": [ + "(encryptedDoc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + ") => encryptedDoc is ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + "" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", + "lineNumber": 32 + }, + "deprecated": false + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.migration", + "type": "Function", + "tags": [], + "label": "migration", + "description": [], + "signature": [ + "(doc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + ", context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + "" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", + "lineNumber": 33 + }, + "deprecated": false + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.inputType", + "type": "Object", + "tags": [], + "label": "inputType", + "description": [], + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectTypeRegistration", + "text": "EncryptedSavedObjectTypeRegistration" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", + "lineNumber": 34 + }, + "deprecated": false + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.migratedType", + "type": "Object", + "tags": [], + "label": "migratedType", + "description": [], + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectTypeRegistration", + "text": "EncryptedSavedObjectTypeRegistration" + }, + " | undefined" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", + "lineNumber": 35 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", @@ -354,7 +584,26 @@ "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 41 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 41 + }, + "deprecated": false + } + ] }, { "parentPluginId": "encryptedSavedObjects", @@ -364,13 +613,42 @@ "label": "getClient", "description": [], "signature": [ - "ClientInstanciator" + "(options?: ", + "EncryptedSavedObjectsClientOptions", + " | undefined) => ", + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectsClient", + "text": "EncryptedSavedObjectsClient" + } ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 42 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "EncryptedSavedObjectsClientOptions", + " | undefined" + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 33 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", diff --git a/api_docs/enterprise_search.json b/api_docs/enterprise_search.json index f0c8b49bcd00d8..e2b6184c9d36f9 100644 --- a/api_docs/enterprise_search.json +++ b/api_docs/enterprise_search.json @@ -49,7 +49,14 @@ "; accessCheckTimeout: ", "Type", "; accessCheckTimeoutWarning: ", - "Type" + "Type", + "; ssl: ", + "ObjectType", + "<{ certificateAuthorities: ", + "Type", + "; verificationMode: ", + "Type", + "<\"none\" | \"certificate\" | \"full\">; }>; }>" ], "source": { "path": "x-pack/plugins/enterprise_search/server/index.ts", diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json index 55ede83e42dc19..e7117e6be62a05 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -35,15 +35,8 @@ "label": "getDerivedStateFromProps", "description": [], "signature": [ - "typeof ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.CronEditor", - "text": "CronEditor" - }, - ".getDerivedStateFromProps" + "(props: Props) => ", + "FieldToValueMap" ], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", @@ -357,13 +350,32 @@ "label": "JsonEditor", "description": [], "signature": [ - "typeof JsonEditorComp" + "({ label, helpText, onUpdate, value, defaultValue, euiCodeEditorProps, error: propsError, }: Props) => JSX.Element" ], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx", "lineNumber": 102 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "Props" + ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx", + "lineNumber": 25 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1271,7 +1283,9 @@ "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 25 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1377,14 +1391,32 @@ "label": "indexNameBeginsWithPeriod", "description": [], "signature": [ - "typeof ", - "indexNameBeginsWithPeriod" + "(indexName?: string | undefined) => boolean" ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 19 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.indexName", + "type": "string", + "tags": [], + "label": "indexName", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/validate/validate_index.ts", + "lineNumber": 12 + }, + "deprecated": false + } + ] }, { "parentPluginId": "esUiShared", @@ -1394,14 +1426,29 @@ "label": "findIllegalCharactersInIndexName", "description": [], "signature": [ - "typeof ", - "findIllegalCharactersInIndexName" + "(indexName: string) => string[]" ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 20 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.indexName", + "type": "string", + "tags": [], + "label": "indexName", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/validate/validate_index.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ] }, { "parentPluginId": "esUiShared", @@ -1411,14 +1458,29 @@ "label": "indexNameContainsSpaces", "description": [], "signature": [ - "typeof ", - "indexNameContainsSpaces" + "(indexName: string) => boolean" ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 21 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.indexName", + "type": "string", + "tags": [], + "label": "indexName", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/validate/validate_index.ts", + "lineNumber": 34 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false diff --git a/api_docs/event_log.json b/api_docs/event_log.json index cff27c93393352..1d5605105c7c1a 100644 --- a/api_docs/event_log.json +++ b/api_docs/event_log.json @@ -687,7 +687,7 @@ "label": "logEvent", "description": [], "signature": [ - "(properties: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + "(properties: DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -703,7 +703,7 @@ "label": "properties", "description": [], "signature": [ - "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + "DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -723,7 +723,7 @@ "label": "startTiming", "description": [], "signature": [ - "(event: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + "(event: DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -739,7 +739,7 @@ "label": "event", "description": [], "signature": [ - "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + "DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -759,7 +759,7 @@ "label": "stopTiming", "description": [], "signature": [ - "(event: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + "(event: DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -775,7 +775,7 @@ "label": "event", "description": [], "signature": [ - "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + "DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -850,7 +850,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" + "(Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: 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; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" ], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", @@ -872,7 +872,7 @@ "label": "IEvent", "description": [], "signature": [ - "undefined | DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>>" + "DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/generated/schemas.ts", @@ -889,7 +889,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>" + "Readonly<{ kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: 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; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined" ], "source": { "path": "x-pack/plugins/event_log/generated/schemas.ts", @@ -1171,7 +1171,7 @@ "label": "getLogger", "description": [], "signature": [ - "(properties: DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ", + "(properties: DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ", { "pluginId": "eventLog", "scope": "server", @@ -1194,7 +1194,7 @@ "label": "properties", "description": [], "signature": [ - "DeepPartial | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + "DeepPartial[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; rule?: Readonly<{ description?: string | undefined; id?: 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; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", diff --git a/api_docs/expressions.json b/api_docs/expressions.json index 31be4515579245..79a9d016df0710 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -35,12 +35,20 @@ "\nDynamic state of the execution." ], "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContainer", - "text": "ExecutionContainer" + "section": "def-common.ExecutionState", + "text": "ExecutionState" }, ">" + " | undefined; }>>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + ">, {}>" ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", @@ -971,7 +1011,15 @@ "label": "createWithDefaults", "description": [], "signature": [ - "typeof ", + " = Record>(state?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -979,7 +1027,7 @@ "section": "def-common.Executor", "text": "Executor" }, - ".createWithDefaults" + "" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -1022,14 +1070,38 @@ "label": "state", "description": [], "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorContainer", - "text": "ExecutorContainer" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - "" + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureTransitions", + "text": "ExecutorPureTransitions" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureSelectors", + "text": "ExecutorPureSelectors" + }, + ">" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -1448,7 +1520,7 @@ "label": "context", "description": [], "signature": [ - "Record" + "{ [x: string]: unknown; }" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -1499,7 +1571,16 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" - } + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }> | Output>" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -2086,7 +2167,58 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 38 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.input", + "type": "Any", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.handlers", + "type": "Uncategorized", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + "object" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -2172,7 +2304,50 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 56 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.telemetryData", + "type": "Object", + "tags": [], + "label": "telemetryData", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 58 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -2206,7 +2381,34 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 60 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -2240,7 +2442,51 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 65 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -2672,7 +2918,9 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -2709,7 +2957,64 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 17 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.domNode", + "type": "Object", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.handlers", + "type": "Object", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -3244,8 +3549,7 @@ "section": "def-common.ExpressionsInspectorAdapter", "text": "ExpressionsInspectorAdapter" }, - " extends ", - "EventEmitter" + " extends EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", @@ -3339,7 +3643,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "public", @@ -3422,7 +3726,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", @@ -3566,7 +3870,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "public", @@ -3649,7 +3953,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", @@ -4447,7 +4751,72 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 263 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ast", + "type": "CompoundType", + "tags": [], + "label": "ast", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 133 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "Input" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 135 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 136 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -4506,7 +4875,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to extract references from" + ], "signature": [ { "pluginId": "expressions", @@ -4585,7 +4956,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to extract references from" + ], "signature": [ { "pluginId": "expressions", @@ -4648,7 +5021,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to update" + ], "signature": [ { "pluginId": "expressions", @@ -4671,7 +5046,9 @@ "type": "Array", "tags": [], "label": "references", - "description": [], + "description": [ + "array of saved object references" + ], "signature": [ "SavedObjectReference", "[]" @@ -4727,7 +5104,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to update" + ], "signature": [ { "pluginId": "kibanaUtils", @@ -4750,7 +5129,9 @@ "type": "string", "tags": [], "label": "version", - "description": [], + "description": [ + "defines which migration version to run" + ], "signature": [ "string" ], @@ -4784,7 +5165,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", @@ -4899,7 +5280,26 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.type", + "type": "Any", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -5574,8 +5974,7 @@ "section": "def-common.TablesAdapter", "text": "TablesAdapter" }, - " extends ", - "EventEmitter" + " extends EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", @@ -6666,7 +7065,9 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -6678,7 +7079,7 @@ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ - "Record" + "{ [x: string]: unknown; }" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -6696,7 +7097,7 @@ "\nA map of available expression types." ], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -6764,7 +7165,9 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -6952,13 +7355,15 @@ "label": "ast", "description": [], "signature": [ + "{ type: \"expression\"; chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]; }" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -7054,7 +7459,7 @@ "label": "functions", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -7078,7 +7483,7 @@ "label": "types", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -7227,7 +7632,37 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 66 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunctionBuilder[]`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.fnName", + "type": "Uncategorized", + "tags": [], + "label": "fnName", + "description": [ + "Name of the function to search for." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -7254,7 +7689,11 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstExpression`" + ], + "children": [] }, { "parentPluginId": "expressions", @@ -7274,7 +7713,11 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`string`" + ], + "children": [] } ], "initialIsOpen": false @@ -7389,7 +7832,55 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 86 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to add." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 87 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [ + "The value of the argument to add." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 88 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -7417,7 +7908,30 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 99 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunctionBuilderArgument[] | undefined`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to retrieve." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 100 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -7445,7 +7959,56 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 111 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to replace." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 112 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.value", + "type": "Array", + "tags": [], + "label": "value", + "description": [ + "The value of the argument. Must always be an array." + ], + "signature": [ + "(", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 113 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -7465,7 +8028,30 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to remove." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -7492,7 +8078,11 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 130 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunction`" + ], + "children": [] }, { "parentPluginId": "expressions", @@ -7512,7 +8102,11 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`string`" + ], + "children": [] } ], "initialIsOpen": false @@ -7939,9 +8533,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionClog", - "text": "ExpressionFunctionClog" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"clog\", unknown, {}, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -7961,9 +8574,36 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionFont", - "text": "ExpressionFunctionFont" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"font\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -7983,9 +8623,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVarSet", - "text": "ExpressionFunctionVarSet" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var_set\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8005,9 +8664,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVar", - "text": "ExpressionFunctionVar" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8027,9 +8705,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionTheme", - "text": "ExpressionFunctionTheme" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"theme\", null, Arguments, any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8049,9 +8746,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionCumulativeSum", - "text": "ExpressionFunctionCumulativeSum" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"cumulative_sum\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8071,9 +8811,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDerivative", - "text": "ExpressionFunctionDerivative" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"derivative\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8093,9 +8876,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionMovingAverage", - "text": "ExpressionFunctionMovingAverage" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"moving_average\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MovingAverageArgs", + "text": "MovingAverageArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8295,7 +9121,64 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 42 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.domNode", + "type": "Object", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.handlers", + "type": "Object", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -8442,7 +9325,23 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 79 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 79 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -8468,7 +9367,23 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 87 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 87 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -8494,7 +9409,23 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 95 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 95 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -8528,7 +9459,72 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 121 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ast", + "type": "CompoundType", + "tags": [], + "label": "ast", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 122 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "Input" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 123 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 124 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -8570,7 +9566,72 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 132 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ast", + "type": "CompoundType", + "tags": [], + "label": "ast", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 133 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "Input" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 135 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 136 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -8595,7 +9656,9 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 148 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -9161,7 +10224,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -9177,7 +10242,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.fn", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "() => void" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -9193,7 +10277,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -9209,7 +10295,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.params", + "type": "Any", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -9225,7 +10330,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.event", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -9264,7 +10388,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 73 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -9280,7 +10406,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -9944,7 +11072,22 @@ "\nType to capture every possible expression function definition." ], "signature": [ - "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + ", any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", { "pluginId": "inspector", "scope": "common", @@ -9971,7 +11114,14 @@ "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ - "ExpressionTypeDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "" ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", @@ -10009,7 +11159,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -10045,7 +11195,30 @@ "label": "ExecutionContainer", "description": [], "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + ", {}>" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -10062,7 +11235,38 @@ "label": "ExecutorContainer", "description": [], "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureTransitions", + "text": "ExecutorPureTransitions" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureSelectors", + "text": "ExecutorPureSelectors" + }, + ">" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -10079,7 +11283,7 @@ "label": "ExpressionAstArgument", "description": [], "signature": [ - "string | number | false | true | ", + "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", @@ -10103,7 +11307,15 @@ "label": "ExpressionAstExpression", "description": [], "signature": [ - "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + "{ type: \"expression\"; chain: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -10120,7 +11332,23 @@ "label": "ExpressionAstFunction", "description": [], "signature": [ - "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + "{ type: \"function\"; function: string; arguments: Record; debug?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionDebug", + "text": "ExpressionAstFunctionDebug" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -10137,7 +11365,7 @@ "label": "ExpressionAstNode", "description": [], "signature": [ - "string | number | false | true | ", + "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", @@ -10169,7 +11397,7 @@ "label": "ExpressionRendererComponent", "description": [], "signature": [ - "(props: React.PropsWithChildren<", + "React.FunctionComponent<", { "pluginId": "expressions", "scope": "public", @@ -10177,7 +11405,7 @@ "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, - ">, context: any) => React.ReactElement | null" + ">" ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", @@ -10245,7 +11473,23 @@ "label": "ExpressionValueError", "description": [], "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "{ type: \"error\"; } & { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -10264,7 +11508,15 @@ "\nRepresents an object that is a Filter." ], "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"filter\", any>[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", @@ -10393,7 +11645,23 @@ "label": "InterpreterErrorType", "description": [], "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "{ type: \"error\"; } & { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -10432,7 +11700,15 @@ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + "{ type: \"pointseries\"; } & { columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumns", + "text": "PointSeriesColumns" + }, + "; rows: Record[]; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -10451,7 +11727,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -10553,7 +11829,13 @@ "label": "Style", "description": [], "signature": [ - "ExpressionTypeStyle" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + } ], "source": { "path": "src/plugins/expressions/common/types/style.ts", @@ -10572,7 +11854,43 @@ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], "signature": [ - "(T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends string ? \"string\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends boolean ? \"boolean\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends number ? \"number\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends null ? \"null\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends { type: string; } ? ({ type: string; } & (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn))[\"type\"] : never" + "(T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends string ? \"string\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends boolean ? \"boolean\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends number ? \"number\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends null ? \"null\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends { type: string; } ? ({ type: string; } & (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + "))[\"type\"] : never" ], "source": { "path": "src/plugins/expressions/common/types/common.ts", @@ -10647,7 +11965,23 @@ "section": "def-common.ExpressionType", "text": "ExpressionType" }, - " | undefined; readonly getFunction: (name: string) => ", + " | undefined; readonly registerType: (typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void; readonly getFunction: (name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -10678,7 +12012,72 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" - } + }, + ">; readonly getTypes: () => Record; readonly registerFunction: (functionDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void; readonly registerRenderer: (definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void; readonly run: (ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise; readonly fork: () => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + "; }" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", @@ -10768,13 +12167,94 @@ "label": "loader", "description": [], "signature": [ - "IExpressionLoader" + "(element: HTMLElement, expression: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", params: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.IExpressionLoaderParams", + "text": "IExpressionLoaderParams" + }, + ") => ", + "ExpressionLoader" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.element", + "type": "Object", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/public/loader.ts", + "lineNumber": 194 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.expression", + "type": "CompoundType", + "tags": [], + "label": "expression", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/public/loader.ts", + "lineNumber": 195 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.IExpressionLoaderParams", + "text": "IExpressionLoaderParams" + } + ], + "source": { + "path": "src/plugins/expressions/public/loader.ts", + "lineNumber": 196 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -10798,7 +12278,32 @@ "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 28 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + } + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 57 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -10808,14 +12313,74 @@ "label": "render", "description": [], "signature": [ - "typeof ", - "render" + "(element: HTMLElement, data: any, options?: ", + "ExpressionRenderHandlerParams", + " | undefined) => ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderHandler", + "text": "ExpressionRenderHandler" + } ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.element", + "type": "Object", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 153 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.data", + "type": "Any", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 154 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "ExpressionRenderHandlerParams", + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 155 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -10857,12 +12422,20 @@ "\nDynamic state of the execution." ], "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContainer", - "text": "ExecutionContainer" + "section": "def-common.ExecutionState", + "text": "ExecutionState" }, ">" + " | undefined; }>>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + ">, {}>" ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", @@ -11578,7 +13183,15 @@ "label": "createWithDefaults", "description": [], "signature": [ - "typeof ", + " = Record>(state?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -11586,7 +13199,7 @@ "section": "def-common.Executor", "text": "Executor" }, - ".createWithDefaults" + "" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -11629,14 +13242,38 @@ "label": "state", "description": [], "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorContainer", - "text": "ExecutorContainer" + "section": "def-common.ExecutorPureTransitions", + "text": "ExecutorPureTransitions" }, - "" + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureSelectors", + "text": "ExecutorPureSelectors" + }, + ">" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -12055,7 +13692,7 @@ "label": "context", "description": [], "signature": [ - "Record" + "{ [x: string]: unknown; }" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -12106,7 +13743,16 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" - } + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }> | Output>" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -12693,7 +14339,58 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 38 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.input", + "type": "Any", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.handlers", + "type": "Uncategorized", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + "object" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -12779,7 +14476,50 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 56 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.telemetryData", + "type": "Object", + "tags": [], + "label": "telemetryData", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 58 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -12813,7 +14553,34 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 60 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -12847,7 +14614,51 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 65 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -13279,7 +15090,9 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -13316,7 +15129,64 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 17 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.domNode", + "type": "Object", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.handlers", + "type": "Object", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -13600,7 +15470,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "common", @@ -13705,7 +15575,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -13849,7 +15719,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "common", @@ -13954,7 +15824,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -14124,7 +15994,26 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.type", + "type": "Any", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -15722,7 +17611,9 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -15734,7 +17625,7 @@ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ - "Record" + "{ [x: string]: unknown; }" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -15752,7 +17643,7 @@ "\nA map of available expression types." ], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -15820,7 +17711,9 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -16008,13 +17901,15 @@ "label": "ast", "description": [], "signature": [ + "{ type: \"expression\"; chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]; }" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -16110,7 +18005,7 @@ "label": "functions", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -16134,7 +18029,7 @@ "label": "types", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -16283,7 +18178,37 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 66 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunctionBuilder[]`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.fnName", + "type": "Uncategorized", + "tags": [], + "label": "fnName", + "description": [ + "Name of the function to search for." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -16310,7 +18235,11 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstExpression`" + ], + "children": [] }, { "parentPluginId": "expressions", @@ -16330,7 +18259,11 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`string`" + ], + "children": [] } ], "initialIsOpen": false @@ -16445,7 +18378,55 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 86 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to add." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 87 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [ + "The value of the argument to add." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 88 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -16473,7 +18454,30 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 99 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunctionBuilderArgument[] | undefined`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to retrieve." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 100 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -16501,7 +18505,56 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 111 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to replace." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 112 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.value", + "type": "Array", + "tags": [], + "label": "value", + "description": [ + "The value of the argument. Must always be an array." + ], + "signature": [ + "(", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 113 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -16521,7 +18574,30 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to remove." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -16548,7 +18624,11 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 130 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunction`" + ], + "children": [] }, { "parentPluginId": "expressions", @@ -16568,7 +18648,11 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`string`" + ], + "children": [] } ], "initialIsOpen": false @@ -16960,9 +19044,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionClog", - "text": "ExpressionFunctionClog" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"clog\", unknown, {}, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -16982,9 +19085,36 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionFont", - "text": "ExpressionFunctionFont" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"font\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17004,9 +19134,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVarSet", - "text": "ExpressionFunctionVarSet" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var_set\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17026,9 +19175,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVar", - "text": "ExpressionFunctionVar" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17048,9 +19216,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionTheme", - "text": "ExpressionFunctionTheme" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"theme\", null, Arguments, any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17070,9 +19257,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionCumulativeSum", - "text": "ExpressionFunctionCumulativeSum" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"cumulative_sum\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17092,9 +19322,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDerivative", - "text": "ExpressionFunctionDerivative" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"derivative\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17114,9 +19387,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionMovingAverage", - "text": "ExpressionFunctionMovingAverage" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"moving_average\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MovingAverageArgs", + "text": "MovingAverageArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -17316,7 +19632,64 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 42 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.domNode", + "type": "Object", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.handlers", + "type": "Object", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -17625,7 +19998,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -17641,7 +20016,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.fn", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "() => void" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -17657,7 +20051,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -17673,7 +20069,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.params", + "type": "Any", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -17689,7 +20104,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.event", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -17728,7 +20162,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 73 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -17744,7 +20180,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -18205,7 +20643,22 @@ "\nType to capture every possible expression function definition." ], "signature": [ - "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + ", any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", { "pluginId": "inspector", "scope": "common", @@ -18232,7 +20685,14 @@ "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ - "ExpressionTypeDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "" ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", @@ -18270,7 +20730,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -18306,7 +20766,30 @@ "label": "ExecutionContainer", "description": [], "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + ", {}>" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -18323,7 +20806,38 @@ "label": "ExecutorContainer", "description": [], "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureTransitions", + "text": "ExecutorPureTransitions" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureSelectors", + "text": "ExecutorPureSelectors" + }, + ">" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -18340,7 +20854,7 @@ "label": "ExpressionAstArgument", "description": [], "signature": [ - "string | number | false | true | ", + "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", @@ -18364,7 +20878,15 @@ "label": "ExpressionAstExpression", "description": [], "signature": [ - "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + "{ type: \"expression\"; chain: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -18381,7 +20903,23 @@ "label": "ExpressionAstFunction", "description": [], "signature": [ - "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + "{ type: \"function\"; function: string; arguments: Record; debug?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionDebug", + "text": "ExpressionAstFunctionDebug" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -18398,7 +20936,7 @@ "label": "ExpressionAstNode", "description": [], "signature": [ - "string | number | false | true | ", + "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", @@ -18481,7 +21019,23 @@ "label": "ExpressionValueError", "description": [], "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "{ type: \"error\"; } & { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -18500,7 +21054,15 @@ "\nRepresents an object that is a Filter." ], "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"filter\", any>[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", @@ -18629,7 +21191,23 @@ "label": "InterpreterErrorType", "description": [], "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "{ type: \"error\"; } & { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -18668,7 +21246,15 @@ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + "{ type: \"pointseries\"; } & { columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumns", + "text": "PointSeriesColumns" + }, + "; rows: Record[]; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -18687,7 +21273,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -18756,7 +21342,13 @@ "label": "Style", "description": [], "signature": [ - "ExpressionTypeStyle" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + } ], "source": { "path": "src/plugins/expressions/common/types/style.ts", @@ -18775,7 +21367,43 @@ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], "signature": [ - "(T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends string ? \"string\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends boolean ? \"boolean\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends number ? \"number\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends null ? \"null\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends { type: string; } ? ({ type: string; } & (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn))[\"type\"] : never" + "(T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends string ? \"string\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends boolean ? \"boolean\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends number ? \"number\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends null ? \"null\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends { type: string; } ? ({ type: string; } & (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + "))[\"type\"] : never" ], "source": { "path": "src/plugins/expressions/common/types/common.ts", @@ -18848,7 +21476,23 @@ "section": "def-common.ExpressionType", "text": "ExpressionType" }, - " | undefined; readonly getFunction: (name: string) => ", + " | undefined; readonly registerType: (typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void; readonly getFunction: (name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -18879,7 +21523,72 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" - } + }, + ">; readonly getTypes: () => Record; readonly registerFunction: (functionDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void; readonly registerRenderer: (definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void; readonly run: (ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise; readonly fork: () => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + "; }" ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -18897,7 +21606,13 @@ "label": "ExpressionsServerStart", "description": [], "signature": [ - "ExpressionsServiceStart" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -18943,12 +21658,20 @@ "\nDynamic state of the execution." ], "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContainer", - "text": "ExecutionContainer" + "section": "def-common.ExecutionState", + "text": "ExecutionState" }, ">" + " | undefined; }>>, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + ">, {}>" ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", @@ -19879,7 +22634,15 @@ "label": "createWithDefaults", "description": [], "signature": [ - "typeof ", + " = Record>(state?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -19887,7 +22650,7 @@ "section": "def-common.Executor", "text": "Executor" }, - ".createWithDefaults" + "" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -19930,14 +22693,38 @@ "label": "state", "description": [], "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorContainer", - "text": "ExecutorContainer" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - "" + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureTransitions", + "text": "ExecutorPureTransitions" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureSelectors", + "text": "ExecutorPureSelectors" + }, + ">" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -20356,7 +23143,7 @@ "label": "context", "description": [], "signature": [ - "Record" + "{ [x: string]: unknown; }" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -20407,7 +23194,16 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" - } + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }> | Output>" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -20994,7 +23790,58 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 38 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.input", + "type": "Any", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.handlers", + "type": "Uncategorized", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + "object" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 38 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -21080,7 +23927,50 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 56 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.telemetryData", + "type": "Object", + "tags": [], + "label": "telemetryData", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 58 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -21114,7 +24004,34 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 60 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -21148,7 +24065,51 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 63 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + }, + "[]; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 65 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -21580,7 +24541,9 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -21617,7 +24580,64 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 17 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.domNode", + "type": "Object", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.handlers", + "type": "Object", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -21885,8 +24905,7 @@ "section": "def-common.ExpressionsInspectorAdapter", "text": "ExpressionsInspectorAdapter" }, - " extends ", - "EventEmitter" + " extends EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", @@ -22634,7 +25653,72 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 263 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ast", + "type": "CompoundType", + "tags": [], + "label": "ast", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 133 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "Input" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 135 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 136 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -22693,7 +25777,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to extract references from" + ], "signature": [ { "pluginId": "expressions", @@ -22772,7 +25858,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to extract references from" + ], "signature": [ { "pluginId": "expressions", @@ -22835,7 +25923,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to update" + ], "signature": [ { "pluginId": "expressions", @@ -22858,7 +25948,9 @@ "type": "Array", "tags": [], "label": "references", - "description": [], + "description": [ + "array of saved object references" + ], "signature": [ "SavedObjectReference", "[]" @@ -22914,7 +26006,9 @@ "type": "Object", "tags": [], "label": "state", - "description": [], + "description": [ + "expression AST to update" + ], "signature": [ { "pluginId": "kibanaUtils", @@ -22937,7 +26031,9 @@ "type": "string", "tags": [], "label": "version", - "description": [], + "description": [ + "defines which migration version to run" + ], "signature": [ "string" ], @@ -22971,7 +26067,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", @@ -23086,7 +26182,26 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.type", + "type": "Any", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 23 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -23761,8 +26876,7 @@ "section": "def-common.TablesAdapter", "text": "TablesAdapter" }, - " extends ", - "EventEmitter" + " extends EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", @@ -25970,13 +29084,7 @@ "label": "type", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumnType", - "text": "DatatableColumnType" - } + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -26279,7 +29387,9 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -26291,7 +29401,7 @@ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ - "Record" + "{ [x: string]: unknown; }" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -26309,7 +29419,7 @@ "\nA map of available expression types." ], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -26377,7 +29487,9 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -26579,7 +29691,33 @@ "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 51 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -26611,7 +29749,33 @@ "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 52 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 52 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -26643,7 +29807,33 @@ "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 53 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 53 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -26687,13 +29877,15 @@ "label": "ast", "description": [], "signature": [ + "{ type: \"expression\"; chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]; }" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -26801,7 +29993,33 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 44 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 44 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -26833,7 +30051,33 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 45 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -26857,7 +30101,33 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 46 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 46 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -26913,7 +30183,33 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -26953,7 +30249,33 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -26985,7 +30307,33 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 31 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 31 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -27021,7 +30369,7 @@ "label": "functions", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -27045,7 +30393,7 @@ "label": "types", "description": [], "signature": [ - "Record" + "; }" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -27194,7 +30542,37 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 66 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunctionBuilder[]`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.fnName", + "type": "Uncategorized", + "tags": [], + "label": "fnName", + "description": [ + "Name of the function to search for." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -27221,7 +30599,11 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstExpression`" + ], + "children": [] }, { "parentPluginId": "expressions", @@ -27241,7 +30623,11 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`string`" + ], + "children": [] } ], "initialIsOpen": false @@ -27356,7 +30742,55 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 86 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to add." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 87 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [ + "The value of the argument to add." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 88 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -27384,7 +30818,30 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 99 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunctionBuilderArgument[] | undefined`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to retrieve." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 100 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -27412,7 +30869,56 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 111 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to replace." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 112 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.value", + "type": "Array", + "tags": [], + "label": "value", + "description": [ + "The value of the argument. Must always be an array." + ], + "signature": [ + "(", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 113 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -27432,7 +30938,30 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`this`" + ], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "Uncategorized", + "tags": [], + "label": "name", + "description": [ + "The name of the argument to remove." + ], + "signature": [ + "A" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -27459,7 +30988,11 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 130 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`ExpressionAstFunction`" + ], + "children": [] }, { "parentPluginId": "expressions", @@ -27479,7 +31012,11 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "`string`" + ], + "children": [] } ], "initialIsOpen": false @@ -28058,9 +31595,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionClog", - "text": "ExpressionFunctionClog" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"clog\", unknown, {}, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28080,9 +31636,36 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionFont", - "text": "ExpressionFunctionFont" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"font\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28102,9 +31685,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVarSet", - "text": "ExpressionFunctionVarSet" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var_set\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28124,9 +31726,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVar", - "text": "ExpressionFunctionVar" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28146,9 +31767,28 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionTheme", - "text": "ExpressionFunctionTheme" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"theme\", null, Arguments, any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28168,9 +31808,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionCumulativeSum", - "text": "ExpressionFunctionCumulativeSum" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"cumulative_sum\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28190,9 +31873,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDerivative", - "text": "ExpressionFunctionDerivative" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"derivative\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28212,9 +31938,52 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionMovingAverage", - "text": "ExpressionFunctionMovingAverage" - } + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"moving_average\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MovingAverageArgs", + "text": "MovingAverageArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -28414,7 +32183,64 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 42 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.domNode", + "type": "Object", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "HTMLElement" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.handlers", + "type": "Object", + "tags": [], + "label": "handlers", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -28520,7 +32346,23 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 79 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 79 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -28546,7 +32388,23 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 87 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 87 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -28572,7 +32430,23 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 95 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 95 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -28606,7 +32480,72 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 121 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ast", + "type": "CompoundType", + "tags": [], + "label": "ast", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 122 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "Input" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 123 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 124 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -28648,7 +32587,72 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 132 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ast", + "type": "CompoundType", + "tags": [], + "label": "ast", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 133 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "Input" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 135 + }, + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 136 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -28673,7 +32677,9 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 148 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -28982,7 +32988,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -28998,7 +33006,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.fn", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "() => void" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -29014,7 +33041,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -29030,7 +33059,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.params", + "type": "Any", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -29046,7 +33094,26 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.event", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71 + }, + "deprecated": false + } + ] }, { "parentPluginId": "expressions", @@ -29085,7 +33152,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 73 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -29101,7 +33170,9 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "expressions", @@ -29794,7 +33865,22 @@ "\nType to capture every possible expression function definition." ], "signature": [ - "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + ", any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", { "pluginId": "inspector", "scope": "common", @@ -29821,7 +33907,14 @@ "label": "AnyExpressionRenderDefinition", "description": [], "signature": [ - "ExpressionRenderDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", @@ -29838,7 +33931,14 @@ "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ - "ExpressionTypeDefinition" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "" ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", @@ -29876,7 +33976,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -29912,7 +34012,22 @@ "label": "ErrorLike", "description": [], "signature": [ - "SerializedError & { original?: SerializedError | undefined; }" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedError", + "text": "SerializedError" + }, + " & { original?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedError", + "text": "SerializedError" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/util/create_error.ts", @@ -29929,7 +34044,30 @@ "label": "ExecutionContainer", "description": [], "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + ", {}>" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -29946,7 +34084,38 @@ "label": "ExecutorContainer", "description": [], "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.StateContainer", + "text": "StateContainer" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureTransitions", + "text": "ExecutorPureTransitions" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorPureSelectors", + "text": "ExecutorPureSelectors" + }, + ">" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -29963,7 +34132,7 @@ "label": "ExpressionAstArgument", "description": [], "signature": [ - "string | number | false | true | ", + "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", @@ -29987,7 +34156,15 @@ "label": "ExpressionAstExpression", "description": [], "signature": [ - "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + "{ type: \"expression\"; chain: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -30004,7 +34181,23 @@ "label": "ExpressionAstFunction", "description": [], "signature": [ - "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + "{ type: \"function\"; function: string; arguments: Record; debug?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionDebug", + "text": "ExpressionAstFunctionDebug" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -30021,7 +34214,7 @@ "label": "ExpressionAstFunctionDebug", "description": [], "signature": [ - "{ success: boolean; fn: string; input: ExpressionValue; args: Record; output?: ExpressionValue; error?: ", + "{ success: boolean; fn: string; input: any; args: Record; output?: any; error?: ", { "pluginId": "expressions", "scope": "common", @@ -30045,7 +34238,7 @@ "section": "def-common.SerializableState", "text": "SerializableState" }, - " | undefined; }> | undefined; rawError?: any | Error; duration: number | undefined; }" + " | undefined; }> | undefined; rawError?: any; duration: number | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -30062,7 +34255,7 @@ "label": "ExpressionAstNode", "description": [], "signature": [ - "string | number | false | true | ", + "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", @@ -30094,7 +34287,14 @@ "label": "ExpressionFunctionClog", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"clog\", unknown, {}, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"clog\", unknown, {}, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -30129,7 +34329,38 @@ "label": "ExpressionFunctionCumulativeSum", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"cumulative_sum\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", { "pluginId": "expressions", "scope": "common", @@ -30164,7 +34395,38 @@ "label": "ExpressionFunctionDerivative", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"derivative\", Datatable, DerivativeArgs, Datatable, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"derivative\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", { "pluginId": "expressions", "scope": "common", @@ -30199,7 +34461,14 @@ "label": "ExpressionFunctionFont", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"font\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"font\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -30242,7 +34511,38 @@ "label": "ExpressionFunctionMovingAverage", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"moving_average\", Datatable, MovingAverageArgs, Datatable, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"moving_average\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MovingAverageArgs", + "text": "MovingAverageArgs" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", ", { "pluginId": "expressions", "scope": "common", @@ -30277,7 +34577,14 @@ "label": "ExpressionFunctionTheme", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"theme\", null, Arguments, any, ", { "pluginId": "expressions", "scope": "common", @@ -30312,7 +34619,14 @@ "label": "ExpressionFunctionVar", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"var\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var\", unknown, Arguments, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -30347,7 +34661,14 @@ "label": "ExpressionFunctionVarSet", "description": [], "signature": [ - "ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"var_set\", unknown, Arguments, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -30392,7 +34713,23 @@ "section": "def-common.ExpressionType", "text": "ExpressionType" }, - " | undefined; readonly getFunction: (name: string) => ", + " | undefined; readonly registerType: (typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void; readonly getFunction: (name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -30423,7 +34760,72 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" - } + }, + ">; readonly getTypes: () => Record; readonly registerFunction: (functionDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void; readonly registerRenderer: (definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void; readonly run: (ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise; readonly fork: () => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + "; }" ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", @@ -30491,7 +34893,23 @@ "label": "ExpressionValueError", "description": [], "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "{ type: \"error\"; } & { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -30510,7 +34928,15 @@ "\nRepresents an object that is a Filter." ], "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"filter\", any>[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", @@ -30661,7 +35087,15 @@ "label": "InferFunctionDefinition", "description": [], "signature": [ - "FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" + "FnDef extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + " ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", @@ -30680,7 +35114,23 @@ "label": "InterpreterErrorType", "description": [], "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "{ type: \"error\"; } & { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -30760,7 +35210,15 @@ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + "{ type: \"pointseries\"; } & { columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumns", + "text": "PointSeriesColumns" + }, + "; rows: Record[]; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -30779,7 +35237,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -31080,7 +35538,13 @@ "label": "Style", "description": [], "signature": [ - "ExpressionTypeStyle" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + } ], "source": { "path": "src/plugins/expressions/common/types/style.ts", @@ -31123,7 +35587,43 @@ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], "signature": [ - "(T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends string ? \"string\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends boolean ? \"boolean\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends number ? \"number\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends null ? \"null\" : (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn) extends { type: string; } ? ({ type: string; } & (T extends ObservableLike ? UnwrapObservable : UnwrapPromiseOrReturn))[\"type\"] : never" + "(T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends string ? \"string\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends boolean ? \"boolean\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends number ? \"number\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends null ? \"null\" : (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + ") extends { type: string; } ? ({ type: string; } & (T extends ", + "ObservableLike", + " ? ", + "UnwrapObservable", + " : ", + "UnwrapPromiseOrReturn", + "))[\"type\"] : never" ], "source": { "path": "src/plugins/expressions/common/types/common.ts", @@ -31682,13 +36182,10 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 61 @@ -31724,13 +36221,10 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 67 @@ -31803,13 +36297,10 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 75 @@ -31866,13 +36357,10 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 82 @@ -31929,13 +36417,10 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 89 @@ -32616,13 +37101,10 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 62 @@ -32658,13 +37140,10 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.by.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 68 @@ -32737,13 +37216,10 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 76 @@ -32800,13 +37276,10 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 83 @@ -32863,13 +37336,10 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 90 @@ -33109,7 +37579,24 @@ "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" - } + }, + "<\"error\", { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }>, \"error\" | \"info\">; }>" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -33535,13 +38022,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 50 @@ -33606,13 +38090,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.align.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 57 @@ -33689,13 +38170,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.color.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 65 @@ -33749,13 +38227,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.family.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 72 @@ -33809,13 +38284,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.italic.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 82 @@ -33901,13 +38373,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 91 @@ -33961,13 +38430,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.size.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 98 @@ -34021,13 +38487,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.underline.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 105 @@ -34097,13 +38560,10 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.weight.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 113 @@ -34359,7 +38819,7 @@ "section": "def-common.ExpressionImage", "text": "ExpressionImage" }, - ", \"dataurl\" | \"mode\">; }>" + ", \"mode\" | \"dataurl\">; }>" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", @@ -34495,13 +38955,10 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 32 @@ -34553,13 +39010,10 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 45 @@ -34648,13 +39102,10 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 55 @@ -34743,13 +39194,10 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 64 @@ -34806,13 +39254,10 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 75 @@ -35011,13 +39456,10 @@ { "parentPluginId": "expressions", "id": "def-common.math.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 88 @@ -35085,13 +39527,10 @@ { "parentPluginId": "expressions", "id": "def-common.math.args.expression.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 105 @@ -35148,13 +39587,10 @@ { "parentPluginId": "expressions", "id": "def-common.math.args.onError.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 116 @@ -35315,13 +39751,10 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 60 @@ -35357,13 +39790,10 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 66 @@ -35436,13 +39866,10 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 74 @@ -35499,13 +39926,10 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 81 @@ -35562,13 +39986,10 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 88 @@ -35625,13 +40046,10 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 95 @@ -37729,13 +42147,10 @@ { "parentPluginId": "expressions", "id": "def-common.theme.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 30 @@ -37803,13 +42218,10 @@ { "parentPluginId": "expressions", "id": "def-common.theme.args.variable.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 37 @@ -37866,13 +42278,10 @@ { "parentPluginId": "expressions", "id": "def-common.theme.args.default.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 44 @@ -38023,13 +42432,10 @@ { "parentPluginId": "expressions", "id": "def-common.variable.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 25 @@ -38113,13 +42519,10 @@ { "parentPluginId": "expressions", "id": "def-common.variable.args.name.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 33 @@ -38270,13 +42673,10 @@ { "parentPluginId": "expressions", "id": "def-common.variableSet.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 26 @@ -38360,13 +42760,10 @@ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 34 @@ -38407,13 +42804,10 @@ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.help", - "type": "Any", + "type": "string", "tags": [], "label": "help", "description": [], - "signature": [ - "any" - ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 40 diff --git a/api_docs/features.json b/api_docs/features.json index f0424e11a81ff5..7392fcf6a17f76 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -132,7 +132,7 @@ "label": "category", "description": [], "signature": [ - "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + "{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", @@ -1312,7 +1312,7 @@ "label": "category", "description": [], "signature": [ - "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + "{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", @@ -2401,13 +2401,72 @@ "\nUtility for iterating through all privileges belonging to a specific feature.\n{@see FeaturePrivilegeIterator }" ], "signature": [ - "FeaturePrivilegeIterator" + "(feature: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + }, + ", options: ", + "FeaturePrivilegeIteratorOptions", + ") => IterableIterator<{ privilegeId: string; privilege: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; }>" ], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 70 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "features", + "id": "def-server.feature", + "type": "Object", + "tags": [], + "label": "feature", + "description": [], + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + } + ], + "source": { + "path": "x-pack/plugins/features/server/feature_privilege_iterator/feature_privilege_iterator.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "features", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "FeaturePrivilegeIteratorOptions" + ], + "source": { + "path": "x-pack/plugins/features/server/feature_privilege_iterator/feature_privilege_iterator.ts", + "lineNumber": 45 + }, + "deprecated": false + } + ] }, { "parentPluginId": "features", @@ -2419,13 +2478,70 @@ "\nUtility for iterating through all sub-feature privileges belonging to a specific feature.\n{@see SubFeaturePrivilegeIterator }" ], "signature": [ - "SubFeaturePrivilegeIterator" + "(feature: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + }, + ", licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => IterableIterator<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeConfig", + "text": "SubFeaturePrivilegeConfig" + }, + ">" ], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 76 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "features", + "id": "def-server.feature", + "type": "Object", + "tags": [], + "label": "feature", + "description": [], + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + } + ], + "source": { + "path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts", + "lineNumber": 18 + }, + "deprecated": false + }, + { + "parentPluginId": "features", + "id": "def-server.licenseType", + "type": "CompoundType", + "tags": [], + "label": "licenseType", + "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], + "source": { + "path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2817,7 +2933,7 @@ "label": "category", "description": [], "signature": [ - "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + "{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", @@ -4001,13 +4117,7 @@ "\nThe type of privilege group.\n- `mutually_exclusive`::\n Users will be able to select at most one privilege within this group.\n Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All)\n- `independent`::\n Users will be able to select any combination of privileges within this group." ], "signature": [ - { - "pluginId": "features", - "scope": "common", - "docId": "kibFeaturesPluginApi", - "section": "def-common.SubFeaturePrivilegeGroupType", - "text": "SubFeaturePrivilegeGroupType" - } + "\"mutually_exclusive\" | \"independent\"" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", diff --git a/api_docs/file_data_visualizer.json b/api_docs/file_data_visualizer.json index 5f60af1967daec..31b2c6bf5b673e 100644 --- a/api_docs/file_data_visualizer.json +++ b/api_docs/file_data_visualizer.json @@ -15,7 +15,7 @@ "label": "FileDataVisualizerPluginStart", "description": [], "signature": [ - "{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }" + "{ getFileDataVisualizerComponent: () => Promise>; getMaxBytesFormatted: () => string; }" ], "source": { "path": "x-pack/plugins/file_data_visualizer/public/plugin.ts", @@ -230,7 +230,7 @@ "label": "JobFieldType", "description": [], "signature": [ - "\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"unknown\" | \"ip\" | \"geo_point\" | \"geo_shape\"" + "\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\"" ], "source": { "path": "x-pack/plugins/file_data_visualizer/common/types.ts", diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json index 80d3add483ffcf..406c5e440972a5 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -125,7 +125,52 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 25 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fileUpload", + "id": "def-public.geojsonFile", + "type": "Object", + "tags": [], + "label": "geojsonFile", + "description": [], + "signature": [ + "GeoJSON.FeatureCollection" + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 25 + }, + "deprecated": false + }, + { + "parentPluginId": "fileUpload", + "id": "def-public.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 25 + }, + "deprecated": false + }, + { + "parentPluginId": "fileUpload", + "id": "def-public.previewCoverage", + "type": "number", + "tags": [], + "label": "previewCoverage", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fileUpload", @@ -141,7 +186,9 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 26 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "fileUpload", @@ -157,7 +204,9 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 27 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "fileUpload", @@ -173,7 +222,9 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 28 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "fileUpload", @@ -197,7 +248,32 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 29 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fileUpload", + "id": "def-public.results", + "type": "Object", + "tags": [], + "label": "results", + "description": [], + "signature": [ + { + "pluginId": "fileUpload", + "scope": "public", + "docId": "kibFileUploadPluginApi", + "section": "def-public.FileUploadGeoResults", + "text": "FileUploadGeoResults" + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 29 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fileUpload", @@ -213,7 +289,9 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 30 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -880,7 +958,39 @@ "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 17 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fileUpload", + "id": "def-public.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "fileUpload", + "id": "def-public.error", + "type": "string", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 17 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fileUpload", @@ -896,7 +1006,9 @@ "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 18 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "fileUpload", @@ -912,7 +1024,9 @@ "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 19 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1241,7 +1355,208 @@ "docId": "kibDataPluginApi", "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" - } + }, + ".OBJECT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".DATE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".DATE_NANOS | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".DATE_RANGE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".GEO_POINT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".GEO_SHAPE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".FLOAT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".HALF_FLOAT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".SCALED_FLOAT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".DOUBLE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".INTEGER | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".LONG | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".SHORT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".UNSIGNED_LONG | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".FLOAT_RANGE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".DOUBLE_RANGE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".INTEGER_RANGE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".LONG_RANGE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".NESTED | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".BYTE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".IP | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".IP_RANGE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".ATTACHMENT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".TOKEN_COUNT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".MURMUR3 | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + ".HISTOGRAM; format?: string | undefined; }; }; }" ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", @@ -1524,12 +1839,13 @@ "label": "doc", "description": [], "signature": [ + "string | object | ", { "pluginId": "fileUpload", "scope": "common", "docId": "kibFileUploadPluginApi", - "section": "def-common.ImportDoc", - "text": "ImportDoc" + "section": "def-common.Doc", + "text": "Doc" } ], "source": { @@ -1983,7 +2299,14 @@ "label": "FormattedOverrides", "description": [], "signature": [ - "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.InputOverrides", + "text": "InputOverrides" + }, + " & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", diff --git a/api_docs/fleet.json b/api_docs/fleet.json index 1cbeaaa6e06563..ea4d3db538f397 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -453,7 +453,7 @@ "label": "component", "description": [], "signature": [ - "React.LazyExoticComponent>" + " & React.RefAttributes>) | React.PropsWithChildren<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtensionComponentProps", + "text": "PackageCustomExtensionComponentProps" + }, + ">> & { readonly _result: React.ComponentType<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtensionComponentProps", + "text": "PackageCustomExtensionComponentProps" + }, + ">; }" ], "source": { "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 97 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.props", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 359 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -512,9 +555,98 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + ">" ], "source": { "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", @@ -577,7 +709,7 @@ "label": "component", "description": [], "signature": [ - "React.LazyExoticComponent>" + " & React.RefAttributes>) | React.PropsWithChildren<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtensionComponentProps", + "text": "PackagePolicyCreateExtensionComponentProps" + }, + ">> & { readonly _result: React.ComponentType<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtensionComponentProps", + "text": "PackagePolicyCreateExtensionComponentProps" + }, + ">; }" ], "source": { "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 79 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.props", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 359 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -657,7 +832,34 @@ "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 67 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.opts", + "type": "Object", + "tags": [], + "label": "opts", + "description": [], + "signature": [ + "{ isValid: boolean; updatedPolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + "; }" + ], + "source": { + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "lineNumber": 67 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -714,7 +916,7 @@ "label": "component", "description": [], "signature": [ - "React.LazyExoticComponent>" + " & React.RefAttributes>) | React.PropsWithChildren<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtensionComponentProps", + "text": "PackagePolicyEditExtensionComponentProps" + }, + ">> & { readonly _result: React.ComponentType<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtensionComponentProps", + "text": "PackagePolicyEditExtensionComponentProps" + }, + ">; }" ], "source": { "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.props", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 359 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -818,7 +1063,34 @@ "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 39 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.opts", + "type": "Object", + "tags": [], + "label": "opts", + "description": [], + "signature": [ + "{ isValid: boolean; updatedPolicy: Partial<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ">; }" + ], + "source": { + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "lineNumber": 39 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -1730,19 +2002,62 @@ "label": "registerExtension", "description": [], "signature": [ + "(extensionPoint: ", { "pluginId": "fleet", "scope": "public", "docId": "kibFleetPluginApi", - "section": "def-public.UIExtensionRegistrationCallback", - "text": "UIExtensionRegistrationCallback" - } + "section": "def-public.UIExtensionPoint", + "text": "UIExtensionPoint" + }, + ") => void" ], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", "lineNumber": 54 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.extensionPoint", + "type": "CompoundType", + "tags": [], + "label": "extensionPoint", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtension", + "text": "PackagePolicyEditExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtension", + "text": "PackageCustomExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtension", + "text": "PackagePolicyCreateExtension" + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "lineNumber": 13 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fleet", @@ -1758,7 +2073,9 @@ "path": "x-pack/plugins/fleet/public/plugin.ts", "lineNumber": 55 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "lifecycle": "start", @@ -1904,46 +2221,359 @@ "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 68 }, - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-server.AgentPolicyServiceInterface.list", - "type": "Function", - "tags": [], - "label": "list", - "description": [], - "signature": [ - "(soClient: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" + "parentPluginId": "fleet", + "id": "def-server.soClient", + "type": "Object", + "tags": [], + "label": "soClient", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 263 + }, + "deprecated": false }, - "[]; total: number; page: number; perPage: number; }>" - ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 69 - }, - "deprecated": false + { + "parentPluginId": "fleet", + "id": "def-server.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 264 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.withPackagePolicies", + "type": "boolean", + "tags": [], + "label": "withPackagePolicies", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 265 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fleet", - "id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId", + "id": "def-server.AgentPolicyServiceInterface.list", "type": "Function", "tags": [], - "label": "getDefaultAgentPolicyId", + "label": "list", "description": [], "signature": [ "(soClient: Pick<", @@ -1954,45 +2584,1079 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise" - ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 70 - }, - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy", - "type": "Function", - "tags": [], - "label": "getFullAgentPolicy", - "description": [], - "signature": [ - "(soClient: Pick<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + "[]; total: number; page: number; perPage: number; }>" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 69 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.soClient", + "type": "Object", + "tags": [], + "label": "soClient", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 305 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.options", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 306 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "fleet", + "id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId", + "type": "Function", + "tags": [], + "label": "getDefaultAgentPolicyId", + "description": [], + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 70 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.soClient", + "type": "Object", + "tags": [], + "label": "soClient", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 537 + }, + "deprecated": false + } + ] + }, + { + "parentPluginId": "fleet", + "id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy", + "type": "Function", + "tags": [], + "label": "getFullAgentPolicy", + "description": [], + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + }, + " | null>" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 71 + }, + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.soClient", + "type": "Object", + "tags": [], + "label": "soClient", + "description": [], + "signature": [ + "{ get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; 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" + }, + ">; 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: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, 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" + }, + "; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 675 + }, + "deprecated": false + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "parentPluginId": "fleet", + "id": "def-server.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 676 + }, + "deprecated": false }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<", { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicy", - "text": "FullAgentPolicy" - }, - " | null>" - ], - "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 71 - }, - "deprecated": false + "parentPluginId": "fleet", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ standalone: boolean; } | undefined" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", + "lineNumber": 677 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2022,14 +3686,71 @@ "\nGet an Agent by id" ], "signature": [ - "typeof ", - "getAgentById" + "(esClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", agentId: string) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + ">" ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.esClient", + "type": "CompoundType", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "Pick<", + "KibanaClient", + ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", + "TransportRequestParams", + ", options?: ", + "TransportRequestOptions", + " | undefined): ", + "TransportRequestPromise", + "<", + "ApiResponse", + ", unknown>>; }; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agents/crud.ts", + "lineNumber": 191 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.agentId", + "type": "string", + "tags": [], + "label": "agentId", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/agents/crud.ts", + "lineNumber": 191 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fleet", @@ -2210,14 +3931,74 @@ "\nList agents" ], "signature": [ - "typeof ", - "getAgentsByKuery" + "(esClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { showInactive: boolean; }) => Promise<{ agents: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + "[]; total: number; page: number; perPage: number; }>" ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 64 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.esClient", + "type": "CompoundType", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "Pick<", + "KibanaClient", + ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", + "TransportRequestParams", + ", options?: ", + "TransportRequestOptions", + " | undefined): ", + "TransportRequestPromise", + "<", + "ApiResponse", + ", unknown>>; }; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agents/crud.ts", + "lineNumber": 91 + }, + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.options", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { showInactive: boolean; }" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/agents/crud.ts", + "lineNumber": 92 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -2957,7 +4738,32 @@ "docId": "kibFleetPluginApi", "section": "def-common.UpdatePackagePolicy", "text": "UpdatePackagePolicy" - } + }, + ", context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + }, + ">]" ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", @@ -3069,7 +4875,9 @@ "path": "x-pack/plugins/fleet/server/plugin.ts", "lineNumber": 167 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "fleet", @@ -3201,7 +5009,90 @@ "path": "x-pack/plugins/fleet/server/plugin.ts", "lineNumber": 180 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.args", + "type": "CompoundType", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "[\"packagePolicyCreate\", (newPackagePolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ", context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ">] | [\"packagePolicyUpdate\", (newPackagePolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + }, + ", context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + }, + ">]" + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 180 + }, + "deprecated": false + } + ] }, { "parentPluginId": "fleet", @@ -3220,7 +5111,23 @@ "path": "x-pack/plugins/fleet/server/plugin.ts", "lineNumber": 186 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.packageName", + "type": "string", + "tags": [], + "label": "packageName", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 186 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -3512,8 +5419,56 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.RegistryPackage", - "text": "RegistryPackage" + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EpmPackageAdditions", + "text": "EpmPackageAdditions" + }, + ">> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | (Pick<", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", "section": "def-common.RegistryPackage", "text": "RegistryPackage" - } + }, + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ", + "SavedObject", + "<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" + }, + ">; } & { integration?: string | undefined; id: string; }) | (Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })) => boolean" ], "source": { "path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts", @@ -3592,7 +5582,90 @@ "docId": "kibFleetPluginApi", "section": "def-common.RegistryPackage", "text": "RegistryPackage" - } + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EpmPackageAdditions", + "text": "EpmPackageAdditions" + }, + ">> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + "> | (Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ", + "SavedObject", + "<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" + }, + ">; } & { integration?: string | undefined; id: string; }) | (Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })" ], "source": { "path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts", @@ -3620,6 +5693,25 @@ "lineNumber": 35 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.o", + "type": "Uncategorized", + "tags": [], + "label": "o", + "description": [], + "signature": [ + "T" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 35 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -4257,13 +6349,7 @@ "label": "type", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentActionType", - "text": "AgentActionType" - } + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -4444,14 +6530,7 @@ "label": "status", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ValueOf", - "text": "ValueOf" - }, - "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>" + "\"active\" | \"inactive\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", @@ -4589,13 +6668,7 @@ "label": "type", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentActionType", - "text": "AgentActionType" - } + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -4777,13 +6850,7 @@ "label": "service", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ServiceName", - "text": "ServiceName" - } + "\"kibana\" | \"elasticsearch\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -4799,12 +6866,21 @@ "label": "type", "description": [], "signature": [ + "\"input\" | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + " | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AssetType", - "text": "AssetType" + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" } ], "source": { @@ -5158,15 +7234,7 @@ "label": "body", "description": [], "signature": [ - "Pick<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - }, - ", \"description\" | \"name\">" + "{ description?: string | undefined; name: string; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -5553,13 +7621,7 @@ "label": "installType", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallType", - "text": "InstallType" - } + "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -6016,13 +8078,39 @@ "label": "assets", "description": [], "signature": [ + "Record<\"kibana\", Record<", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AssetsGroupedByServiceByType", - "text": "AssetsGroupedByServiceByType" - } + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]>> & Record<\"elasticsearch\", Record<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]>>" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -6234,13 +8322,7 @@ "\nType" ], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentType", - "text": "AgentType" - } + "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -8035,9 +10117,10 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryList", - "text": "CategorySummaryList" - } + "section": "def-common.CategorySummaryItem", + "text": "CategorySummaryItem" + }, + "[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -8401,9 +10484,98 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + ">" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -8713,9 +10885,10 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.Output", - "text": "Output" - } + "section": "def-common.NewOutput", + "text": "NewOutput" + }, + " & { id: string; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", @@ -9041,9 +11214,10 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - } + "section": "def-common.PackageListItem", + "text": "PackageListItem" + }, + "[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -9462,7 +11636,7 @@ "label": "es_index_patterns", "description": [], "signature": [ - "Record" + "{ [x: string]: string; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -9504,13 +11678,7 @@ "label": "install_status", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.EpmPackageInstallStatus", - "text": "EpmPackageInstallStatus" - } + "\"installed\" | \"installing\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -9552,13 +11720,7 @@ "label": "install_source", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallSource", - "text": "InstallSource" - } + "\"registry\" | \"upload\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -9716,13 +11878,7 @@ "label": "installType", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallType", - "text": "InstallType" - } + "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -10009,13 +12165,7 @@ "label": "type", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentActionType", - "text": "AgentActionType" - } + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -12140,7 +14290,7 @@ "label": "id", "description": [], "signature": [ - "React.ReactText" + "string | number" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", @@ -12343,9 +14493,10 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.Output", - "text": "Output" - } + "section": "def-common.NewOutput", + "text": "NewOutput" + }, + " & { id: string; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", @@ -12377,15 +14528,7 @@ "label": "body", "description": [], "signature": [ - "Partial>" + "{ has_seen_add_data_notice?: boolean | undefined; has_seen_fleet_migration_notice?: boolean | undefined; fleet_server_hosts?: string[] | undefined; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", @@ -13222,13 +15365,7 @@ "label": "[RegistryVarsEntryKeys.type]", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryVarType", - "text": "RegistryVarType" - } + "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14106,7 +16243,23 @@ "label": "AgentPolicyActionV7_9", "description": [], "signature": [ - "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" + "Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicyAction", + "text": "AgentPolicyAction" + }, + ", \"id\" | \"created_at\" | \"policy_id\" | \"policy_revision\" | \"ack_data\" | \"sent_at\"> & { type: \"CONFIG_CHANGE\"; data: { config: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + }, + "; }; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -14123,7 +16276,23 @@ "label": "AgentPolicySOAttributes", "description": [], "signature": [ - "{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; updated_by: string; namespace: string; is_default?: boolean | undefined; package_policies: string[] | PackagePolicy[]; is_default_fleet_server?: boolean | undefined; is_managed: boolean; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; is_preconfigured?: boolean | undefined; revision: number; }" + "{ status: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ValueOf", + "text": "ValueOf" + }, + "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; updated_by: string; namespace: string; is_default?: boolean | undefined; package_policies: string[] | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + "[]; is_default_fleet_server?: boolean | undefined; is_managed: boolean; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; is_preconfigured?: boolean | undefined; revision: number; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", @@ -14225,7 +16394,22 @@ "label": "ArchivePackage", "description": [], "signature": [ - "PackageSpecManifest & Pick" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecManifest", + "text": "PackageSpecManifest" + }, + " & Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + ", \"internal\" | \"data_streams\" | \"assets\" | \"readme\">" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14290,24 +16474,7 @@ "label": "AssetsGroupedByServiceByType", "description": [], "signature": [ - "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 244 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetType", - "type": "Type", - "tags": [], - "label": "AssetType", - "description": [], - "signature": [ - "\"input\" | ", + "Record<\"kibana\", Record<", { "pluginId": "fleet", "scope": "common", @@ -14315,37 +16482,62 @@ "section": "def-common.KibanaAssetType", "text": "KibanaAssetType" }, - ".dashboard | ", + ", ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetType", - "text": "KibanaAssetType" + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, - ".visualization | ", + "[]>> & Record<\"elasticsearch\", Record<", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetType", - "text": "KibanaAssetType" + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" }, - ".search | ", + ", ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetType", - "text": "KibanaAssetType" + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, - ".indexPattern | ", + "[]>>" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 244 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AssetType", + "type": "Type", + "tags": [], + "label": "AssetType", + "description": [], + "signature": [ + "\"input\" | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", "section": "def-common.KibanaAssetType", "text": "KibanaAssetType" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" } ], "source": { @@ -14363,7 +16555,39 @@ "label": "AssetTypeToParts", "description": [], "signature": [ - "Record & Record" + "Record<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]> & Record<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]>" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14428,7 +16652,14 @@ "label": "CategorySummaryList", "description": [], "signature": [ - "CategorySummaryItem[]" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.CategorySummaryItem", + "text": "CategorySummaryItem" + }, + "[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14544,7 +16775,22 @@ "label": "ElasticsearchAssetParts", "description": [], "signature": [ - "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetParts", + "text": "AssetParts" + }, + " & { service: \"elasticsearch\"; type: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14561,7 +16807,55 @@ "label": "ElasticsearchAssetTypeToParts", "description": [], "signature": [ - "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" + "{ component_template: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]; ingest_pipeline: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]; index_template: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]; ilm_policy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]; transform: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]; data_stream_ilm_policy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" + }, + "[]; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14660,7 +16954,17 @@ "label": "EsAssetReference", "description": [], "signature": [ - "Pick & { type: ElasticsearchAssetType; }" + "Pick<", + "SavedObjectReference", + ", \"id\"> & { type: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -14779,7 +17083,14 @@ "label": "GetAgentPoliciesResponseItem", "description": [], "signature": [ - "AgentPolicy & { agents?: number | undefined; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + " & { agents?: number | undefined; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -14813,7 +17124,15 @@ "label": "InputsOverride", "description": [], "signature": [ - "Partial & { vars?: (Record & { vars?: (Record; }" + "T & { status: \"installed\"; savedObject: ", + "SavedObject", + "<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" + }, + ">; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15000,7 +17329,22 @@ "label": "KibanaAssetParts", "description": [], "signature": [ - "AssetParts & { service: Extract; type: KibanaAssetType; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetParts", + "text": "AssetParts" + }, + " & { service: \"kibana\"; type: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15017,7 +17361,17 @@ "label": "KibanaAssetReference", "description": [], "signature": [ - "Pick & { type: KibanaSavedObjectType; }" + "Pick<", + "SavedObjectReference", + ", \"id\"> & { type: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaSavedObjectType", + "text": "KibanaSavedObjectType" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15034,7 +17388,71 @@ "label": "KibanaAssetTypeToParts", "description": [], "signature": [ - "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; security_rule: KibanaAssetParts[]; ml_module: KibanaAssetParts[]; }" + "{ dashboard: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; visualization: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; search: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; index_pattern: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; map: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; lens: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; security_rule: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; ml_module: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15085,7 +17503,7 @@ "label": "NotInstalled", "description": [], "signature": [ - "T & { status: InstallationStatus['NotInstalled']; }" + "T & { status: \"not_installed\"; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15102,7 +17520,14 @@ "label": "Output", "description": [], "signature": [ - "NewOutput & { id: string; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewOutput", + "text": "NewOutput" + }, + " & { id: string; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", @@ -15136,7 +17561,13 @@ "label": "OutputSOAttributes", "description": [], "signature": [ - "NewOutput" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewOutput", + "text": "NewOutput" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", @@ -15201,7 +17632,9 @@ "label": "PackageAssetReference", "description": [], "signature": [ - "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" + "Pick<", + "SavedObjectReference", + ", \"id\"> & { type: \"epm-packages-assets\"; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15256,7 +17689,64 @@ "docId": "kibFleetPluginApi", "section": "def-common.RegistryPackage", "text": "RegistryPackage" - } + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EpmPackageAdditions", + "text": "EpmPackageAdditions" + }, + ">> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + ">" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15273,7 +17763,14 @@ "label": "PackageList", "description": [], "signature": [ - "PackageListItem[]" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageListItem", + "text": "PackageListItem" + }, + "[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15290,7 +17787,7 @@ "label": "PackageListItem", "description": [], "signature": [ - "Pick<", + "(Pick<", { "pluginId": "fleet", "scope": "common", @@ -15298,7 +17795,7 @@ "section": "def-common.RegistryPackage", "text": "RegistryPackage" }, - ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ", + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ", "SavedObject", "<", { @@ -15308,7 +17805,7 @@ "section": "def-common.Installation", "text": "Installation" }, - ">; } & { integration?: string | undefined; id: string; } | Pick<", + ">; } & { integration?: string | undefined; id: string; }) | (Pick<", { "pluginId": "fleet", "scope": "common", @@ -15316,7 +17813,7 @@ "section": "def-common.RegistryPackage", "text": "RegistryPackage" }, - ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; }" + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; })" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15333,7 +17830,15 @@ "label": "PackagePolicyConfigRecord", "description": [], "signature": [ - "{ [x: string]: PackagePolicyConfigRecordEntry; }" + "{ [x: string]: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyConfigRecordEntry", + "text": "PackagePolicyConfigRecordEntry" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", @@ -15350,7 +17855,31 @@ "label": "PackagePolicySOAttributes", "description": [], "signature": [ - "{ enabled: boolean; description?: string | undefined; name: string; package?: PackagePolicyPackage | undefined; updated_at: string; created_at: string; created_by: string; updated_by: string; namespace: string; inputs: PackagePolicyInput[]; policy_id: string; output_id: string; vars?: Record | undefined; revision: number; }" + "{ enabled: boolean; description?: string | undefined; name: string; package?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + " | undefined; updated_at: string; created_at: string; created_by: string; updated_by: string; namespace: string; inputs: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInput", + "text": "PackagePolicyInput" + }, + "[]; policy_id: string; output_id: string; vars?: Record | undefined; revision: number; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", @@ -15384,7 +17913,23 @@ "label": "PackagesGroupedByStatus", "description": [], "signature": [ - "{ installed: PackageList; not_installed: PackageList; }" + "{ installed: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageList", + "text": "PackageList" + }, + "; not_installed: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageList", + "text": "PackageList" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15571,7 +18116,22 @@ "label": "RegistryPackage", "description": [], "signature": [ - "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecManifest", + "text": "PackageSpecManifest" + }, + " & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15605,7 +18165,39 @@ "label": "RegistrySearchResult", "description": [], "signature": [ - "{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; internal?: boolean | undefined; data_streams?: RegistryDataStream[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (PackageSpecIcon[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; }" + "{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; download: string; path: string; internal?: boolean | undefined; data_streams?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryDataStream", + "text": "RegistryDataStream" + }, + "[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecIcon", + "text": "PackageSpecIcon" + }, + "[] & ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryImage", + "text": "RegistryImage" + }, + "[]) | undefined; policy_templates?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPolicyTemplate", + "text": "RegistryPolicyTemplate" + }, + "[] | undefined; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15622,7 +18214,15 @@ "label": "RegistrySearchResults", "description": [], "signature": [ - "Pick[]" + "Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15690,7 +18290,7 @@ "label": "RequirementsByServiceName", "description": [], "signature": [ - "undefined | Record<\"kibana\", { version: string; }>" + "Record<\"kibana\", { version: string; }> | undefined" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -15837,7 +18437,22 @@ "label": "UpdateAgentPolicyRequest", "description": [], "signature": [ - "GetOneAgentPolicyRequest & { body: NewAgentPolicy; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.GetOneAgentPolicyRequest", + "text": "GetOneAgentPolicyRequest" + }, + " & { body: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentPolicy", + "text": "NewAgentPolicy" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -15854,7 +18469,22 @@ "label": "UpdatePackagePolicyRequest", "description": [], "signature": [ - "GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.GetOnePackagePolicyRequest", + "text": "GetOnePackagePolicyRequest" + }, + " & { body: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + }, + "; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", @@ -15871,7 +18501,13 @@ "label": "UpdatePackagePolicyResponse", "description": [], "signature": [ - "CreatePackagePolicyResponse" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.CreatePackagePolicyResponse", + "text": "CreatePackagePolicyResponse" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", diff --git a/api_docs/global_search.json b/api_docs/global_search.json index a264a3f46736d8..c69dc7718c2f28 100644 --- a/api_docs/global_search.json +++ b/api_docs/global_search.json @@ -323,7 +323,7 @@ "\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n" ], "signature": [ - "GlobalSearchProviderResultUrl" + "string | { path: string; prependBasePath: boolean; }" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -478,7 +478,9 @@ "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 53 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -532,7 +534,9 @@ "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" ], "signature": [ - "Pick & { url: string; }" + "Pick<", + "GlobalSearchProviderResult", + ", \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -551,7 +555,15 @@ "label": "GlobalSearchPluginSetup", "description": [], "signature": [ - "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" + "{ registerResultProvider: (provider: ", + { + "pluginId": "globalSearch", + "scope": "public", + "docId": "kibGlobalSearchPluginApi", + "section": "def-public.GlobalSearchResultProvider", + "text": "GlobalSearchResultProvider" + }, + ") => void; }" ], "source": { "path": "x-pack/plugins/global_search/public/types.ts", @@ -579,7 +591,9 @@ "section": "def-public.GlobalSearchFindOptions", "text": "GlobalSearchFindOptions" }, - ") => Observable<", + ") => ", + "Observable", + "<", "GlobalSearchBatchedResults", ">; getSearchableTypes: () => Promise; }" ], @@ -744,7 +758,10 @@ "text": "IUiSettingsClient" }, "; }; capabilities: ", - "Observable" + "Observable", + "<", + "Capabilities", + ">; }" ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", @@ -910,7 +927,7 @@ "\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n" ], "signature": [ - "GlobalSearchProviderResultUrl" + "string | { path: string; prependBasePath: boolean; }" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -1011,7 +1028,8 @@ ") => ", "Observable", "<", - "GlobalSearchProviderResult" + "GlobalSearchProviderResult", + "[]>" ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", @@ -1103,7 +1121,32 @@ "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 140 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "globalSearch", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchProviderContext", + "text": "GlobalSearchProviderContext" + } + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 140 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -1214,7 +1257,9 @@ "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 57 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -1251,7 +1296,9 @@ "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" ], "signature": [ - "Pick & { url: string; }" + "Pick<", + "GlobalSearchProviderResult", + ", \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -1270,19 +1317,33 @@ "label": "GlobalSearchPluginStart", "description": [], "signature": [ - "{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ", + "{ find: (params: ", + "GlobalSearchFindParams", + ", options: ", + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchFindOptions", + "text": "GlobalSearchFindOptions" + }, + ", request: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", + "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ") => Observable; getSearchableTypes: (request: ", + ") => ", + "Observable", + "<", + "GlobalSearchBatchedResults", + ">; getSearchableTypes: (request: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", + "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, @@ -1304,7 +1365,15 @@ "label": "GlobalSearchPluginSetup", "description": [], "signature": [ - "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" + "{ registerResultProvider: (provider: ", + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchResultProvider", + "text": "GlobalSearchResultProvider" + }, + ") => void; }" ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", diff --git a/api_docs/home.json b/api_docs/home.json index b72c3d692769f3..c11d02dfed9de1 100644 --- a/api_docs/home.json +++ b/api_docs/home.json @@ -220,7 +220,7 @@ "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." ], "signature": [ - "IconType" + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>" ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", @@ -419,7 +419,7 @@ "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." ], "signature": [ - "IconType" + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>" ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", @@ -547,7 +547,7 @@ "label": "TutorialDirectoryHeaderLinkComponent", "description": [], "signature": [ - "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + "React.FunctionComponent<{}>" ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", @@ -564,7 +564,7 @@ "label": "TutorialDirectoryNoticeComponent", "description": [], "signature": [ - "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + "React.FunctionComponent<{}>" ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", @@ -581,7 +581,7 @@ "label": "TutorialModuleNoticeComponent", "description": [], "signature": [ - "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" + "React.FunctionComponent<{ moduleName: string; }>" ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", @@ -598,13 +598,7 @@ "label": "TutorialSetup", "description": [], "signature": [ - "{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: ", - "FC", - "<{}>) => void; registerDirectoryHeaderLink: (id: string, component: ", - "FC", - "<{}>) => void; registerModuleNotice: (id: string, component: ", - "FC", - "<{ moduleName: string; }>) => void; }" + "{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; }" ], "source": { "path": "src/plugins/home/public/plugin.ts", @@ -1084,9 +1078,21 @@ "label": "SampleDataRegistrySetup", "description": [], "signature": [ - "{ registerSampleDataset: (specProvider: SampleDatasetProvider) => void; getSampleDatasets: () => ", + "{ registerSampleDataset: (specProvider: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.SampleDatasetProvider", + "text": "SampleDatasetProvider" + }, + ") => void; getSampleDatasets: () => ", "Writable", - "[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: SavedObject[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: SampleDatasetDashboardPanel) => void; }" + "[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "SavedObject", + "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", + "SampleDatasetDashboardPanel", + ") => void; }" ], "source": { "path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts", @@ -1124,7 +1130,7 @@ "signature": [ "(context: ", "TutorialContext", - ") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; isBeta?: boolean | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; } & { id: string; name: string; category: \"metrics\" | \"security\" | \"logging\" | \"other\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" + ") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; isBeta?: boolean | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; } & { id: string; name: string; category: \"metrics\" | \"security\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" ], "source": { "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", diff --git a/api_docs/index_management.json b/api_docs/index_management.json index 91895dbe109c0a..9dc02a51148bca 100644 --- a/api_docs/index_management.json +++ b/api_docs/index_management.json @@ -1262,7 +1262,7 @@ "label": "health", "description": [], "signature": [ - "ClusterStatus" + "\"green\" | \"yellow\" | \"red\"" ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", @@ -1491,7 +1491,7 @@ "label": "status", "description": [], "signature": [ - "HealthFromEs" + "\"GREEN\" | \"YELLOW\" | \"RED\"" ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json index 15f00324d585ff..d7afa005cf2dab 100644 --- a/api_docs/index_pattern_field_editor.json +++ b/api_docs/index_pattern_field_editor.json @@ -67,15 +67,13 @@ "label": "getDerivedStateFromProps", "description": [], "signature": [ - "typeof ", - { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.DefaultFormatEditor", - "text": "DefaultFormatEditor" - }, - ".getDerivedStateFromProps" + "(nextProps: ", + "FormatEditorProps", + "<{}>, state: ", + "FormatEditorState", + ") => { error: string | undefined; samples: ", + "Sample", + "[]; }" ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", @@ -226,7 +224,7 @@ "\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\"" ], "signature": [ - "InternalFieldType" + "\"concrete\" | \"runtime\"" ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", @@ -594,7 +592,42 @@ "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "indexPatternFieldEditor", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 554 + }, + "deprecated": false + }, + { + "parentPluginId": "indexPatternFieldEditor", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "node_modules/@types/react/index.d.ts", + "lineNumber": 554 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json index 9676ef7b4b9c39..77ca8b9505d990 100644 --- a/api_docs/index_pattern_management.json +++ b/api_docs/index_pattern_management.json @@ -799,7 +799,9 @@ "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 33 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] }, { "parentPluginId": "indexPatternManagement", @@ -904,19 +906,54 @@ "[]>; }; list: { getIndexPatternTags: (indexPattern: ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.IIndexPattern", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", "text": "IIndexPattern" }, " | ", { "pluginId": "core", "scope": "public", - "docId": "kibCorePluginApi", + "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" - } + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ">, isDefault: boolean) => ", + "IndexPatternTag", + "[]; getFieldInfo: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => string[]; areScriptedFieldsEnabled: (indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ") => boolean; }; }" ], "source": { "path": "src/plugins/index_pattern_management/public/plugin.ts", diff --git a/api_docs/infra.json b/api_docs/infra.json index 8ff9ded3938e60..bb50bcdd072bd6 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -109,7 +109,23 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 16 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.val", + "type": "number", + "tags": [], + "label": "val", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/number.ts", + "lineNumber": 8 + }, + "deprecated": false + } + ] }, { "parentPluginId": "infra", @@ -127,7 +143,23 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 19 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.bytes", + "type": "number", + "tags": [], + "label": "bytes", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/bytes.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "infra", @@ -145,7 +177,23 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 21 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.bytes", + "type": "number", + "tags": [], + "label": "bytes", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/bytes.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "infra", @@ -163,7 +211,23 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 23 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.bytes", + "type": "number", + "tags": [], + "label": "bytes", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/bytes.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ] }, { "parentPluginId": "infra", @@ -179,7 +243,23 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 24 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.val", + "type": "number", + "tags": [], + "label": "val", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/percent.ts", + "lineNumber": 9 + }, + "deprecated": false + } + ] }, { "parentPluginId": "infra", @@ -195,7 +275,23 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 25 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.val", + "type": "number", + "tags": [], + "label": "val", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/high_precision.ts", + "lineNumber": 8 + }, + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -233,7 +329,9 @@ "label": "InfraRequestHandlerContext", "description": [], "signature": [ - "InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext" + "InfraMlRequestHandlerContext", + " & ", + "InfraSpacesRequestHandlerContext" ], "source": { "path": "x-pack/plugins/infra/server/types.ts", @@ -273,7 +371,39 @@ "path": "x-pack/plugins/infra/server/plugin.ts", "lineNumber": 76 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "infra", + "id": "def-server.sourceId", + "type": "string", + "tags": [], + "label": "sourceId", + "description": [], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 77 + }, + "deprecated": false + }, + { + "parentPluginId": "infra", + "id": "def-server.sourceProperties", + "type": "Object", + "tags": [], + "label": "sourceProperties", + "description": [], + "signature": [ + "InfraStaticSourceConfiguration" + ], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 78 + }, + "deprecated": false + } + ] } ], "lifecycle": "setup", diff --git a/api_docs/inspector.json b/api_docs/inspector.json index 776e7869e4fb8a..f94e708c021c95 100644 --- a/api_docs/inspector.json +++ b/api_docs/inspector.json @@ -217,7 +217,8 @@ "docId": "kibCorePluginApi", "section": "def-public.OverlayRef", "text": "OverlayRef" - } + }, + "; }" ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", @@ -291,8 +292,7 @@ "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, - " extends ", - "EventEmitter" + " extends EventEmitter" ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", @@ -919,7 +919,23 @@ "label": "component", "description": [], "signature": [ - "React.ComponentType<", + "React.ComponentClass<", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewProps", + "text": "InspectorViewProps" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ">, any> | React.FunctionComponent<", { "pluginId": "inspector", "scope": "public", @@ -1215,7 +1231,13 @@ "label": "InspectorSession", "description": [], "signature": [ - "OverlayRef" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], "source": { "path": "src/plugins/inspector/public/types.ts", @@ -1261,7 +1283,32 @@ "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 21 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "inspector", + "id": "def-public.view", + "type": "Object", + "tags": [], + "label": "view", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewDescription", + "text": "InspectorViewDescription" + } + ], + "source": { + "path": "src/plugins/inspector/public/view_registry.ts", + "lineNumber": 33 + }, + "deprecated": false + } + ] }, { "parentPluginId": "inspector", @@ -1322,7 +1369,37 @@ "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 37 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "True, if a call to `open` with the same adapters\nwould have shown the inspector panel, false otherwise." + ], + "children": [ + { + "parentPluginId": "inspector", + "id": "def-public.adapters", + "type": "Object", + "tags": [], + "label": "adapters", + "description": [ + "- An object of adapters. This should be the same\nyou would pass into `open`." + ], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 37 + }, + "deprecated": false + } + ] }, { "parentPluginId": "inspector", @@ -1366,7 +1443,61 @@ "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 51 }, - "deprecated": false + "deprecated": false, + "returnComment": [ + "The session instance for the opened inspector." + ], + "children": [ + { + "parentPluginId": "inspector", + "id": "def-public.adapters", + "type": "Object", + "tags": [], + "label": "adapters", + "description": [ + "- An object of adapters for which you want to show\nthe inspector panel." + ], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 51 + }, + "deprecated": false + }, + { + "parentPluginId": "inspector", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- Options that configure the inspector. See InspectorOptions type." + ], + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorOptions", + "text": "InspectorOptions" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 51 + }, + "deprecated": false + } + ] } ], "lifecycle": "start", @@ -1402,8 +1533,7 @@ "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, - " extends ", - "EventEmitter" + " extends EventEmitter" ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json index 33874c82ab07a3..1b5309235addef 100644 --- a/api_docs/kibana_legacy.json +++ b/api_docs/kibana_legacy.json @@ -982,6 +982,25 @@ "lineNumber": 14 }, "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.options", + "type": "Unknown", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "unknown" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 15 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1000,7 +1019,7 @@ "section": "def-public.AngularHttpError", "text": "AngularHttpError" }, - ") => any" + ") => string" ], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", @@ -1184,6 +1203,8 @@ "lineNumber": 15 }, "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -1821,7 +1842,7 @@ "label": "AngularHttpError", "description": [], "signature": [ - "IHttpResponse<{ message: string; }>" + "angular.IHttpResponse<{ message: string; }>" ], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", @@ -1838,7 +1859,7 @@ "label": "createTopNavDirective", "description": [], "signature": [ - "angular.Injectable>" + "angular.IDirectiveFactory | (string | angular.IDirectiveFactory)[]" ], "source": { "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", @@ -1855,7 +1876,7 @@ "label": "IPrivate", "description": [], "signature": [ - "(provider: (...injectable: any[]) => T) => T" + "(provider: (...injectable: any[]) => T) => T" ], "source": { "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", @@ -1872,7 +1893,7 @@ "label": "KbnAccessibleClickProvider", "description": [], "signature": [ - "angular.Injectable>" + "angular.IDirectiveFactory | (string | angular.IDirectiveFactory)[]" ], "source": { "path": "src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts", diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json index aa21e6090ea27e..a477de7c6512c1 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -151,7 +151,23 @@ "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 122 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.filter", + "type": "string", + "tags": [], + "label": "filter", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 122 + }, + "deprecated": false + } + ] }, { "parentPluginId": "kibanaReact", @@ -531,15 +547,7 @@ "label": "getDerivedStateFromProps", "description": [], "signature": [ - "typeof ", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.ValidatedDualRange", - "text": "ValidatedDualRange" - }, - ".getDerivedStateFromProps" + "(nextProps: Props, prevState: State) => { value: [React.ReactText, React.ReactText] | undefined; prevValue: [React.ReactText, React.ReactText] | undefined; isValid: boolean; errorMessage: string; } | null" ], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", @@ -1030,7 +1038,7 @@ "label": "KibanaContextProvider", "description": [], "signature": [ - "React.FC<{ services?: {} | undefined; }>" + "React.FunctionComponent<{ services?: {} | undefined; }>" ], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", @@ -1573,7 +1581,9 @@ "type": "CompoundType", "tags": [], "label": "ReactComp", - "description": [], + "description": [ + "A React component." + ], "signature": [ "React.ComponentType" ], @@ -1659,7 +1669,9 @@ "type": "CompoundType", "tags": [], "label": "node", - "description": [], + "description": [ + "to get a mount point for" + ], "signature": [ "React.ReactNode" ], @@ -2125,7 +2137,9 @@ "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", "lineNumber": 15 }, - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false @@ -2163,7 +2177,7 @@ "\nLabel for the button" ], "signature": [ - "React.ReactNode" + "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", @@ -2181,7 +2195,7 @@ "\nIcon representing the field type.\nRecommend using FieldIcon" ], "signature": [ - "React.ReactNode" + "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", @@ -2199,7 +2213,7 @@ "\nAn optional node to place inside and at the end of the