diff --git a/api_docs/actions.json b/api_docs/actions.json index 8bd644be376d7..3b69924712504 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -252,9 +252,7 @@ "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 40 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "actions", @@ -278,9 +276,7 @@ "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 41 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -520,55 +516,14 @@ "label": "executor", "description": [], "signature": [ - "(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" - }, - ">" + "ExecutorType", + "" ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 116 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -788,7 +743,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\" | \"error\" | \"info\" | \"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\" | \"info\" | \"error\" | \"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", @@ -805,7 +760,7 @@ "label": "ActionParamsType", "description": [], "signature": [ - "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" + "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", @@ -968,38 +923,7 @@ "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", @@ -1054,7 +978,7 @@ ], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", - "lineNumber": 121 + "lineNumber": 129 }, "deprecated": false, "initialIsOpen": false @@ -1795,7 +1719,7 @@ "label": "config", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "x-pack/plugins/actions/common/types.ts", diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json index a87967f0970e9..791915c9fcd61 100644 --- a/api_docs/advanced_settings.json +++ b/api_docs/advanced_settings.json @@ -58,9 +58,7 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 30 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "advancedSettings", @@ -76,9 +74,7 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 31 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "advancedSettings", @@ -94,9 +90,7 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 32 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ] }, @@ -157,55 +151,7 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 73 }, - "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 - } - ] + "deprecated": false } ] }, @@ -252,26 +198,7 @@ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", "lineNumber": 78 }, - "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 - } - ] + "deprecated": false } ] } @@ -290,36 +217,15 @@ "\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.ExoticComponent> & { 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 13a150d0af00d..3a6c541f29d17 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -36,75 +36,7 @@ "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 15 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "alerting", @@ -122,62 +54,7 @@ "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 20 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "setup", @@ -226,23 +103,7 @@ "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 23 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -516,15 +377,13 @@ "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; }" + "section": "def-common.SanitizedRuleConfig", + "text": "SanitizedRuleConfig" + } ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", @@ -659,9 +518,7 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 47 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "alerting", @@ -679,9 +536,7 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 48 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "alerting", @@ -705,9 +560,7 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 49 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "alerting", @@ -723,9 +576,7 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 50 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -830,23 +681,7 @@ "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 75 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -988,14 +823,7 @@ "label": "executor", "description": [], "signature": [ - "(options: ", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertExecutorOptions", - "text": "AlertExecutorOptions" - }, + "ExecutorType", ">) => Promise" + ">" ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 131 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "alerting", @@ -1188,7 +990,7 @@ "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\">[]" + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" ], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", @@ -1295,9 +1097,7 @@ "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 106 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "alerting", @@ -1323,7 +1123,7 @@ "section": "def-server.AlertsClient", "text": "AlertsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" ], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -1433,9 +1233,7 @@ "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 111 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -1451,23 +1249,7 @@ "label": "ActionGroupIdsOf", "description": [], "signature": [ - "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" + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", @@ -1535,7 +1317,7 @@ "label": "AlertsClient", "description": [], "signature": [ - "{ get: = never>({ id, }: { id: string; }) => Promise({ id, }: { id: string; }) => Promise, \"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, }: ", + ", \"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, }: ", "CreateOptions", ") => Promise, \"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?: ", + ", \"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?: ", "FindOptions", " | undefined; }) => Promise<", { @@ -1562,38 +1344,7 @@ "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", @@ -1644,23 +1395,7 @@ "label": "PartialAlert", "description": [], "signature": [ - "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\">>" + "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", @@ -1677,13 +1412,7 @@ "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", @@ -2759,7 +2488,13 @@ "label": "status", "description": [], "signature": [ - "\"OK\" | \"Active\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertInstanceStatusValues", + "text": "AlertInstanceStatusValues" + } ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", @@ -2988,7 +2723,13 @@ "label": "status", "description": [], "signature": [ - "\"OK\" | \"Active\" | \"Error\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertStatusValues", + "text": "AlertStatusValues" + } ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", @@ -3036,7 +2777,7 @@ "label": "instances", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", @@ -3449,23 +3190,7 @@ "label": "ActionGroupIdsOf", "description": [], "signature": [ - "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" + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", @@ -3482,11 +3207,11 @@ "label": "AlertActionParam", "description": [], "signature": [ - "string | number | boolean | ", + "undefined | null | string | number | false | true | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", - "[] | null | undefined" + "[]" ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", @@ -3857,7 +3582,7 @@ "label": "ReservedActionGroups", "description": [], "signature": [ - "\"recovered\" | RecoveryActionGroupId" + "RecoveryActionGroupId | \"recovered\"" ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", @@ -3874,31 +3599,7 @@ "label": "SanitizedAlert", "description": [], "signature": [ - "{ 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" - }, - "; }" + "{ 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; }" ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", @@ -3915,15 +3616,7 @@ "label": "SanitizedRuleConfig", "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; }" + "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; }" ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", @@ -3940,15 +3633,7 @@ "label": "WithoutReservedActionGroups", "description": [], "signature": [ - "ActionGroupIds extends ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ReservedActionGroups", - "text": "ReservedActionGroups" - }, - " ? never : ActionGroupIds" + "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", @@ -3992,8 +3677,7 @@ "; }>, ", "PartialC", "<{ spaceId: ", - "StringC", - "; }>]>" + "StringC" ], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", @@ -4018,38 +3702,7 @@ ", ", "UnknownC", ">; alertInstances: ", - "RecordC", - "<", - "StringC", - ", ", - "PartialC", - "<{ state: ", - "RecordC", - "<", - "StringC", - ", ", - "UnknownC", - ">; meta: ", - "PartialC", - "<{ lastScheduledActions: ", - "IntersectionC", - "<[", - "PartialC", - "<{ subgroup: ", - "StringC", - "; }>, ", - "TypeC", - "<{ group: ", - "StringC", - "; date: ", - "Type", - "; }>]>; }>; }>>; previousStartedAt: ", - "UnionC", - "<[", - "NullC", - ", ", - "Type", - "]>; }>" + "RecordC" ], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", @@ -4091,20 +3744,7 @@ ", ", "UnknownC", ">; meta: ", - "PartialC", - "<{ lastScheduledActions: ", - "IntersectionC", - "<[", - "PartialC", - "<{ subgroup: ", - "StringC", - "; }>, ", - "TypeC", - "<{ group: ", - "StringC", - "; date: ", - "Type", - "; }>]>; }>; }>" + "PartialC" ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", @@ -4121,7 +3761,15 @@ "label": "RecoveredActionGroup", "description": [], "signature": [ - "{ readonly id: \"recovered\"; readonly name: string; }" + "Readonly<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "<\"recovered\">>" ], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", diff --git a/api_docs/apm.json b/api_docs/apm.json index 7eee0349fa349..20c3eb20e5851 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -78,7 +78,7 @@ ], "source": { "path": "x-pack/plugins/apm/public/plugin.ts", - "lineNumber": 45 + "lineNumber": 47 }, "deprecated": false, "lifecycle": "setup", @@ -96,7 +96,7 @@ ], "source": { "path": "x-pack/plugins/apm/public/plugin.ts", - "lineNumber": 47 + "lineNumber": 49 }, "deprecated": false, "lifecycle": "start", @@ -139,12 +139,11 @@ ", void, ", "APMPluginSetupDependencies", ", ", - "APMPluginStartDependencies", - ">" + "APMPluginStartDependencies" ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 55 + "lineNumber": 54 }, "deprecated": false, "children": [ @@ -160,7 +159,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 65 + "lineNumber": 64 }, "deprecated": false, "children": [ @@ -183,7 +182,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 65 + "lineNumber": 64 }, "deprecated": false, "isRequired": true @@ -214,30 +213,11 @@ ", \"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", - "; '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, {}>>; }>; }" + "SearchAggregatedTransactionSetting" ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 69 + "lineNumber": 68 }, "deprecated": false, "children": [ @@ -262,7 +242,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 70 + "lineNumber": 69 }, "deprecated": false, "isRequired": true @@ -281,7 +261,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 71 + "lineNumber": 70 }, "deprecated": false, "isRequired": true @@ -309,7 +289,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 269 + "lineNumber": 260 }, "deprecated": false, "children": [ @@ -331,7 +311,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 269 + "lineNumber": 260 }, "deprecated": false, "isRequired": true @@ -351,7 +331,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 288 + "lineNumber": 279 }, "deprecated": false, "children": [], @@ -605,176 +585,7 @@ "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", @@ -833,9 +644,7 @@ "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", @@ -852,2882 +661,140 @@ "label": "APMServerRouteRepository", "description": [], "signature": [ - "ServerRouteRepository", - "<", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", ", + "ServerRouteRepository; } & { \"GET /api/apm/index_pattern/dynamic\": ", "ServerRoute", - "<\"GET /api/apm/index_pattern/dynamic\", undefined, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { 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" + "<\"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 }, - ", { indexPatternTitle: string; }, ", - "APMRouteCreateOptions", - ">; } & { \"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 + }, + { + "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 }, - ", { 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.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", + " 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 75cb60610335b..bdfba6a93e195 100644 --- a/api_docs/apm_oss.json +++ b/api_docs/apm_oss.json @@ -5,606 +5,15 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [ - { - "parentPluginId": "apmOss", - "id": "def-public.APM_STATIC_INDEX_PATTERN_ID", - "type": "string", - "tags": [], - "label": "APM_STATIC_INDEX_PATTERN_ID", - "description": [], - "signature": [ - "\"apm_static_index_pattern_id\"" - ], - "source": { - "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", - "lineNumber": 9 - }, - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [], - "setup": { - "parentPluginId": "apmOss", - "id": "def-public.ApmOssPluginSetup", - "type": "Interface", - "tags": [], - "label": "ApmOssPluginSetup", - "description": [], - "source": { - "path": "src/plugins/apm_oss/public/types.ts", - "lineNumber": 10 - }, - "deprecated": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "apmOss", - "id": "def-public.ApmOssPluginStart", - "type": "Interface", - "tags": [], - "label": "ApmOssPluginStart", - "description": [], - "source": { - "path": "src/plugins/apm_oss/public/types.ts", - "lineNumber": 13 - }, - "deprecated": false, - "children": [], - "lifecycle": "start", - "initialIsOpen": true - } + "misc": [], + "objects": [] }, "server": { "classes": [], - "functions": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createDjangoAgentInstructions", - "type": "Function", - "tags": [], - "label": "createDjangoAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 88 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createDjangoAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 88 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createDjangoAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 88 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createDotNetAgentInstructions", - "type": "Function", - "tags": [], - "label": "createDotNetAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; commands: string[]; textPost: string; textPre?: undefined; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 631 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createDotNetAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 631 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createDotNetAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 631 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createFlaskAgentInstructions", - "type": "Function", - "tags": [], - "label": "createFlaskAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 173 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createFlaskAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 173 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createFlaskAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 173 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createGoAgentInstructions", - "type": "Function", - "tags": [], - "label": "createGoAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 492 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createGoAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 492 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createGoAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 492 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createJavaAgentInstructions", - "type": "Function", - "tags": [], - "label": "createJavaAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 585 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createJavaAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 585 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createJavaAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 585 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createJsAgentInstructions", - "type": "Function", - "tags": [], - "label": "createJsAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; textPre: string; commands: string[]; textPost?: undefined; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 393 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createJsAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 393 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createNodeAgentInstructions", - "type": "Function", - "tags": [], - "label": "createNodeAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 11 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createNodeAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 11 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createNodeAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 11 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createPhpAgentInstructions", - "type": "Function", - "tags": [], - "label": "createPhpAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 705 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createPhpAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 705 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createPhpAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 705 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createRackAgentInstructions", - "type": "Function", - "tags": [], - "label": "createRackAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 298 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createRackAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 298 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createRackAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 298 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createRailsAgentInstructions", - "type": "Function", - "tags": [], - "label": "createRailsAgentInstructions", - "description": [], - "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 255 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "apmOss", - "id": "def-server.createRailsAgentInstructions.$1", - "type": "string", - "tags": [], - "label": "apmServerUrl", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 255 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "apmOss", - "id": "def-server.createRailsAgentInstructions.$2", - "type": "string", - "tags": [], - "label": "secretToken", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", - "lineNumber": 255 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], + "functions": [], "interfaces": [], "enums": [], "misc": [ - { - "parentPluginId": "apmOss", - "id": "def-server.APM_STATIC_INDEX_PATTERN_ID", - "type": "string", - "tags": [], - "label": "APM_STATIC_INDEX_PATTERN_ID", - "description": [], - "signature": [ - "\"apm_static_index_pattern_id\"" - ], - "source": { - "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", - "lineNumber": 9 - }, - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "apmOss", "id": "def-server.APMOSSConfig", @@ -617,7 +26,7 @@ ], "source": { "path": "src/plugins/apm_oss/server/index.ts", - "lineNumber": 32 + "lineNumber": 31 }, "deprecated": false, "initialIsOpen": false @@ -633,7 +42,7 @@ "description": [], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", - "lineNumber": 47 + "lineNumber": 27 }, "deprecated": false, "children": [ @@ -645,11 +54,11 @@ "label": "config", "description": [], "signature": [ - "{ 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; }" + "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", - "lineNumber": 48 + "lineNumber": 28 }, "deprecated": false }, @@ -666,34 +75,9 @@ ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", - "lineNumber": 49 + "lineNumber": 29 }, "deprecated": false - }, - { - "parentPluginId": "apmOss", - "id": "def-server.APMOSSPluginSetup.getRegisteredTutorialProvider", - "type": "Function", - "tags": [], - "label": "getRegisteredTutorialProvider", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.TutorialProvider", - "text": "TutorialProvider" - } - ], - "source": { - "path": "src/plugins/apm_oss/server/plugin.ts", - "lineNumber": 50 - }, - "deprecated": false, - "children": [], - "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/apm_oss.mdx b/api_docs/apm_oss.mdx index c4facc4e390b6..7370704001378 100644 --- a/api_docs/apm_oss.mdx +++ b/api_docs/apm_oss.mdx @@ -11,25 +11,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex import apmOssObj from './apm_oss.json'; -## Client - -### Setup - - -### Start - - -### Consts, variables and types - - ## Server ### Setup -### Functions - - ### Consts, variables and types diff --git a/api_docs/banners.json b/api_docs/banners.json index ab2aedc00eb6c..27810c9ecc5db 100644 --- a/api_docs/banners.json +++ b/api_docs/banners.json @@ -41,7 +41,13 @@ "label": "placement", "description": [], "signature": [ - "\"top\" | \"disabled\"" + { + "pluginId": "banners", + "scope": "common", + "docId": "kibBannersPluginApi", + "section": "def-common.BannerPlacement", + "text": "BannerPlacement" + } ], "source": { "path": "x-pack/plugins/banners/common/types.ts", diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json index 76b2118282b2e..a6efe251af115 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", @@ -78,7 +78,7 @@ "description": [], "source": { "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 24 + "lineNumber": 23 }, "deprecated": false, "children": [ @@ -94,32 +94,13 @@ "FetchStreamingParams", ") => { xhr: XMLHttpRequest; stream: ", "Observable", - "; }" + "; }" ], "source": { "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 25 + "lineNumber": 24 }, - "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": 25 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "bfetch", @@ -143,29 +124,9 @@ ], "source": { "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 26 + "lineNumber": 25 }, - "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": 27 - }, - "deprecated": false - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -195,7 +156,7 @@ ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 39 + "lineNumber": 41 }, "deprecated": false, "children": [ @@ -211,28 +172,9 @@ ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 40 + "lineNumber": 42 }, - "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": 40 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -290,7 +232,7 @@ "description": [], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 44 + "lineNumber": 46 }, "deprecated": false, "children": [ @@ -322,57 +264,9 @@ ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 45 + "lineNumber": 47 }, - "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": 46 - }, - "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": 47 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "bfetch", @@ -402,57 +296,9 @@ ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 49 + "lineNumber": 51 }, - "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": 50 - }, - "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": 51 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "bfetch", @@ -503,227 +349,13 @@ "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": 81 + "lineNumber": 83 }, - "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": 89 - }, - "deprecated": false - } - ] + "deprecated": false } ], "lifecycle": "setup", @@ -738,7 +370,7 @@ "description": [], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 94 + "lineNumber": 96 }, "deprecated": false, "children": [], @@ -1252,26 +884,7 @@ "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 15 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "bfetch", @@ -1287,26 +900,7 @@ "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "lineNumber": 16 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "bfetch", @@ -1343,6 +937,48 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "bfetch", + "id": "def-common.BatchItemWrapper", + "type": "Interface", + "tags": [], + "label": "BatchItemWrapper", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 23 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-common.BatchItemWrapper.compressed", + "type": "boolean", + "tags": [], + "label": "compressed", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 24 + }, + "deprecated": false + }, + { + "parentPluginId": "bfetch", + "id": "def-common.BatchItemWrapper.payload", + "type": "string", + "tags": [], + "label": "payload", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 25 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "bfetch", "id": "def-common.BatchRequestData", @@ -1542,26 +1178,7 @@ "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "lineNumber": 22 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -1684,7 +1301,25 @@ } ], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "bfetch", + "id": "def-common.DISABLE_BFETCH_COMPRESSION", + "type": "string", + "tags": [], + "label": "DISABLE_BFETCH_COMPRESSION", + "description": [], + "signature": [ + "\"bfetch:disableCompression\"" + ], + "source": { + "path": "src/plugins/bfetch/common/constants.ts", + "lineNumber": 9 + }, + "deprecated": false, + "initialIsOpen": false + } + ], "objects": [] } } \ No newline at end of file diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 0e9a9e79dbea6..faf3d7eefc7f9 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -47,3 +47,6 @@ import bfetchObj from './bfetch.json'; ### Interfaces +### Consts, variables and types + + diff --git a/api_docs/cases.json b/api_docs/cases.json index 3d77ada0c336b..6cd4a0ac48ae9 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -48,8 +48,7 @@ "docId": "kibCasesPluginApi", "section": "def-public.StartPlugins", "text": "StartPlugins" - }, - ">" + } ], "source": { "path": "x-pack/plugins/cases/public/plugin.ts", @@ -294,6 +293,38 @@ ], "functions": [], "interfaces": [ + { + "parentPluginId": "cases", + "id": "def-public.Owner", + "type": "Interface", + "tags": [], + "label": "Owner", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 42 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.Owner.owner", + "type": "Array", + "tags": [], + "label": "owner", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 43 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "cases", "id": "def-public.SetupPlugins", @@ -324,8 +355,7 @@ "; features$: ", "Observable", "<", - "SecurityLicenseFeatures", - ">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }" + "SecurityLicenseFeatures" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", @@ -409,32 +439,7 @@ "\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": [ - { - "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; }; }; }" + "CoreStart & StartPlugins & { security: SecurityPluginSetup; }" ], "source": { "path": "x-pack/plugins/cases/public/types.ts", @@ -454,7 +459,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 42 + "lineNumber": 46 }, "deprecated": false, "children": [ @@ -470,32 +475,13 @@ "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": 43 + "lineNumber": 47 }, - "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": 43 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "cases", @@ -509,32 +495,13 @@ "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": 44 + "lineNumber": 48 }, - "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": 45 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "cases", @@ -548,32 +515,13 @@ "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": 47 + "lineNumber": 51 }, - "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": 47 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "cases", @@ -587,32 +535,13 @@ "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": 48 + "lineNumber": 52 }, - "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": 48 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "cases", @@ -626,32 +555,13 @@ "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": 49 + "lineNumber": 53 }, - "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": 49 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "cases", @@ -665,32 +575,13 @@ "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": 50 + "lineNumber": 54 }, - "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": 50 - }, - "deprecated": false - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -698,7 +589,170 @@ } }, "server": { - "classes": [], + "classes": [ + { + "parentPluginId": "cases", + "id": "def-server.CasesClient", + "type": "Class", + "tags": [], + "label": "CasesClient", + "description": [ + "\nClient wrapper that contains accessor methods for individual entities within the cases system." + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 21 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 30 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "CasesClientArgs" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 30 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nRetrieves an interface for interacting with cases entities." + ], + "signature": [ + "CasesSubClient" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 43 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.attachments", + "type": "Object", + "tags": [], + "label": "attachments", + "description": [ + "\nRetrieves an interface for interacting with attachments (comments) entities." + ], + "signature": [ + "AttachmentsSubClient" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 50 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.userActions", + "type": "Object", + "tags": [], + "label": "userActions", + "description": [ + "\nRetrieves an interface for interacting with the user actions associated with the plugin entities." + ], + "signature": [ + "UserActionsSubClient" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 57 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.subCases", + "type": "Object", + "tags": [], + "label": "subCases", + "description": [ + "\nRetrieves an interface for interacting with the case as a connector entities.\n\nCurrently this functionality is disabled and will throw an error if this function is called." + ], + "signature": [ + "SubCasesClient" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 66 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.configure", + "type": "Object", + "tags": [], + "label": "configure", + "description": [ + "\nRetrieves an interface for interacting with the configuration of external connectors for the plugin entities." + ], + "signature": [ + "ConfigureSubClient" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 76 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesClient.stats", + "type": "Object", + "tags": [], + "label": "stats", + "description": [ + "\nRetrieves an interface for retrieving statistics related to the cases entities." + ], + "signature": [ + "StatsSubClient" + ], + "source": { + "path": "x-pack/plugins/cases/server/client/client.ts", + "lineNumber": 83 + }, + "deprecated": false + } + ], + "initialIsOpen": false + } + ], "functions": [], "interfaces": [ { @@ -710,7 +764,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 12 + "lineNumber": 18 }, "deprecated": false, "children": [ @@ -722,1530 +776,665 @@ "label": "getCasesClient", "description": [], "signature": [ - "() => ", + "() => Promise<", { "pluginId": "cases", "scope": "server", "docId": "kibCasesPluginApi", "section": "def-server.CasesClient", "text": "CasesClient" - } + }, + ">" ], "source": { "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 13 + "lineNumber": 19 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-server.CasesClient", + "id": "def-server.PluginStartContract", "type": "Interface", "tags": [], - "label": "CasesClient", + "label": "PluginStartContract", "description": [ - "\nThis represents the interface that other plugins can access." + "\nCases server exposed contract for interacting with cases entities." ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 102 + "path": "x-pack/plugins/cases/server/plugin.ts", + "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.addComment", + "id": "def-server.PluginStartContract.getCasesClientWithRequest", "type": "Function", "tags": [], - "label": "addComment", - "description": [], + "label": "getCasesClientWithRequest", + "description": [ + "\nReturns a client which can be used to interact with the cases backend entities.\n" + ], "signature": [ - "(args: ", - "CasesClientAddComment", - ") => Promise<{ 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: ", + "(request: ", { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { 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: ", + ") => Promise<", { "pluginId": "cases", - "scope": "common", + "scope": "server", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" + "section": "def-server.CasesClient", + "text": "CasesClient" }, - "; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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/server/client/types.ts", - "lineNumber": 103 - }, - "deprecated": false, - "children": [ + ">" + ], + "source": { + "path": "x-pack/plugins/cases/server/plugin.ts", + "lineNumber": 62 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.addComment.$1", + "id": "def-server.PluginStartContract.getCasesClientWithRequest.$1", "type": "Object", "tags": [], - "label": "args", - "description": [], + "label": "request", + "description": [ + "a KibanaRequest" + ], "signature": [ - "CasesClientAddComment" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 103 + "path": "x-pack/plugins/cases/server/plugin.ts", + "lineNumber": 62 }, "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "a {@link CasesClient}" + ] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "cases", + "id": "def-common.createPlainError", + "type": "Function", + "tags": [], + "label": "createPlainError", + "description": [], + "signature": [ + "(message: string) => Error" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 53 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.createPlainError.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 53 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.decodeOrThrow", + "type": "Function", + "tags": [], + "label": "decodeOrThrow", + "description": [], + "signature": [ + "(runtimeType: ", + "Type", + ", createError?: ErrorFactory) => (inputValue: I) => A" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 59 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.decodeOrThrow.$1", + "type": "Object", + "tags": [], + "label": "runtimeType", + "description": [], + "signature": [ + "Type", + "" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 60 + }, + "deprecated": false, + "isRequired": true }, { "parentPluginId": "cases", - "id": "def-server.CasesClient.create", + "id": "def-common.decodeOrThrow.$2", "type": "Function", "tags": [], - "label": "create", + "label": "createError", "description": [], "signature": [ - "(theCase: { 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", - "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; }; }) => Promise<{ 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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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; }>" + "ErrorFactory" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 104 + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 61 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.create.$1", - "type": "CompoundType", - "tags": [], - "label": "theCase", - "description": [], - "signature": [ - "{ 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", - "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; }; }" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 104 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.excess", + "type": "Function", + "tags": [], + "label": "excess", + "description": [], + "signature": [ + "(codec: C) => C" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 75 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.get", - "type": "Function", + "id": "def-common.excess.$1", + "type": "Uncategorized", "tags": [], - "label": "get", + "label": "codec", "description": [], "signature": [ - "(args: ", - "CasesClientGet", - ") => Promise<{ 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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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; }>" + "C" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 105 + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 76 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.get.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "CasesClientGet" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 105 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.formatErrors", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "formatErrors", + "description": [], + "signature": [ + "(errors: ", + "Errors", + ") => string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 24 + }, + "deprecated": true, + "references": [], + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.getAlerts", - "type": "Function", + "id": "def-common.formatErrors.$1", + "type": "Object", "tags": [], - "label": "getAlerts", + "label": "errors", "description": [], "signature": [ - "(args: ", - "CasesClientGetAlerts", - ") => Promise<", - "CasesClientGetAlertsResponse", - ">" + "Errors" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 106 + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 24 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.getAlerts.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "CasesClientGetAlerts" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 106 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentDetailsUrl", + "type": "Function", + "tags": [], + "label": "getCaseCommentDetailsUrl", + "description": [], + "signature": [ + "(caseId: string, commentId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 37 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.getFields", - "type": "Function", + "id": "def-common.getCaseCommentDetailsUrl.$1", + "type": "string", "tags": [], - "label": "getFields", + "label": "caseId", "description": [], "signature": [ - "(args: ", - "ConfigureFields", - ") => Promise<{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }>" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 107 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 37 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.getFields.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "ConfigureFields" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 107 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true }, { "parentPluginId": "cases", - "id": "def-server.CasesClient.getMappings", - "type": "Function", + "id": "def-common.getCaseCommentDetailsUrl.$2", + "type": "string", "tags": [], - "label": "getMappings", + "label": "commentId", "description": [], "signature": [ - "(args: ", - "MappingsClient", - ") => Promise<{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]>" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 108 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 37 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.getMappings.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "MappingsClient" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 108 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseCommentsUrl", + "type": "Function", + "tags": [], + "label": "getCaseCommentsUrl", + "description": [], + "signature": [ + "(id: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 33 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.getUserActions", - "type": "Function", + "id": "def-common.getCaseCommentsUrl.$1", + "type": "string", "tags": [], - "label": "getUserActions", + "label": "id", "description": [], "signature": [ - "(args: ", - "CasesClientGetUserActions", - ") => Promise<({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]>" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 109 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 33 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.getUserActions.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "CasesClientGetUserActions" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 109 - }, - "deprecated": false, - "isRequired": true - } + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseConfigurationDetailsUrl", + "type": "Function", + "tags": [], + "label": "getCaseConfigurationDetailsUrl", + "description": [], + "signature": [ + "(configureID: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 53 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCaseConfigurationDetailsUrl.$1", + "type": "string", + "tags": [], + "label": "configureID", + "description": [], + "signature": [ + "string" ], - "returnComment": [] - }, + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 53 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseDetailsUrl", + "type": "Function", + "tags": [], + "label": "getCaseDetailsUrl", + "description": [], + "signature": [ + "(id: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 21 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.push", - "type": "Function", + "id": "def-common.getCaseDetailsUrl.$1", + "type": "string", "tags": [], - "label": "push", + "label": "id", "description": [], "signature": [ - "(args: ", - "CasesClientPush", - ") => Promise<{ 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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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; }>" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 110 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 21 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.push.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "CasesClientPush" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 110 - }, - "deprecated": false, - "isRequired": true - } + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCasePushUrl", + "type": "Function", + "tags": [], + "label": "getCasePushUrl", + "description": [], + "signature": [ + "(caseId: string, connectorId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 49 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.getCasePushUrl.$1", + "type": "string", + "tags": [], + "label": "caseId", + "description": [], + "signature": [ + "string" ], - "returnComment": [] + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 49 + }, + "deprecated": false, + "isRequired": true }, { "parentPluginId": "cases", - "id": "def-server.CasesClient.update", - "type": "Function", + "id": "def-common.getCasePushUrl.$2", + "type": "string", "tags": [], - "label": "update", + "label": "connectorId", "description": [], "signature": [ - "(args: { 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?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - }, - " | undefined; 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; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; })[]; }) => Promise<({ 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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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; })[]>" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 111 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 49 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.update.$1", - "type": "Object", - "tags": [], - "label": "args", - "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?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - }, - " | undefined; 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; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; })[]; }" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 111 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCasesFromAlertsUrl", + "type": "Function", + "tags": [], + "label": "getCasesFromAlertsUrl", + "description": [], + "signature": [ + "(alertId: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 57 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.updateAlertsStatus", - "type": "Function", + "id": "def-common.getCasesFromAlertsUrl.$1", + "type": "string", "tags": [], - "label": "updateAlertsStatus", + "label": "alertId", "description": [], "signature": [ - "(args: ", - "CasesClientUpdateAlertsStatus", - ") => Promise" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 112 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 57 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.updateAlertsStatus.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "CasesClientUpdateAlertsStatus" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 112 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.getCaseUserActionUrl", + "type": "Function", + "tags": [], + "label": "getCaseUserActionUrl", + "description": [], + "signature": [ + "(id: string) => string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 41 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-server.CasesClient.getCaseIdsByAlertId", - "type": "Function", + "id": "def-common.getCaseUserActionUrl.$1", + "type": "string", "tags": [], - "label": "getCaseIdsByAlertId", + "label": "id", "description": [], "signature": [ - "(args: ", - "CasesClientGetCasesByAlert", - ") => Promise" + "string" ], "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 113 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 41 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.CasesClient.getCaseIdsByAlertId.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "CasesClientGetCasesByAlert" - ], - "source": { - "path": "x-pack/plugins/cases/server/client/types.ts", - "lineNumber": 113 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-server.PluginStartContract", - "type": "Interface", + "id": "def-common.getSubCaseDetailsUrl", + "type": "Function", "tags": [], - "label": "PluginStartContract", + "label": "getSubCaseDetailsUrl", "description": [], + "signature": [ + "(caseID: string, subCaseId: string) => string" + ], "source": { - "path": "x-pack/plugins/cases/server/index.ts", + "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 29 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-server.PluginStartContract.getCasesClientWithRequestAndContext", - "type": "Function", + "id": "def-common.getSubCaseDetailsUrl.$1", + "type": "string", "tags": [], - "label": "getCasesClientWithRequestAndContext", + "label": "caseID", "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" - }, - ") => ", - { - "pluginId": "cases", - "scope": "server", - "docId": "kibCasesPluginApi", - "section": "def-server.CasesClient", - "text": "CasesClient" - } + "string" ], "source": { - "path": "x-pack/plugins/cases/server/index.ts", - "lineNumber": 30 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 29 }, "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-server.PluginStartContract.getCasesClientWithRequestAndContext.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - } - ], - "source": { - "path": "x-pack/plugins/cases/server/index.ts", - "lineNumber": 31 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "cases", - "id": "def-server.PluginStartContract.getCasesClientWithRequestAndContext.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "source": { - "path": "x-pack/plugins/cases/server/index.ts", - "lineNumber": 32 - }, - "deprecated": false, - "isRequired": true - } + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.getSubCaseDetailsUrl.$2", + "type": "string", + "tags": [], + "label": "subCaseId", + "description": [], + "signature": [ + "string" ], - "returnComment": [] + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 29 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false - } - ], - "enums": [], - "misc": [], - "objects": [] - }, - "common": { - "classes": [], - "functions": [ + }, { "parentPluginId": "cases", - "id": "def-common.createPlainError", + "id": "def-common.getSubCasesUrl", "type": "Function", "tags": [], - "label": "createPlainError", + "label": "getSubCasesUrl", "description": [], "signature": [ - "(message: string) => Error" + "(caseID: string) => string" ], "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 49 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 25 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.createPlainError.$1", + "id": "def-common.getSubCasesUrl.$1", "type": "string", "tags": [], - "label": "message", + "label": "caseID", "description": [], "signature": [ "string" ], "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 49 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 25 }, "deprecated": false, "isRequired": true @@ -2256,53 +1445,50 @@ }, { "parentPluginId": "cases", - "id": "def-common.decodeOrThrow", + "id": "def-common.getSubCaseUserActionUrl", "type": "Function", "tags": [], - "label": "decodeOrThrow", + "label": "getSubCaseUserActionUrl", "description": [], "signature": [ - "(runtimeType: ", - "Type", - ", createError?: ErrorFactory) => (inputValue: I) => A" + "(caseID: string, subCaseId: string) => string" ], "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 55 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 45 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.decodeOrThrow.$1", - "type": "Object", + "id": "def-common.getSubCaseUserActionUrl.$1", + "type": "string", "tags": [], - "label": "runtimeType", + "label": "caseID", "description": [], "signature": [ - "Type", - "" + "string" ], "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 56 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 45 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "cases", - "id": "def-common.decodeOrThrow.$2", - "type": "Function", + "id": "def-common.getSubCaseUserActionUrl.$2", + "type": "string", "tags": [], - "label": "createError", + "label": "subCaseId", "description": [], "signature": [ - "ErrorFactory" + "string" ], "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 57 + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 45 }, "deprecated": false, "isRequired": true @@ -2313,33 +1499,52 @@ }, { "parentPluginId": "cases", - "id": "def-common.excess", + "id": "def-common.OmitProp", "type": "Function", "tags": [], - "label": "excess", + "label": "OmitProp", "description": [], "signature": [ - "(codec: C) => C" + "(o: O, k: K) => Pick>" ], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 71 + "lineNumber": 17 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.excess.$1", + "id": "def-common.OmitProp.$1", "type": "Uncategorized", "tags": [], - "label": "codec", + "label": "o", "description": [], "signature": [ - "C" + "O" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 17 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.OmitProp.$2", + "type": "Uncategorized", + "tags": [], + "label": "k", + "description": [], + "signature": [ + "K" ], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 71 + "lineNumber": 17 }, "deprecated": false, "isRequired": true @@ -2350,38 +1555,35 @@ }, { "parentPluginId": "cases", - "id": "def-common.formatErrors", + "id": "def-common.throwErrors", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "formatErrors", + "tags": [], + "label": "throwErrors", "description": [], "signature": [ - "(errors: ", + "(createError: ErrorFactory) => (errors: ", "Errors", - ") => string[]" + ") => never" ], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 20 + "lineNumber": 55 }, - "deprecated": true, - "references": [], + "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.formatErrors.$1", - "type": "Object", + "id": "def-common.throwErrors.$1", + "type": "Function", "tags": [], - "label": "errors", + "label": "createError", "description": [], "signature": [ - "Errors" + "ErrorFactory" ], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 20 + "lineNumber": 55 }, "deprecated": false, "isRequired": true @@ -2389,524 +1591,476 @@ ], "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "cases", - "id": "def-common.getCaseCommentDetailsUrl", - "type": "Function", + "id": "def-common.ActionLicense", + "type": "Interface", "tags": [], - "label": "getCaseCommentDetailsUrl", + "label": "ActionLicense", "description": [], - "signature": [ - "(caseId: string, commentId: string) => string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 36 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 145 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.getCaseCommentDetailsUrl.$1", + "id": "def-common.ActionLicense.id", "type": "string", "tags": [], - "label": "caseId", + "label": "id", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 36 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 146 }, - "deprecated": false, - "isRequired": true + "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.getCaseCommentDetailsUrl.$2", + "id": "def-common.ActionLicense.name", "type": "string", "tags": [], - "label": "commentId", + "label": "name", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 36 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 147 }, - "deprecated": false, - "isRequired": true + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 148 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.enabledInConfig", + "type": "boolean", + "tags": [], + "label": "enabledInConfig", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 149 + }, + "deprecated": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ActionLicense.enabledInLicense", + "type": "boolean", + "tags": [], + "label": "enabledInLicense", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 150 + }, + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.getCaseCommentsUrl", - "type": "Function", + "id": "def-common.AllCases", + "type": "Interface", "tags": [], - "label": "getCaseCommentsUrl", + "label": "AllCases", "description": [], "signature": [ - "(id: string) => string" + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AllCases", + "text": "AllCases" + }, + " extends ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CasesStatus", + "text": "CasesStatus" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 32 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 113 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.getCaseCommentsUrl.$1", - "type": "string", + "id": "def-common.AllCases.cases", + "type": "Array", "tags": [], - "label": "id", + "label": "cases", "description": [], "signature": [ - "string" + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + "[]" ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 32 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 114 }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.getCaseDetailsUrl", - "type": "Function", - "tags": [], - "label": "getCaseDetailsUrl", - "description": [], - "signature": [ - "(id: string) => string" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 20 - }, - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "cases", - "id": "def-common.getCaseDetailsUrl.$1", - "type": "string", + "id": "def-common.AllCases.page", + "type": "number", "tags": [], - "label": "id", + "label": "page", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 20 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 115 }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.getCasePushUrl", - "type": "Function", - "tags": [], - "label": "getCasePushUrl", - "description": [], - "signature": [ - "(caseId: string, connectorId: string) => string" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 48 - }, - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "cases", - "id": "def-common.getCasePushUrl.$1", - "type": "string", + "id": "def-common.AllCases.perPage", + "type": "number", "tags": [], - "label": "caseId", + "label": "perPage", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 48 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 116 }, - "deprecated": false, - "isRequired": true + "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.getCasePushUrl.$2", - "type": "string", + "id": "def-common.AllCases.total", + "type": "number", "tags": [], - "label": "connectorId", + "label": "total", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 48 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 117 }, - "deprecated": false, - "isRequired": true + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.getCasesFromAlertsUrl", - "type": "Function", + "id": "def-common.ApiProps", + "type": "Interface", "tags": [], - "label": "getCasesFromAlertsUrl", + "label": "ApiProps", "description": [], - "signature": [ - "(alertId: string) => string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 52 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 136 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.getCasesFromAlertsUrl.$1", - "type": "string", + "id": "def-common.ApiProps.signal", + "type": "Object", "tags": [], - "label": "alertId", + "label": "signal", "description": [], "signature": [ - "string" + "AbortSignal" ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 52 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 137 }, - "deprecated": false, - "isRequired": true + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.getCaseUserActionUrl", - "type": "Function", + "id": "def-common.BulkUpdateStatus", + "type": "Interface", "tags": [], - "label": "getCaseUserActionUrl", + "label": "BulkUpdateStatus", "description": [], - "signature": [ - "(id: string) => string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 40 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 140 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.getCaseUserActionUrl.$1", + "id": "def-common.BulkUpdateStatus.status", "type": "string", "tags": [], - "label": "id", + "label": "status", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 40 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 141 }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.getSubCaseDetailsUrl", - "type": "Function", - "tags": [], - "label": "getSubCaseDetailsUrl", - "description": [], - "signature": [ - "(caseID: string, subCaseId: string) => string" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 28 - }, - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "cases", - "id": "def-common.getSubCaseDetailsUrl.$1", + "id": "def-common.BulkUpdateStatus.id", "type": "string", "tags": [], - "label": "caseID", + "label": "id", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 28 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 142 }, - "deprecated": false, - "isRequired": true + "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.getSubCaseDetailsUrl.$2", + "id": "def-common.BulkUpdateStatus.version", "type": "string", "tags": [], - "label": "subCaseId", + "label": "version", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 28 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 143 }, - "deprecated": false, - "isRequired": true + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.getSubCasesUrl", - "type": "Function", + "id": "def-common.Case", + "type": "Interface", "tags": [], - "label": "getSubCasesUrl", + "label": "Case", "description": [], "signature": [ - "(caseID: string) => string" + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + " extends BasicCase" ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 24 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 81 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.getSubCasesUrl.$1", - "type": "string", + "id": "def-common.Case.connector", + "type": "CompoundType", "tags": [], - "label": "caseID", + "label": "connector", "description": [], "signature": [ - "string" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 24 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.getSubCaseUserActionUrl", - "type": "Function", - "tags": [], - "label": "getSubCaseUserActionUrl", - "description": [], - "signature": [ - "(caseID: string, subCaseId: string) => string" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 44 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-common.getSubCaseUserActionUrl.$1", - "type": "string", - "tags": [], - "label": "caseID", - "description": [], - "signature": [ - "string" + "({ 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" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 44 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 82 }, - "deprecated": false, - "isRequired": true + "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.getSubCaseUserActionUrl.$2", + "id": "def-common.Case.description", "type": "string", "tags": [], - "label": "subCaseId", + "label": "description", "description": [], - "signature": [ - "string" - ], "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 44 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 83 }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.throwErrors", - "type": "Function", - "tags": [], - "label": "throwErrors", - "description": [], - "signature": [ - "(createError: ErrorFactory) => (errors: ", - "Errors", - ") => never" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 51 - }, - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "cases", - "id": "def-common.throwErrors.$1", - "type": "Function", + "id": "def-common.Case.externalService", + "type": "CompoundType", "tags": [], - "label": "createError", + "label": "externalService", "description": [], "signature": [ - "ErrorFactory" + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseExternalService", + "text": "CaseExternalService" + }, + " | null" ], "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 51 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 84 }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "cases", - "id": "def-common.ActionLicense", - "type": "Interface", - "tags": [], - "label": "ActionLicense", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 144 - }, - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "cases", - "id": "def-common.ActionLicense.id", - "type": "string", + "id": "def-common.Case.subCases", + "type": "CompoundType", "tags": [], - "label": "id", + "label": "subCases", "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SubCase", + "text": "SubCase" + }, + "[] | null | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 145 + "lineNumber": 85 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ActionLicense.name", - "type": "string", + "id": "def-common.Case.subCaseIds", + "type": "Array", "tags": [], - "label": "name", + "label": "subCaseIds", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 146 + "lineNumber": 86 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ActionLicense.enabled", - "type": "boolean", + "id": "def-common.Case.settings", + "type": "Object", "tags": [], - "label": "enabled", + "label": "settings", "description": [], + "signature": [ + "{ syncAlerts: boolean; }" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 147 + "lineNumber": 87 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ActionLicense.enabledInConfig", - "type": "boolean", + "id": "def-common.Case.tags", + "type": "Array", "tags": [], - "label": "enabledInConfig", + "label": "tags", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 148 + "lineNumber": 88 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ActionLicense.enabledInLicense", - "type": "boolean", + "id": "def-common.Case.type", + "type": "Enum", "tags": [], - "label": "enabledInLicense", + "label": "type", "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + } + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 149 + "lineNumber": 89 }, "deprecated": false } @@ -2915,180 +2069,114 @@ }, { "parentPluginId": "cases", - "id": "def-common.AllCases", + "id": "def-common.CaseExternalService", "type": "Interface", "tags": [], - "label": "AllCases", + "label": "CaseExternalService", "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.AllCases", - "text": "AllCases" - }, - " extends ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CasesStatus", - "text": "CasesStatus" - } - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 112 + "lineNumber": 49 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.AllCases.cases", - "type": "Array", + "id": "def-common.CaseExternalService.pushedAt", + "type": "string", "tags": [], - "label": "cases", + "label": "pushedAt", "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.Case", - "text": "Case" - }, - "[]" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 113 + "lineNumber": 50 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.AllCases.page", - "type": "number", + "id": "def-common.CaseExternalService.pushedBy", + "type": "Object", "tags": [], - "label": "page", + "label": "pushedBy", "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + } + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 114 + "lineNumber": 51 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.AllCases.perPage", - "type": "number", + "id": "def-common.CaseExternalService.connectorId", + "type": "string", "tags": [], - "label": "perPage", + "label": "connectorId", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 115 + "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.AllCases.total", - "type": "number", - "tags": [], - "label": "total", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 116 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ApiProps", - "type": "Interface", - "tags": [], - "label": "ApiProps", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 135 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-common.ApiProps.signal", - "type": "Object", + "id": "def-common.CaseExternalService.connectorName", + "type": "string", "tags": [], - "label": "signal", + "label": "connectorName", "description": [], - "signature": [ - "AbortSignal" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 136 + "lineNumber": 53 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.BulkUpdateStatus", - "type": "Interface", - "tags": [], - "label": "BulkUpdateStatus", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 139 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.BulkUpdateStatus.status", + "id": "def-common.CaseExternalService.externalId", "type": "string", "tags": [], - "label": "status", + "label": "externalId", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 140 + "lineNumber": 54 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.BulkUpdateStatus.id", + "id": "def-common.CaseExternalService.externalTitle", "type": "string", "tags": [], - "label": "id", + "label": "externalTitle", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 141 + "lineNumber": 55 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.BulkUpdateStatus.version", + "id": "def-common.CaseExternalService.externalUrl", "type": "string", "tags": [], - "label": "version", + "label": "externalUrl", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 142 + "lineNumber": 56 }, "deprecated": false } @@ -3097,325 +2185,287 @@ }, { "parentPluginId": "cases", - "id": "def-common.Case", + "id": "def-common.CasesStatus", "type": "Interface", "tags": [], - "label": "Case", + "label": "CasesStatus", "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.Case", - "text": "Case" - }, - " extends BasicCase" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 80 + "lineNumber": 107 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.Case.connector", + "id": "def-common.CasesStatus.countClosedCases", "type": "CompoundType", "tags": [], - "label": "connector", + "label": "countClosedCases", "description": [], "signature": [ - "({ 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; })" + "number | null" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 81 + "lineNumber": 108 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Case.description", - "type": "string", + "id": "def-common.CasesStatus.countOpenCases", + "type": "CompoundType", "tags": [], - "label": "description", + "label": "countOpenCases", "description": [], + "signature": [ + "number | null" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 82 + "lineNumber": 109 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Case.externalService", + "id": "def-common.CasesStatus.countInProgressCases", "type": "CompoundType", "tags": [], - "label": "externalService", + "label": "countInProgressCases", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseExternalService", - "text": "CaseExternalService" - }, - " | null" + "number | null" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 83 + "lineNumber": 110 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActions", + "type": "Interface", + "tags": [], + "label": "CaseUserActions", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 37 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-common.Case.subCases", - "type": "CompoundType", + "id": "def-common.CaseUserActions.actionId", + "type": "string", "tags": [], - "label": "subCases", + "label": "actionId", "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.SubCase", - "text": "SubCase" - }, - "[] | null | undefined" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 84 + "lineNumber": 38 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Case.subCaseIds", + "id": "def-common.CaseUserActions.actionField", "type": "Array", "tags": [], - "label": "subCaseIds", + "label": "actionField", "description": [], "signature": [ - "string[]" + "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 85 + "lineNumber": 39 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Case.settings", - "type": "Object", + "id": "def-common.CaseUserActions.action", + "type": "CompoundType", "tags": [], - "label": "settings", + "label": "action", "description": [], "signature": [ - "{ syncAlerts: boolean; }" + "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 86 + "lineNumber": 40 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Case.tags", - "type": "Array", + "id": "def-common.CaseUserActions.actionAt", + "type": "string", "tags": [], - "label": "tags", + "label": "actionAt", "description": [], - "signature": [ - "string[]" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 87 + "lineNumber": 41 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Case.type", - "type": "Enum", + "id": "def-common.CaseUserActions.actionBy", + "type": "Object", "tags": [], - "label": "type", + "label": "actionBy", "description": [], "signature": [ { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" + "section": "def-common.ElasticUser", + "text": "ElasticUser" } ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 88 + "lineNumber": 42 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseExternalService", - "type": "Interface", - "tags": [], - "label": "CaseExternalService", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 49 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.pushedAt", + "id": "def-common.CaseUserActions.caseId", "type": "string", "tags": [], - "label": "pushedAt", + "label": "caseId", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 50 + "lineNumber": 43 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.pushedBy", - "type": "Object", + "id": "def-common.CaseUserActions.commentId", + "type": "CompoundType", "tags": [], - "label": "pushedBy", + "label": "commentId", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ElasticUser", - "text": "ElasticUser" - } + "string | null" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 51 + "lineNumber": 44 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.connectorId", - "type": "string", + "id": "def-common.CaseUserActions.newValue", + "type": "CompoundType", "tags": [], - "label": "connectorId", + "label": "newValue", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 52 + "lineNumber": 45 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.connectorName", - "type": "string", + "id": "def-common.CaseUserActions.oldValue", + "type": "CompoundType", "tags": [], - "label": "connectorName", + "label": "oldValue", "description": [], + "signature": [ + "string | null" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 53 + "lineNumber": 46 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DeleteCase", + "type": "Interface", + "tags": [], + "label": "DeleteCase", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 153 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.externalId", + "id": "def-common.DeleteCase.id", "type": "string", "tags": [], - "label": "externalId", + "label": "id", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 54 + "lineNumber": 154 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.externalTitle", - "type": "string", + "id": "def-common.DeleteCase.type", + "type": "CompoundType", "tags": [], - "label": "externalTitle", + "label": "type", "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | null" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 55 + "lineNumber": 155 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseExternalService.externalUrl", + "id": "def-common.DeleteCase.title", "type": "string", "tags": [], - "label": "externalUrl", + "label": "title", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 56 + "lineNumber": 156 }, "deprecated": false } @@ -3424,62 +2474,66 @@ }, { "parentPluginId": "cases", - "id": "def-common.CasesStatus", + "id": "def-common.Ecs", "type": "Interface", "tags": [], - "label": "CasesStatus", + "label": "Ecs", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 106 + "lineNumber": 226 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.CasesStatus.countClosedCases", - "type": "CompoundType", + "id": "def-common.Ecs._id", + "type": "string", "tags": [], - "label": "countClosedCases", + "label": "_id", "description": [], - "signature": [ - "number | null" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 107 + "lineNumber": 227 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CasesStatus.countOpenCases", - "type": "CompoundType", + "id": "def-common.Ecs._index", + "type": "string", "tags": [], - "label": "countOpenCases", + "label": "_index", "description": [], "signature": [ - "number | null" + "string | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 108 + "lineNumber": 228 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CasesStatus.countInProgressCases", - "type": "CompoundType", + "id": "def-common.Ecs.signal", + "type": "Object", "tags": [], - "label": "countInProgressCases", + "label": "signal", "description": [], "signature": [ - "number | null" + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SignalEcs", + "text": "SignalEcs" + }, + " | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 109 + "lineNumber": 229 }, "deprecated": false } @@ -3488,155 +2542,229 @@ }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions", + "id": "def-common.ElasticUser", "type": "Interface", "tags": [], - "label": "CaseUserActions", + "label": "ElasticUser", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 37 + "lineNumber": 125 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.actionId", - "type": "string", + "id": "def-common.ElasticUser.email", + "type": "CompoundType", "tags": [], - "label": "actionId", + "label": "email", "description": [], + "signature": [ + "string | null | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 38 + "lineNumber": 126 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.actionField", - "type": "Array", + "id": "def-common.ElasticUser.fullName", + "type": "CompoundType", "tags": [], - "label": "actionField", + "label": "fullName", "description": [], "signature": [ - "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" + "string | null | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 39 + "lineNumber": 127 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.action", + "id": "def-common.ElasticUser.username", "type": "CompoundType", "tags": [], - "label": "action", + "label": "username", "description": [], "signature": [ - "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" + "string | null | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 40 + "lineNumber": 128 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector", + "type": "Interface", + "tags": [], + "label": "ESCaseConnector", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 100 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnector.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 101 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.actionAt", + "id": "def-common.ESCaseConnector.name", "type": "string", "tags": [], - "label": "actionAt", + "label": "name", "description": [], "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 41 + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 102 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.actionBy", - "type": "Object", + "id": "def-common.ESCaseConnector.type", + "type": "Enum", "tags": [], - "label": "actionBy", + "label": "type", "description": [], "signature": [ { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ElasticUser", - "text": "ElasticUser" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" } ], "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 42 + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 103 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.caseId", - "type": "string", + "id": "def-common.ESCaseConnector.fields", + "type": "CompoundType", "tags": [], - "label": "caseId", + "label": "fields", "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ESConnectorFields", + "text": "ESConnectorFields" + }, + " | null" + ], "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 43 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseUserActions.commentId", - "type": "CompoundType", - "tags": [], - "label": "commentId", - "description": [], - "signature": [ - "string | null" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 44 + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 104 }, "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FetchCasesProps", + "type": "Interface", + "tags": [], + "label": "FetchCasesProps", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.FetchCasesProps", + "text": "FetchCasesProps" }, + " extends ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ApiProps", + "text": "ApiProps" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 131 + }, + "deprecated": false, + "children": [ { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.newValue", - "type": "CompoundType", + "id": "def-common.FetchCasesProps.queryParams", + "type": "Object", "tags": [], - "label": "newValue", + "label": "queryParams", "description": [], "signature": [ - "string | null" + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.QueryParams", + "text": "QueryParams" + }, + " | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 45 + "lineNumber": 132 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActions.oldValue", + "id": "def-common.FetchCasesProps.filterOptions", "type": "CompoundType", "tags": [], - "label": "oldValue", + "label": "filterOptions", "description": [], "signature": [ - "string | null" + "(", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.FilterOptions", + "text": "FilterOptions" + }, + " & { owner: string[]; }) | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 46 + "lineNumber": 133 }, "deprecated": false } @@ -3645,56 +2773,33 @@ }, { "parentPluginId": "cases", - "id": "def-common.DeleteCase", + "id": "def-common.FieldMappings", "type": "Interface", "tags": [], - "label": "DeleteCase", + "label": "FieldMappings", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 152 + "lineNumber": 159 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.DeleteCase.id", + "id": "def-common.FieldMappings.id", "type": "string", "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 153 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.DeleteCase.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - }, - " | null" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 154 + "lineNumber": 160 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.DeleteCase.title", + "id": "def-common.FieldMappings.title", "type": "string", "tags": [], "label": "title", @@ -3704,7 +2809,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 155 + "lineNumber": 161 }, "deprecated": false } @@ -3713,130 +2818,97 @@ }, { "parentPluginId": "cases", - "id": "def-common.Ecs", + "id": "def-common.FilterOptions", "type": "Interface", "tags": [], - "label": "Ecs", + "label": "FilterOptions", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 225 + "lineNumber": 99 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.Ecs._id", - "type": "string", - "tags": [], - "label": "_id", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 226 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.Ecs._index", + "id": "def-common.FilterOptions.search", "type": "string", "tags": [], - "label": "_index", + "label": "search", "description": [], - "signature": [ - "string | undefined" - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 227 + "lineNumber": 100 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.Ecs.signal", - "type": "Object", + "id": "def-common.FilterOptions.status", + "type": "CompoundType", "tags": [], - "label": "signal", + "label": "status", "description": [], "signature": [ { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.SignalEcs", - "text": "SignalEcs" - }, - " | undefined" + "section": "def-common.CaseStatusWithAllStatus", + "text": "CaseStatusWithAllStatus" + } ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 228 + "lineNumber": 101 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ElasticUser", - "type": "Interface", - "tags": [], - "label": "ElasticUser", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 124 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.ElasticUser.email", - "type": "CompoundType", + "id": "def-common.FilterOptions.tags", + "type": "Array", "tags": [], - "label": "email", + "label": "tags", "description": [], "signature": [ - "string | null | undefined" + "string[]" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 125 + "lineNumber": 102 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ElasticUser.fullName", - "type": "CompoundType", + "id": "def-common.FilterOptions.reporters", + "type": "Array", "tags": [], - "label": "fullName", + "label": "reporters", "description": [], "signature": [ - "string | null | undefined" + "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }[]" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 126 + "lineNumber": 103 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ElasticUser.username", + "id": "def-common.FilterOptions.onlyCollectionType", "type": "CompoundType", "tags": [], - "label": "username", + "label": "onlyCollectionType", "description": [], "signature": [ - "string | null | undefined" + "boolean | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 127 + "lineNumber": 104 }, "deprecated": false } @@ -3845,85 +2917,78 @@ }, { "parentPluginId": "cases", - "id": "def-common.ESCaseConnector", + "id": "def-common.QueryParams", "type": "Interface", "tags": [], - "label": "ESCaseConnector", + "label": "QueryParams", "description": [], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 100 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 92 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.ESCaseConnector.id", - "type": "string", + "id": "def-common.QueryParams.page", + "type": "number", "tags": [], - "label": "id", + "label": "page", "description": [], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 101 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 93 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ESCaseConnector.name", - "type": "string", + "id": "def-common.QueryParams.perPage", + "type": "number", "tags": [], - "label": "name", + "label": "perPage", "description": [], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 102 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 94 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ESCaseConnector.type", + "id": "def-common.QueryParams.sortField", "type": "Enum", "tags": [], - "label": "type", + "label": "sortField", "description": [], "signature": [ { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" + "section": "def-common.SortFieldCase", + "text": "SortFieldCase" } ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 103 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 95 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.ESCaseConnector.fields", + "id": "def-common.QueryParams.sortOrder", "type": "CompoundType", "tags": [], - "label": "fields", + "label": "sortOrder", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ESConnectorFields", - "text": "ESConnectorFields" - }, - " | null" + "\"asc\" | \"desc\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 104 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 96 }, "deprecated": false } @@ -3932,590 +2997,286 @@ }, { "parentPluginId": "cases", - "id": "def-common.FetchCasesProps", + "id": "def-common.RuleEcs", "type": "Interface", "tags": [], - "label": "FetchCasesProps", + "label": "RuleEcs", "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.FetchCasesProps", - "text": "FetchCasesProps" - }, - " extends ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ApiProps", - "text": "ApiProps" - } - ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 130 + "lineNumber": 179 }, "deprecated": false, "children": [ { "parentPluginId": "cases", - "id": "def-common.FetchCasesProps.queryParams", - "type": "Object", + "id": "def-common.RuleEcs.id", + "type": "Array", "tags": [], - "label": "queryParams", + "label": "id", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.QueryParams", - "text": "QueryParams" - }, - " | undefined" + "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 131 + "lineNumber": 180 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.FetchCasesProps.filterOptions", - "type": "Object", + "id": "def-common.RuleEcs.rule_id", + "type": "Array", "tags": [], - "label": "filterOptions", + "label": "rule_id", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.FilterOptions", - "text": "FilterOptions" - }, - " | undefined" + "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 132 + "lineNumber": 181 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.FieldMappings", - "type": "Interface", - "tags": [], - "label": "FieldMappings", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 158 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.FieldMappings.id", - "type": "string", + "id": "def-common.RuleEcs.name", + "type": "Array", "tags": [], - "label": "id", + "label": "name", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 159 + "lineNumber": 182 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.FieldMappings.title", - "type": "string", + "id": "def-common.RuleEcs.false_positives", + "type": "Array", "tags": [], - "label": "title", + "label": "false_positives", "description": [], "signature": [ - "string | undefined" + "string[]" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 160 + "lineNumber": 183 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.FilterOptions", - "type": "Interface", - "tags": [], - "label": "FilterOptions", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 98 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.FilterOptions.search", - "type": "string", + "id": "def-common.RuleEcs.saved_id", + "type": "Array", "tags": [], - "label": "search", + "label": "saved_id", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 99 + "lineNumber": 184 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.FilterOptions.status", - "type": "CompoundType", + "id": "def-common.RuleEcs.timeline_id", + "type": "Array", "tags": [], - "label": "status", + "label": "timeline_id", "description": [], "signature": [ - "\"all\" | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - } + "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 100 + "lineNumber": 185 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.FilterOptions.tags", + "id": "def-common.RuleEcs.timeline_title", "type": "Array", "tags": [], - "label": "tags", + "label": "timeline_title", "description": [], "signature": [ - "string[]" + "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 101 + "lineNumber": 186 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.FilterOptions.reporters", + "id": "def-common.RuleEcs.max_signals", "type": "Array", "tags": [], - "label": "reporters", + "label": "max_signals", "description": [], "signature": [ - "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }[]" + "number[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 102 + "lineNumber": 187 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.FilterOptions.onlyCollectionType", - "type": "CompoundType", + "id": "def-common.RuleEcs.risk_score", + "type": "Array", "tags": [], - "label": "onlyCollectionType", + "label": "risk_score", "description": [], "signature": [ - "boolean | undefined" + "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 103 + "lineNumber": 188 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.QueryParams", - "type": "Interface", - "tags": [], - "label": "QueryParams", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 91 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.QueryParams.page", - "type": "number", + "id": "def-common.RuleEcs.output_index", + "type": "Array", "tags": [], - "label": "page", + "label": "output_index", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 92 + "lineNumber": 189 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.QueryParams.perPage", - "type": "number", + "id": "def-common.RuleEcs.description", + "type": "Array", "tags": [], - "label": "perPage", + "label": "description", "description": [], + "signature": [ + "string[] | undefined" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 93 + "lineNumber": 190 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.QueryParams.sortField", - "type": "Enum", + "id": "def-common.RuleEcs.from", + "type": "Array", "tags": [], - "label": "sortField", + "label": "from", "description": [], "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.SortFieldCase", - "text": "SortFieldCase" - } + "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 94 + "lineNumber": 191 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.QueryParams.sortOrder", - "type": "CompoundType", + "id": "def-common.RuleEcs.immutable", + "type": "Array", "tags": [], - "label": "sortOrder", + "label": "immutable", "description": [], "signature": [ - "\"asc\" | \"desc\"" + "boolean[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 95 + "lineNumber": 192 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs", - "type": "Interface", - "tags": [], - "label": "RuleEcs", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 178 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "cases", - "id": "def-common.RuleEcs.id", + "id": "def-common.RuleEcs.index", "type": "Array", "tags": [], - "label": "id", + "label": "index", "description": [], "signature": [ "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 179 + "lineNumber": 193 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.RuleEcs.rule_id", + "id": "def-common.RuleEcs.interval", "type": "Array", "tags": [], - "label": "rule_id", + "label": "interval", "description": [], "signature": [ "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 180 + "lineNumber": 194 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.RuleEcs.name", + "id": "def-common.RuleEcs.language", "type": "Array", "tags": [], - "label": "name", + "label": "language", "description": [], "signature": [ "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 181 + "lineNumber": 195 }, "deprecated": false }, { "parentPluginId": "cases", - "id": "def-common.RuleEcs.false_positives", + "id": "def-common.RuleEcs.query", "type": "Array", "tags": [], - "label": "false_positives", - "description": [], - "signature": [ - "string[]" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 182 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.saved_id", - "type": "Array", - "tags": [], - "label": "saved_id", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 183 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.timeline_id", - "type": "Array", - "tags": [], - "label": "timeline_id", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 184 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.timeline_title", - "type": "Array", - "tags": [], - "label": "timeline_title", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 185 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.max_signals", - "type": "Array", - "tags": [], - "label": "max_signals", - "description": [], - "signature": [ - "number[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 186 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.risk_score", - "type": "Array", - "tags": [], - "label": "risk_score", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 187 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.output_index", - "type": "Array", - "tags": [], - "label": "output_index", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 188 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.description", - "type": "Array", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 189 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.from", - "type": "Array", - "tags": [], - "label": "from", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 190 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.immutable", - "type": "Array", - "tags": [], - "label": "immutable", - "description": [], - "signature": [ - "boolean[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 191 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.index", - "type": "Array", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 192 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.interval", - "type": "Array", - "tags": [], - "label": "interval", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 193 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.language", - "type": "Array", - "tags": [], - "label": "language", - "description": [], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 194 - }, - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RuleEcs.query", - "type": "Array", - "tags": [], - "label": "query", + "label": "query", "description": [], "signature": [ "string[] | undefined" ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 195 + "lineNumber": 196 }, "deprecated": false }, @@ -4531,7 +3292,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 196 + "lineNumber": 197 }, "deprecated": false }, @@ -4547,7 +3308,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 197 + "lineNumber": 198 }, "deprecated": false }, @@ -4563,7 +3324,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 198 + "lineNumber": 199 }, "deprecated": false }, @@ -4579,7 +3340,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 199 + "lineNumber": 200 }, "deprecated": false }, @@ -4595,7 +3356,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 200 + "lineNumber": 201 }, "deprecated": false }, @@ -4611,7 +3372,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 201 + "lineNumber": 202 }, "deprecated": false }, @@ -4627,7 +3388,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 202 + "lineNumber": 203 }, "deprecated": false }, @@ -4643,7 +3404,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 203 + "lineNumber": 204 }, "deprecated": false }, @@ -4659,7 +3420,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 204 + "lineNumber": 205 }, "deprecated": false }, @@ -4675,7 +3436,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 205 + "lineNumber": 206 }, "deprecated": false }, @@ -4691,7 +3452,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 206 + "lineNumber": 207 }, "deprecated": false }, @@ -4707,7 +3468,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 207 + "lineNumber": 208 }, "deprecated": false }, @@ -4723,7 +3484,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 208 + "lineNumber": 209 }, "deprecated": false }, @@ -4739,7 +3500,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 209 + "lineNumber": 210 }, "deprecated": false }, @@ -4755,7 +3516,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 210 + "lineNumber": 211 }, "deprecated": false }, @@ -4771,7 +3532,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 211 + "lineNumber": 212 }, "deprecated": false }, @@ -4787,7 +3548,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 212 + "lineNumber": 213 }, "deprecated": false } @@ -4803,7 +3564,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 215 + "lineNumber": 216 }, "deprecated": false, "children": [ @@ -4826,7 +3587,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 216 + "lineNumber": 217 }, "deprecated": false }, @@ -4842,7 +3603,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 217 + "lineNumber": 218 }, "deprecated": false }, @@ -4858,7 +3619,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 218 + "lineNumber": 219 }, "deprecated": false }, @@ -4874,7 +3635,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 219 + "lineNumber": 220 }, "deprecated": false }, @@ -4890,7 +3651,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 222 + "lineNumber": 223 }, "deprecated": false } @@ -4916,7 +3677,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 75 + "lineNumber": 76 }, "deprecated": false, "children": [ @@ -4938,7 +3699,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 76 + "lineNumber": 77 }, "deprecated": false }, @@ -4951,7 +3712,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 77 + "lineNumber": 78 }, "deprecated": false } @@ -4967,7 +3728,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 168 + "lineNumber": 169 }, "deprecated": false, "children": [ @@ -4983,7 +3744,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 169 + "lineNumber": 170 }, "deprecated": false }, @@ -5034,12 +3795,11 @@ "docId": "kibCasesPluginApi", "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" - }, - ".none; fields: null; }) | { syncAlerts: boolean; } | undefined" + } ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 170 + "lineNumber": 171 }, "deprecated": false }, @@ -5055,7 +3815,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 171 + "lineNumber": 172 }, "deprecated": false }, @@ -5079,7 +3839,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 172 + "lineNumber": 173 }, "deprecated": false }, @@ -5101,7 +3861,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 173 + "lineNumber": 174 }, "deprecated": false }, @@ -5117,7 +3877,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 174 + "lineNumber": 175 }, "deprecated": false }, @@ -5133,7 +3893,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 175 + "lineNumber": 176 }, "deprecated": false } @@ -5153,7 +3913,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 33 + "lineNumber": 34 }, "deprecated": false, "initialIsOpen": false @@ -5195,7 +3955,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 51 + "lineNumber": 53 }, "deprecated": false, "initialIsOpen": false @@ -5223,7 +3983,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 119 + "lineNumber": 120 }, "deprecated": false, "initialIsOpen": false @@ -5242,7 +4002,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 41 + "lineNumber": 60 }, "deprecated": false, "initialIsOpen": false @@ -5261,7 +4021,7 @@ ], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 40 + "lineNumber": 59 }, "deprecated": false, "initialIsOpen": false @@ -5274,13 +4034,7 @@ "label": "ActionConnector", "description": [], "signature": [ - { - "pluginId": "actions", - "scope": "common", - "docId": "kibActionsPluginApi", - "section": "def-common.ActionResult", - "text": "ActionResult" - } + "ActionResult" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -5314,13 +4068,7 @@ "label": "ActionTypeConnector", "description": [], "signature": [ - { - "pluginId": "actions", - "scope": "common", - "docId": "kibActionsPluginApi", - "section": "def-common.ActionType", - "text": "ActionType" - } + "ActionType" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", @@ -5337,51 +4085,45 @@ "label": "AllCommentsResponse", "description": [], "signature": [ - "(({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } & { 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; }; 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; }; } & { 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; }; 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: 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; }))[]" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 135 + "lineNumber": 149 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllReportersFindRequest", + "type": "Type", + "tags": [], + "label": "AllReportersFindRequest", + "description": [], + "signature": [ + "{ owner?: string | string[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 313 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllTagsFindRequest", + "type": "Type", + "tags": [], + "label": "AllTagsFindRequest", + "description": [], + "signature": [ + "{ owner?: string | string[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 312 }, "deprecated": false, "initialIsOpen": false @@ -5411,35 +4153,28 @@ "label": "AttributesTypeAlerts", "description": [], "signature": [ - "{ 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; }; } & { 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; }; 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: 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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 143 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AttributesTypeUser", + "type": "Type", + "tags": [], + "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; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 130 + "lineNumber": 144 }, "deprecated": false, "initialIsOpen": false @@ -5453,7 +4188,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 34 + "lineNumber": 53 }, "deprecated": false, "initialIsOpen": false @@ -5467,7 +4202,24 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 27 + "lineNumber": 46 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_COMMENT_SAVED_OBJECT", + "type": "string", + "tags": [], + "label": "CASE_COMMENT_SAVED_OBJECT", + "description": [], + "signature": [ + "\"cases-comments\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 16 }, "deprecated": false, "initialIsOpen": false @@ -5481,7 +4233,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 26 + "lineNumber": 45 }, "deprecated": false, "initialIsOpen": false @@ -5495,32 +4247,35 @@ "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 19 + "lineNumber": 38 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CASE_CONFIGURE_URL", + "id": "def-common.CASE_CONFIGURE_DETAILS_URL", "type": "string", "tags": [], - "label": "CASE_CONFIGURE_URL", + "label": "CASE_CONFIGURE_DETAILS_URL", "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 18 + "lineNumber": 37 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CASE_DETAILS_URL", + "id": "def-common.CASE_CONFIGURE_SAVED_OBJECT", "type": "string", "tags": [], - "label": "CASE_DETAILS_URL", + "label": "CASE_CONFIGURE_SAVED_OBJECT", "description": [], + "signature": [ + "\"cases-configure\"" + ], "source": { "path": "x-pack/plugins/cases/common/constants.ts", "lineNumber": 17 @@ -5530,10032 +4285,162 @@ }, { "parentPluginId": "cases", - "id": "def-common.CASE_PUSH_URL", + "id": "def-common.CASE_CONFIGURE_URL", "type": "string", "tags": [], - "label": "CASE_PUSH_URL", + "label": "CASE_CONFIGURE_URL", "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 28 + "lineNumber": 36 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CASE_REPORTERS_URL", + "id": "def-common.CASE_CONNECTOR_MAPPINGS_SAVED_OBJECT", "type": "string", "tags": [], - "label": "CASE_REPORTERS_URL", + "label": "CASE_CONNECTOR_MAPPINGS_SAVED_OBJECT", "description": [], + "signature": [ + "\"cases-connector-mappings\"" + ], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 29 + "lineNumber": 13 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CASE_STATUS_URL", + "id": "def-common.CASE_DETAILS_URL", "type": "string", "tags": [], - "label": "CASE_STATUS_URL", + "label": "CASE_DETAILS_URL", "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 30 + "lineNumber": 35 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CASE_TAGS_URL", + "id": "def-common.CASE_PUSH_URL", "type": "string", "tags": [], - "label": "CASE_TAGS_URL", + "label": "CASE_PUSH_URL", "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 31 + "lineNumber": 47 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CASE_USER_ACTIONS_URL", + "id": "def-common.CASE_REPORTERS_URL", "type": "string", "tags": [], - "label": "CASE_USER_ACTIONS_URL", + "label": "CASE_REPORTERS_URL", "description": [], "source": { "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 32 + "lineNumber": 48 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseAttributes", - "type": "Type", + "id": "def-common.CASE_SAVED_OBJECT", + "type": "string", "tags": [], - "label": "CaseAttributes", + "label": "CASE_SAVED_OBJECT", "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; }; } & { 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; }" + "\"cases\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 175 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 12 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseConnector", - "type": "Type", + "id": "def-common.CASE_STATUS_URL", + "type": "string", "tags": [], - "label": "CaseConnector", + "label": "CASE_STATUS_URL", "description": [], - "signature": [ - "({ 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; })" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 82 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseField", - "type": "Type", - "tags": [], - "label": "CaseField", - "description": [], - "signature": [ - "\"description\" | \"title\" | \"comments\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 23 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseFullExternalService", - "type": "Type", - "tags": [], - "label": "CaseFullExternalService", - "description": [], - "signature": [ - "({ 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", - "lineNumber": 189 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 49 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CasePatchRequest", - "type": "Type", + "id": "def-common.CASE_TAGS_URL", + "type": "string", "tags": [], - "label": "CasePatchRequest", + "label": "CASE_TAGS_URL", "description": [], - "signature": [ - "{ description?: string | undefined; status?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - " | 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", - "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; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; }" - ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 187 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 50 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CasePostRequest", - "type": "Type", + "id": "def-common.CASE_USER_ACTION_SAVED_OBJECT", + "type": "string", "tags": [], - "label": "CasePostRequest", + "label": "CASE_USER_ACTION_SAVED_OBJECT", "description": [], "signature": [ - "{ 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", - "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; }; }" + "\"cases-user-actions\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 182 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 15 }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseResponse", - "type": "Type", - "tags": [], - "label": "CaseResponse", - "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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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": 183 - }, - "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": 16 - }, - "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; }; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 181 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigure", - "type": "Type", - "tags": [], - "label": "CasesConfigure", - "description": [], - "signature": [ - "{ 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; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 47 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigureAttributes", - "type": "Type", - "tags": [], - "label": "CasesConfigureAttributes", - "description": [], - "signature": [ - "{ 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; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { 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", - "lineNumber": 50 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigurePatch", - "type": "Type", - "tags": [], - "label": "CasesConfigurePatch", - "description": [], - "signature": [ - "{ 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; }) | undefined; closure_type?: \"close-by-user\" | \"close-by-pushing\" | undefined; } & { version: string; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 49 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigureRequest", - "type": "Type", - "tags": [], - "label": "CasesConfigureRequest", - "description": [], - "signature": [ - "{ 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; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 48 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigureResponse", - "type": "Type", - "tags": [], - "label": "CasesConfigureResponse", - "description": [], - "signature": [ - "{ 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; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { 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; }[]; } & { version: string; error: string | null; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 51 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseSettings", - "type": "Type", - "tags": [], - "label": "CaseSettings", - "description": [], - "signature": [ - "{ syncAlerts: boolean; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 190 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesFindRequest", - "type": "Type", - "tags": [], - "label": "CasesFindRequest", - "description": [], - "signature": [ - "{ type?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - }, - " | undefined; tags?: string | string[] | undefined; status?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - " | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 185 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesFindResponse", - "type": "Type", - "tags": [], - "label": "CasesFindResponse", - "description": [], - "signature": [ - "{ cases: ({ 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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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": 186 - }, - "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?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseType", - "text": "CaseType" - }, - " | undefined; 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; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; })[]; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 188 - }, - "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; }; } & { 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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; } & { 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; }; 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; }; } & { 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; }; 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": 184 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesStatusResponse", - "type": "Type", - "tags": [], - "label": "CasesStatusResponse", - "description": [], - "signature": [ - "{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 30 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.caseStatuses", - "type": "Array", - "tags": [], - "label": "caseStatuses", - "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - "[]" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 22 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseStatusWithAllStatus", - "type": "Type", - "tags": [], - "label": "CaseStatusWithAllStatus", - "description": [], - "signature": [ - "\"all\" | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 24 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.caseTypeField", - "type": "string", - "tags": [], - "label": "caseTypeField", - "description": [ - "\nExposing the field used to define the case type so that it can be used for filtering in saved object find queries." - ], - "signature": [ - "\"type\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 25 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseUserActionAttributes", - "type": "Type", - "tags": [], - "label": "CaseUserActionAttributes", - "description": [], - "signature": [ - "{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 59 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CaseUserActionsResponse", - "type": "Type", - "tags": [], - "label": "CaseUserActionsResponse", - "description": [], - "signature": [ - "({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 60 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ClosureType", - "type": "Type", - "tags": [], - "label": "ClosureType", - "description": [], - "signature": [ - "\"close-by-user\" | \"close-by-pushing\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 46 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.Comment", - "type": "Type", - "tags": [], - "label": "Comment", - "description": [], - "signature": [ - "({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } & { 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; }) | ({ 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; }; } & { 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", - "lineNumber": 26 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentAttributes", - "type": "Type", - "tags": [], - "label": "CommentAttributes", - "description": [], - "signature": [ - "({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } & { 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; }; 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; }; } & { 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; }; 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", - "lineNumber": 131 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentPatchAttributes", - "type": "Type", - "tags": [], - "label": "CommentPatchAttributes", - "description": [], - "signature": [ - "{ associationType?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "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; 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", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".alert | ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".generatedAlert | undefined; alertId?: string | string[] | undefined; index?: string | string[] | undefined; rule?: { id: string | null; name: string | null; } | undefined; } & { associationType?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "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; 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", - "lineNumber": 138 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentPatchRequest", - "type": "Type", - "tags": [], - "label": "CommentPatchRequest", - "description": [], - "signature": [ - "({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } & { 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; }; } & { id: string; version: string; })" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 137 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentRequest", - "type": "Type", - "tags": [], - "label": "CommentRequest", - "description": [], - "signature": [ - "{ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } | { 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; }; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 132 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentRequestAlertType", - "type": "Type", - "tags": [], - "label": "CommentRequestAlertType", - "description": [], - "signature": [ - "{ 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; }; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 140 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentRequestUserType", - "type": "Type", - "tags": [], - "label": "CommentRequestUserType", - "description": [], - "signature": [ - "{ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 139 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentResponse", - "type": "Type", - "tags": [], - "label": "CommentResponse", - "description": [], - "signature": [ - "({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } & { 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; }; 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; }; } & { 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; }; 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", - "lineNumber": 133 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentResponseAlertsType", - "type": "Type", - "tags": [], - "label": "CommentResponseAlertsType", - "description": [], - "signature": [ - "{ 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; }; } & { 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; }; 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", - "lineNumber": 134 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CommentsResponse", - "type": "Type", - "tags": [], - "label": "CommentsResponse", - "description": [], - "signature": [ - "{ comments: (({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; } & { 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; }; 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; }; } & { 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; }; 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", - "lineNumber": 136 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorField", - "type": "Type", - "tags": [], - "label": "ConnectorField", - "description": [], - "signature": [ - "{ id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 48 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorFields", - "type": "Type", - "tags": [], - "label": "ConnectorFields", - "description": [], - "signature": [ - "{ 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", - "lineNumber": 92 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorJiraTypeFields", - "type": "Type", - "tags": [], - "label": "ConnectorJiraTypeFields", - "description": [], - "signature": [ - "{ 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", - "lineNumber": 84 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorMappings", - "type": "Type", - "tags": [], - "label": "ConnectorMappings", - "description": [], - "signature": [ - "{ mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 37 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorMappingsAttributes", - "type": "Type", - "tags": [], - "label": "ConnectorMappingsAttributes", - "description": [], - "signature": [ - "{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 36 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorResillientTypeFields", - "type": "Type", - "tags": [], - "label": "ConnectorResillientTypeFields", - "description": [], - "signature": [ - "{ 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", - "lineNumber": 85 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorServiceNowITSMTypeFields", - "type": "Type", - "tags": [], - "label": "ConnectorServiceNowITSMTypeFields", - "description": [], - "signature": [ - "{ 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", - "lineNumber": 86 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorServiceNowSIRTypeFields", - "type": "Type", - "tags": [], - "label": "ConnectorServiceNowSIRTypeFields", - "description": [], - "signature": [ - "{ 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", - "lineNumber": 89 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ConnectorTypeFields", - "type": "Type", - "tags": [], - "label": "ConnectorTypeFields", - "description": [], - "signature": [ - "{ 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; } | { type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - }, - ".resilient; fields: { incidentTypes: string[] | null; severityCode: 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; } | { 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; } | { 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", - "lineNumber": 83 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.DEFAULT_DATE_FORMAT", - "type": "string", - "tags": [], - "label": "DEFAULT_DATE_FORMAT", - "description": [], - "signature": [ - "\"dateFormat\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 7 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.DEFAULT_DATE_FORMAT_TZ", - "type": "string", - "tags": [], - "label": "DEFAULT_DATE_FORMAT_TZ", - "description": [], - "signature": [ - "\"dateFormat:tz\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 8 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ENABLE_CASE_CONNECTOR", - "type": "boolean", - "tags": [], - "label": "ENABLE_CASE_CONNECTOR", - "description": [ - "\nThis flag governs enabling the case as a connector feature. It is disabled by default as the feature is not complete." - ], - "signature": [ - "false" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 63 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ESCaseAttributes", - "type": "Type", - "tags": [], - "label": "ESCaseAttributes", - "description": [], - "signature": [ - "Pick<{ 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; }; } & { 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\" | \"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", - "lineNumber": 193 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ESCaseConnectorTypes", - "type": "Type", - "tags": [], - "label": "ESCaseConnectorTypes", - "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.ConnectorTypes", - "text": "ConnectorTypes" - } - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 99 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ESCasePatchRequest", - "type": "Type", - "tags": [], - "label": "ESCasePatchRequest", - "description": [], - "signature": [ - "Pick<{ description?: string | undefined; status?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - " | 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", - "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; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; }, \"type\" | \"status\" | \"description\" | \"title\" | \"id\" | \"version\" | \"tags\" | \"settings\"> & { 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", - "lineNumber": 194 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ESCasesConfigureAttributes", - "type": "Type", - "tags": [], - "label": "ESCasesConfigureAttributes", - "description": [], - "signature": [ - "Pick<{ 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; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { 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\" | \"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": 53 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ESConnectorFields", - "type": "Type", - "tags": [], - "label": "ESConnectorFields", - "description": [], - "signature": [ - "{ key: string; value: unknown; }[]" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 94 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ExternalServiceResponse", - "type": "Type", - "tags": [], - "label": "ExternalServiceResponse", - "description": [], - "signature": [ - "{ title: string; id: string; pushedDate: string; url: string; } & { comments?: ({ commentId: string; pushedDate: string; } & { externalCommentId?: string | undefined; })[] | undefined; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 191 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.GetCaseIdsByAlertIdAggs", - "type": "Type", - "tags": [], - "label": "GetCaseIdsByAlertIdAggs", - "description": [], - "signature": [ - "{ references: { doc_count: number; caseIds: { buckets: { key: string; }[]; }; }; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 141 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.GetFieldsResponse", - "type": "Type", - "tags": [], - "label": "GetFieldsResponse", - "description": [], - "signature": [ - "{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 55 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.JIRA_ACTION_TYPE_ID", - "type": "string", - "tags": [], - "label": "JIRA_ACTION_TYPE_ID", - "description": [], - "signature": [ - "\".jira\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 44 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.JiraFieldsType", - "type": "Type", - "tags": [], - "label": "JiraFieldsType", - "description": [], - "signature": [ - "{ issueType: string | null; priority: string | null; parent: string | null; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", - "lineNumber": 17 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.MAX_ALERTS_PER_SUB_CASE", - "type": "number", - "tags": [], - "label": "MAX_ALERTS_PER_SUB_CASE", - "description": [ - "\nAlerts" - ], - "signature": [ - "5000" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 57 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.MAX_GENERATED_ALERTS_PER_SUB_CASE", - "type": "number", - "tags": [], - "label": "MAX_GENERATED_ALERTS_PER_SUB_CASE", - "description": [], - "signature": [ - "50" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 58 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.RESILIENT_ACTION_TYPE_ID", - "type": "string", - "tags": [], - "label": "RESILIENT_ACTION_TYPE_ID", - "description": [], - "signature": [ - "\".resilient\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 45 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ResilientFieldsType", - "type": "Type", - "tags": [], - "label": "ResilientFieldsType", - "description": [], - "signature": [ - "{ incidentTypes: string[] | null; severityCode: string | null; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", - "lineNumber": 16 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SavedObjectFindOptions", - "type": "Type", - "tags": [], - "label": "SavedObjectFindOptions", - "description": [], - "signature": [ - "{ defaultSearchOperator?: \"AND\" | \"OR\" | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; hasReference?: { id: string; type: string; } | { id: string; type: string; }[] | undefined; fields?: string[] | undefined; filter?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 39 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SERVICENOW_ITSM_ACTION_TYPE_ID", - "type": "string", - "tags": [], - "label": "SERVICENOW_ITSM_ACTION_TYPE_ID", - "description": [], - "signature": [ - "\".servicenow\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 42 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SERVICENOW_SIR_ACTION_TYPE_ID", - "type": "string", - "tags": [], - "label": "SERVICENOW_SIR_ACTION_TYPE_ID", - "description": [], - "signature": [ - "\".servicenow-sir\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 43 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ServiceNowITSMFieldsType", - "type": "Type", - "tags": [], - "label": "ServiceNowITSMFieldsType", - "description": [], - "signature": [ - "{ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", - "lineNumber": 19 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ServiceNowSIRFieldsType", - "type": "Type", - "tags": [], - "label": "ServiceNowSIRFieldsType", - "description": [], - "signature": [ - "{ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", - "lineNumber": 21 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.StatusAll", - "type": "string", - "tags": [], - "label": "StatusAll", - "description": [], - "signature": [ - "\"all\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 21 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.StatusAllType", - "type": "Type", - "tags": [], - "label": "StatusAllType", - "description": [], - "signature": [ - "\"all\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 22 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SUB_CASE_DETAILS_URL", - "type": "string", - "tags": [], - "label": "SUB_CASE_DETAILS_URL", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 23 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SUB_CASE_USER_ACTIONS_URL", - "type": "string", - "tags": [], - "label": "SUB_CASE_USER_ACTIONS_URL", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 24 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SUB_CASES_PATCH_DEL_URL", - "type": "string", - "tags": [], - "label": "SUB_CASES_PATCH_DEL_URL", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 21 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SUB_CASES_URL", - "type": "string", - "tags": [], - "label": "SUB_CASES_URL", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 22 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCaseAttributes", - "type": "Type", - "tags": [], - "label": "SubCaseAttributes", - "description": [], - "signature": [ - "{ 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; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 75 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasePatchRequest", - "type": "Type", - "tags": [], - "label": "SubCasePatchRequest", - "description": [], - "signature": [ - "{ status?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - " | undefined; } & { id: string; version: string; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 79 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCaseResponse", - "type": "Type", - "tags": [], - "label": "SubCaseResponse", - "description": [], - "signature": [ - "{ 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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", - "lineNumber": 76 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesFindResponse", - "type": "Type", - "tags": [], - "label": "SubCasesFindResponse", - "description": [], - "signature": [ - "{ 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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", - "lineNumber": 78 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesPatchRequest", - "type": "Type", - "tags": [], - "label": "SubCasesPatchRequest", - "description": [], - "signature": [ - "{ subCases: ({ status?: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - " | undefined; } & { id: string; version: string; })[]; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 80 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SubCasesResponse", - "type": "Type", - "tags": [], - "label": "SubCasesResponse", - "description": [], - "signature": [ - "({ 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; } & { 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; } & { 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; }; 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; }; } & { 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; }; 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", - "lineNumber": 77 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.SUPPORTED_CONNECTORS", - "type": "Array", - "tags": [], - "label": "SUPPORTED_CONNECTORS", - "description": [], - "signature": [ - "string[]" - ], - "source": { - "path": "x-pack/plugins/cases/common/constants.ts", - "lineNumber": 47 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.ThirdPartyField", - "type": "Type", - "tags": [], - "label": "ThirdPartyField", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 24 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.UpdateKey", - "type": "Type", - "tags": [], - "label": "UpdateKey", - "description": [], - "signature": [ - "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 163 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.User", - "type": "Type", - "tags": [], - "label": "User", - "description": [], - "signature": [ - "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/user.ts", - "lineNumber": 18 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.UserAction", - "type": "Type", - "tags": [], - "label": "UserAction", - "description": [], - "signature": [ - "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 62 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.UserActionField", - "type": "Type", - "tags": [], - "label": "UserActionField", - "description": [], - "signature": [ - "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 63 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.UserActionFieldType", - "type": "Type", - "tags": [], - "label": "UserActionFieldType", - "description": [], - "signature": [ - "\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\"" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 64 - }, - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [ - { - "parentPluginId": "cases", - "id": "def-common.AlertCommentRequestRt", - "type": "Object", - "tags": [], - "label": "AlertCommentRequestRt", - "description": [ - "\nThis defines the structure of how alerts (generated or user attached) are stored in saved objects documents. It also\nrepresents of an alert after it has been transformed. A generated alert will be transformed by the connector so that\nit matches this structure. User attached alerts do not need to be transformed." - ], - "signature": [ - "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", - "]>; }>; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 67 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.AllCommentsResponseRt", - "type": "Object", - "tags": [], - "label": "AllCommentsResponseRt", - "description": [], - "signature": [ - "ArrayC", - "<", - "IntersectionC", - "<[", - "UnionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user>; }>, ", - "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", - "]>; }>; 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", - "]>; }>; }>, ", - "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", - "]>; }>; 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": 128 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.AllCommentsResponseRT", - "type": "Object", - "tags": [], - "label": "AllCommentsResponseRT", - "description": [], - "signature": [ - "ArrayC", - "<", - "IntersectionC", - "<[", - "UnionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user>; }>, ", - "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", - "]>; }>; 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", - "]>; }>; }>, ", - "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", - "]>; }>; 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": 99 - }, - "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", - "; }>; }>, ", - "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": 62 - }, - "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\">]>; }>, ", - "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": 27 - }, - "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\">]>; }>, ", - "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\">]>; }>>; }>, ", - "TypeC", - "<{ version: ", - "StringC", - "; error: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>]>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 37 - }, - "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", - "; }>; }>, ", - "TypeC", - "<{ id: ", - "StringC", - "; version: ", - "StringC", - "; }>]>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 142 - }, - "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", - "; }>; }>]>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 97 - }, - "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": 150 - }, - "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", - "; }>; }>, ", - "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", - "]>; }>]>, ", - "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>; }>, ", - "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", - "]>; }>; 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", - "]>; }>; }>, ", - "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", - "]>; }>; 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>; }>, ", - "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", - "]>; }>; 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", - "]>; }>; }>, ", - "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", - "]>; }>; 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": 117 - }, - "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", - "; }>; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 86 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "cases", - "id": "def-common.CasesConfigurePatchRt", - "type": "Object", - "tags": [], - "label": "CasesConfigurePatchRt", - "description": [], - "signature": [ - "IntersectionC", - "<[", - "PartialC", - "<{ 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\">]>; }>, ", - "TypeC", - "<{ version: ", - "StringC", - "; }>]>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 22 - }, - "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\">]>; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 21 - }, - "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: ", - "ArrayC", - "<", - "StringC", - ">; sortField: ", - "StringC", - "; sortOrder: ", - "UnionC", - "<[", - "LiteralC", - "<\"desc\">, ", - "LiteralC", - "<\"asc\">]>; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 102 - }, - "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", - "; }>; }>, ", - "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", - "]>; }>]>, ", - "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>; }>, ", - "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", - "]>; }>; 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", - "]>; }>; }>, ", - "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", - "]>; }>; 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>; }>, ", - "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", - "]>; }>; 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", - "]>; }>; }>, ", - "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", - "]>; }>; 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": 132 - }, - "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", - "; }>; }>, ", - "TypeC", - "<{ id: ", - "StringC", - "; version: ", - "StringC", - "; }>]>>; }>" - ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 147 - }, - "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", - "; }>; }>, ", - "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", - "<", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CASE_USER_ACTIONS_URL", + "type": "string", + "tags": [], + "label": "CASE_USER_ACTIONS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 51 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseAttributes", + "type": "Type", + "tags": [], + "label": "CaseAttributes", + "description": [], + "signature": [ + "{ description: string; status: ", { "pluginId": "cases", "scope": "common", @@ -15563,1647 +4448,1139 @@ "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", - "]>; }>]>, ", - "TypeC", - "<{ id: ", - "StringC", - "; totalComment: ", - "NumberC", - "; totalAlerts: ", - "NumberC", - "; version: ", - "StringC", - "; }>, ", - "PartialC", - "<{ comments: ", - "ArrayC", - "<", - "IntersectionC", - "<[", - "UnionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".case>, ", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "<", + ".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.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 288 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseConnector", + "type": "Type", + "tags": [], + "label": "CaseConnector", + "description": [], + "signature": [ + "{ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".generatedAlert>, ", - "LiteralC", - "<", + ".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.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".alert>]>; alertId: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; rule: ", - "TypeC", - "<{ id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } | { id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".case>, ", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "<", + ".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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 82 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseField", + "type": "Type", + "tags": [], + "label": "CaseField", + "description": [], + "signature": [ + "\"description\" | \"title\" | \"comments\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 23 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseFullExternalService", + "type": "Type", + "tags": [], + "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; }; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 303 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePatchRequest", + "type": "Type", + "tags": [], + "label": "CasePatchRequest", + "description": [], + "signature": [ + "{ 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: ", + { + "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.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 301 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasePostRequest", + "type": "Type", + "tags": [], + "label": "CasePostRequest", + "description": [], + "signature": [ + "{ type?: CaseType | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".case>, ", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "<", + ".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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 295 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseResponse", + "type": "Type", + "tags": [], + "label": "CaseResponse", + "description": [], + "signature": [ + "{ description: string; 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: ", + { + "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" + } + ], + "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: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".generatedAlert>, ", - "LiteralC", - "<", + ".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.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".alert>]>; alertId: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; rule: ", - "TypeC", - "<{ id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".case>, ", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "; }>]>>; }>]>>" + ".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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 294 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigurationsResponse", + "type": "Type", + "tags": [], + "label": "CasesConfigurationsResponse", + "description": [], + "signature": [ + "({ 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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 84 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigure", + "type": "Type", + "tags": [], + "label": "CasesConfigure", + "description": [], + "signature": [ + "{ 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" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 148 + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 79 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CasesStatusResponseRt", - "type": "Object", + "id": "def-common.CasesConfigureAttributes", + "type": "Type", "tags": [], - "label": "CasesStatusResponseRt", + "label": "CasesConfigureAttributes", "description": [], "signature": [ - "TypeC", - "<{ count_open_cases: ", - "NumberC", - "; count_in_progress_cases: ", - "NumberC", - "; count_closed_cases: ", - "NumberC", - "; }>" + "{ 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" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 24 + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 82 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseStatusRt", - "type": "Object", + "id": "def-common.CasesConfigurePatch", + "type": "Type", "tags": [], - "label": "CaseStatusRt", + "label": "CasesConfigurePatch", "description": [], "signature": [ - "UnionC", - "<[", - "LiteralC", - "<", + "{ connector?: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".open>, ", - "LiteralC", - ", ", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" + "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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 81 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesConfigureRequest", + "type": "Type", + "tags": [], + "label": "CasesConfigureRequest", + "description": [], + "signature": [ + "{ 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" }, - ".closed>]>" + ".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" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 16 + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 80 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActionAttributesRt", - "type": "Object", + "id": "def-common.CasesConfigureResponse", + "type": "Type", "tags": [], - "label": "CaseUserActionAttributesRt", + "label": "CasesConfigureResponse", "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\">]>>; 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", - "]>; }>" + "{ 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" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 55 + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 83 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CaseUserActionsResponseRt", - "type": "Object", + "id": "def-common.CaseSettings", + "type": "Type", "tags": [], - "label": "CaseUserActionsResponseRt", + "label": "CaseSettings", "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\">]>>; 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", - "]>; }>, ", - "TypeC", - "<{ action_id: ", - "StringC", - "; case_id: ", - "StringC", - "; comment_id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>, ", - "PartialC", - "<{ sub_case_id: ", - "StringC", - "; }>]>>" + "{ syncAlerts: boolean; }" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 57 + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 304 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentAttributesBasicRt", - "type": "Object", + "id": "def-common.CasesFindRequest", + "type": "Type", "tags": [], - "label": "CommentAttributesBasicRt", + "label": "CasesFindRequest", "description": [], "signature": [ - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + "{ type?: CaseType | undefined; tags?: string | string[] | undefined; status?: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".case>, ", - "LiteralC", - "<", + " | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; owner?: string | string[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 298 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesFindResponse", + "type": "Type", + "tags": [], + "label": "CasesFindResponse", + "description": [], + "signature": [ + "{ cases: ({ description: string; status: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "]>; }>" + "; tags: string[]; title: string; type: 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" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 38 + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 300 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentPatchAttributesRt", - "type": "Object", + "id": "def-common.CasesPatchRequest", + "type": "Type", "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." - ], + "label": "CasesPatchRequest", + "description": [], "signature": [ - "IntersectionC", - "<[", - "UnionC", - "<[", - "PartialC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + "{ cases: ({ description?: string | undefined; status?: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".case>, ", - "LiteralC", - "<", + " | undefined; tags?: string[] | undefined; title?: string | undefined; type?: CaseType | undefined; connector?: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "<", + ".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.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".generatedAlert>, ", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".alert>]>; alertId: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; rule: ", - "TypeC", - "<{ id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>]>, ", - "PartialC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "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: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".case>, ", - "LiteralC", - "<", + "; tags: string[]; title: string; type: 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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 297 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatusRequest", + "type": "Type", + "tags": [], + "label": "CasesStatusRequest", + "description": [], + "signature": [ + "{ owner?: string | string[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 39 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CasesStatusResponse", + "type": "Type", + "tags": [], + "label": "CasesStatusResponse", + "description": [], + "signature": [ + "{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 38 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.caseStatuses", + "type": "Array", + "tags": [], + "label": "caseStatuses", + "description": [], + "signature": [ { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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": 116 + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 22 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentPatchRequestRt", - "type": "Object", + "id": "def-common.CaseStatusWithAllStatus", + "type": "Type", "tags": [], - "label": "CommentPatchRequestRt", + "label": "CaseStatusWithAllStatus", "description": [], "signature": [ - "IntersectionC", - "<[", - "UnionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", + "\"all\" | ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".user>; }>, ", - "TypeC", - "<{ type: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".open | typeof ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".generatedAlert>, ", - "LiteralC", - "<", + "[\"in-progress\"] | ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".alert>]>; alertId: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; rule: ", - "TypeC", - "<{ id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>]>, ", - "TypeC", - "<{ id: ", - "StringC", - "; version: ", - "StringC", - "; }>]>" + ".closed" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.caseTypeField", + "type": "string", + "tags": [], + "label": "caseTypeField", + "description": [ + "\nExposing the field used to define the case type so that it can be used for filtering in saved object find queries." + ], + "signature": [ + "\"type\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionAttributes", + "type": "Type", + "tags": [], + "label": "CaseUserActionAttributes", + "description": [], + "signature": [ + "{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 62 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CaseUserActionResponse", + "type": "Type", + "tags": [], + "label": "CaseUserActionResponse", + "description": [], + "signature": [ + "{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; }" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 101 + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 64 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentRequestRt", - "type": "Object", + "id": "def-common.CaseUserActionsResponse", + "type": "Type", "tags": [], - "label": "CommentRequestRt", + "label": "CaseUserActionsResponse", "description": [], "signature": [ - "UnionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", + "({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; owner: string; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 63 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ClosureType", + "type": "Type", + "tags": [], + "label": "ClosureType", + "description": [], + "signature": [ + "\"close-by-user\" | \"close-by-pushing\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 78 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.Comment", + "type": "Type", + "tags": [], + "label": "Comment", + "description": [], + "signature": [ + "{ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -17211,89 +5588,55 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".user>; }>, ", - "TypeC", - "<{ type: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".user; owner: string; } & { associationType: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.AssociationType", + "text": "AssociationType" }, - ".generatedAlert>, ", - "LiteralC", - "<", + "; 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; } | { type: ", { "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", - "]>; }>; }>]>" + } ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 81 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 26 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentResponseRt", - "type": "Object", + "id": "def-common.CommentAttributes", + "type": "Type", "tags": [], - "label": "CommentResponseRt", + "label": "CommentAttributes", "description": [], "signature": [ - "IntersectionC", - "<[", - "UnionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", + "{ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -17301,13 +5644,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".user; owner: string; } & { associationType: ", { "pluginId": "cases", "scope": "common", @@ -17315,125 +5652,55 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - ".case>, ", - "LiteralC", - "<", + "; 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" - }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "<", + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 145 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchAttributes", + "type": "Type", + "tags": [], + "label": "CommentPatchAttributes", + "description": [], + "signature": [ + "{ associationType?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "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?: ", { "pluginId": "cases", "scope": "common", @@ -17441,9 +5708,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".generatedAlert>, ", - "LiteralC", - "<", + ".alert | ", { "pluginId": "cases", "scope": "common", @@ -17451,43 +5716,7 @@ "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", - "]>; }>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".generatedAlert | undefined; alertId?: string | string[] | undefined; index?: string | string[] | undefined; rule?: { id: string | null; name: string | null; } | undefined; owner?: string | undefined; } & { associationType?: ", { "pluginId": "cases", "scope": "common", @@ -17495,149 +5724,140 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - ".case>, ", - "LiteralC", - "<", + " | 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", + "lineNumber": 152 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentPatchRequest", + "type": "Type", + "tags": [], + "label": "CommentPatchRequest", + "description": [], + "signature": [ + "{ comment: string; type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CommentType", + "text": "CommentType" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "; }>]>" + ".user; owner: string; } & { 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; } & { id: string; version: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 83 + "lineNumber": 151 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentResponseTypeAlertsRt", - "type": "Object", + "id": "def-common.CommentRequest", + "type": "Type", + "tags": [], + "label": "CommentRequest", + "description": [], + "signature": [ + "{ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; 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", + "lineNumber": 146 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequestAlertType", + "type": "Type", + "tags": [], + "label": "CommentRequestAlertType", + "description": [], + "signature": [ + "{ type: CommentType.alert | 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", + "lineNumber": 154 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentRequestUserType", + "type": "Type", + "tags": [], + "label": "CommentRequestUserType", + "description": [], + "signature": [ + "{ comment: string; type: CommentType.user; owner: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 153 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponse", + "type": "Type", "tags": [], - "label": "CommentResponseTypeAlertsRt", + "label": "CommentResponse", "description": [], "signature": [ - "IntersectionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ type: ", - "UnionC", - "<[", - "LiteralC", - "<", + "{ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -17645,9 +5865,15 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".generatedAlert>, ", - "LiteralC", - "<", + ".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", @@ -17655,1507 +5881,996 @@ "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", - "]>; }>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".alert | ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.CommentType", + "text": "CommentType" }, - ".case>, ", - "LiteralC", - "<", + ".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" - }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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": 147 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentResponseAlertsType", + "type": "Type", + "tags": [], + "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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 148 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.CommentsResponse", + "type": "Type", + "tags": [], + "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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 150 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorField", + "type": "Type", + "tags": [], + "label": "ConnectorField", + "description": [], + "signature": [ + "{ id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 49 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorFields", + "type": "Type", + "tags": [], + "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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 92 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorJiraTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorJiraTypeFields", + "description": [], + "signature": [ + "{ type: ConnectorTypes.jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 84 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappings", + "type": "Type", + "tags": [], + "label": "ConnectorMappings", + "description": [], + "signature": [ + "{ mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; owner: string; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 38 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorMappingsAttributes", + "type": "Type", + "tags": [], + "label": "ConnectorMappingsAttributes", + "description": [], + "signature": [ + "{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 91 + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 37 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.CommentsResponseRt", - "type": "Object", + "id": "def-common.ConnectorResillientTypeFields", + "type": "Type", "tags": [], - "label": "CommentsResponseRt", + "label": "ConnectorResillientTypeFields", "description": [], "signature": [ - "TypeC", - "<{ comments: ", - "ArrayC", - "<", - "IntersectionC", - "<[", - "UnionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", + "{ type: ConnectorTypes.resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 85 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorServiceNowITSMTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorServiceNowITSMTypeFields", + "description": [], + "signature": [ + "{ type: 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", + "lineNumber": 86 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorServiceNowSIRTypeFields", + "type": "Type", + "tags": [], + "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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 89 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ConnectorTypeFields", + "type": "Type", + "tags": [], + "label": "ConnectorTypeFields", + "description": [], + "signature": [ + "{ type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } | { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".case>, ", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } | { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "<", + ".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" + }, + ".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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 83 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DEFAULT_DATE_FORMAT", + "type": "string", + "tags": [], + "label": "DEFAULT_DATE_FORMAT", + "description": [], + "signature": [ + "\"dateFormat\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 7 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.DEFAULT_DATE_FORMAT_TZ", + "type": "string", + "tags": [], + "label": "DEFAULT_DATE_FORMAT_TZ", + "description": [], + "signature": [ + "\"dateFormat:tz\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 8 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ENABLE_CASE_CONNECTOR", + "type": "boolean", + "tags": [], + "label": "ENABLE_CASE_CONNECTOR", + "description": [ + "\nThis flag governs enabling the case as a connector feature. It is disabled by default as the feature is not complete." + ], + "signature": [ + "false" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 90 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseAttributes", + "type": "Type", + "tags": [], + "label": "ESCaseAttributes", + "description": [], + "signature": [ + "Pick<{ description: string; status: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" }, - ".generatedAlert>, ", - "LiteralC", - "<", + "; tags: string[]; title: string; type: CaseType; connector: ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".alert>]>; alertId: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; rule: ", - "TypeC", - "<{ id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".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.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".case>, ", - "LiteralC", - "<", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "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", - "; }>" + ".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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 307 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCaseConnectorTypes", + "type": "Type", + "tags": [], + "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", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 99 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCasePatchRequest", + "type": "Type", + "tags": [], + "label": "ESCasePatchRequest", + "description": [], + "signature": [ + "Pick<{ 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: ", + { + "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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 308 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESCasesConfigureAttributes", + "type": "Type", + "tags": [], + "label": "ESCasesConfigureAttributes", + "description": [], + "signature": [ + "Pick<{ 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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 86 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ESConnectorFields", + "type": "Type", + "tags": [], + "label": "ESConnectorFields", + "description": [], + "signature": [ + "{ key: string; value: unknown; }[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 94 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ExternalServiceResponse", + "type": "Type", + "tags": [], + "label": "ExternalServiceResponse", + "description": [], + "signature": [ + "{ title: string; id: string; pushedDate: string; url: string; } & { comments?: ({ commentId: string; pushedDate: string; } & { externalCommentId?: string | undefined; })[] | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 305 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.FindQueryParams", + "type": "Type", + "tags": [], + "label": "FindQueryParams", + "description": [], + "signature": [ + "{ subCaseId?: string | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; hasReference?: { id: string; type: string; } | { id: string; type: string; }[] | undefined; fields?: string[] | undefined; filter?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 121 + "lineNumber": 142 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ConnectorFieldsRt", - "type": "Object", + "id": "def-common.GetCaseIdsByAlertIdAggs", + "type": "Type", "tags": [], - "label": "ConnectorFieldsRt", + "label": "GetCaseIdsByAlertIdAggs", "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", - "]>" + "{ references: { doc_count: number; caseIds: { buckets: { key: string; }[]; }; }; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 155 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.GetConfigureFindRequest", + "type": "Type", + "tags": [], + "label": "GetConfigureFindRequest", + "description": [], + "signature": [ + "{ owner?: string | string[] | undefined; }" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 25 + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 90 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ConnectorMappingsAttributesRT", - "type": "Object", + "id": "def-common.GetFieldsResponse", + "type": "Type", "tags": [], - "label": "ConnectorMappingsAttributesRT", + "label": "GetFieldsResponse", "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\">]>; }>" + "{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }" ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 26 + "lineNumber": 56 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ConnectorMappingsRt", - "type": "Object", + "id": "def-common.JIRA_ACTION_TYPE_ID", + "type": "string", "tags": [], - "label": "ConnectorMappingsRt", + "label": "JIRA_ACTION_TYPE_ID", "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\">]>; }>>; }>" + "\".jira\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 32 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 63 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ConnectorTypeFieldsRt", - "type": "Object", + "id": "def-common.JiraFieldsType", + "type": "Type", "tags": [], - "label": "ConnectorTypeFieldsRt", + "label": "JiraFieldsType", "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", - "; }>]>" + "{ issueType: string | null; priority: string | null; parent: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 17 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.MAX_ALERTS_PER_SUB_CASE", + "type": "number", + "tags": [], + "label": "MAX_ALERTS_PER_SUB_CASE", + "description": [ + "\nAlerts" + ], + "signature": [ + "5000" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 66 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 76 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ContextTypeUserRt", - "type": "Object", + "id": "def-common.MAX_GENERATED_ALERTS_PER_SUB_CASE", + "type": "number", "tags": [], - "label": "ContextTypeUserRt", + "label": "MAX_GENERATED_ALERTS_PER_SUB_CASE", "description": [], "signature": [ - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user>; }>" + "50" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 57 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 77 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ExternalServiceResponseRt", - "type": "Object", + "id": "def-common.OWNER_FIELD", + "type": "string", "tags": [], - "label": "ExternalServiceResponseRt", - "description": [], + "label": "OWNER_FIELD", + "description": [ + "\nThis field is used for authorization of the entities within the cases plugin. Each entity within Cases will have the owner field\nset to a string that represents the plugin that \"owns\" (i.e. the plugin that originally issued the POST request to\ncreate the entity) the entity.\n\nThe Authorization class constructs a string composed of the operation being performed (createCase, getComment, etc),\nand the owner of the entity being acted upon or created. This string is then given to the Security plugin which\nchecks to see if the user making the request has that particular string stored within it's privileges. If it does,\nthen the operation succeeds, otherwise the operation fails.\n\nAPIs that create/update an entity require that the owner field be passed in the body of the request.\nAPIs that search for entities typically require that the owner be passed as a query parameter.\nAPIs that specify an ID of an entity directly generally don't need to specify the owner field.\n\nFor APIs that create/update an entity, the RBAC implementation checks to see if the user making the request has the\ncorrect privileges for performing that action (a create/update) for the specified owner.\nThis check is done through the Security plugin's API.\n\nFor APIs that search for entities, the RBAC implementation creates a filter for the saved objects query that limits\nthe search to only owners that the user has access to. We also check that the objects returned by the saved objects\nAPI have the limited owner scope. If we find one that the user does not have permissions for, we throw a 403 error.\nThe owner field that is passed in as a query parameter can be used to further limit the results. If a user attempts\nto pass an owner that they do not have access to, the owner is ignored.\n\nFor APIs that retrieve/delete entities directly using their ID, the RBAC implementation requests the object first,\nand then checks to see if the user making the request has access to that operation and owner. If the user does, the\noperation continues, otherwise we throw a 403." + ], "signature": [ - "IntersectionC", - "<[", - "TypeC", - "<{ title: ", - "StringC", - "; id: ", - "StringC", - "; pushedDate: ", - "StringC", - "; url: ", - "StringC", - "; }>, ", - "PartialC", - "<{ comments: ", - "ArrayC", - "<", - "IntersectionC", - "<[", - "TypeC", - "<{ commentId: ", - "StringC", - "; pushedDate: ", - "StringC", - "; }>, ", - "PartialC", - "<{ externalCommentId: ", - "StringC", - "; }>]>>; }>]>" + "\"owner\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 155 + "path": "x-pack/plugins/cases/common/api/cases/constants.ts", + "lineNumber": 36 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.GetCaseIdsByAlertIdAggsRt", - "type": "Object", + "id": "def-common.RESILIENT_ACTION_TYPE_ID", + "type": "string", "tags": [], - "label": "GetCaseIdsByAlertIdAggsRt", + "label": "RESILIENT_ACTION_TYPE_ID", "description": [], "signature": [ - "TypeC", - "<{ references: ", - "TypeC", - "<{ doc_count: ", - "NumberC", - "; caseIds: ", - "TypeC", - "<{ buckets: ", - "ArrayC", - "<", - "TypeC", - "<{ key: ", - "StringC", - "; }>>; }>; }>; }>" + "\".resilient\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 18 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 64 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.JiraFieldsRT", - "type": "Object", + "id": "def-common.ResilientFieldsType", + "type": "Type", "tags": [], - "label": "JiraFieldsRT", + "label": "ResilientFieldsType", "description": [], "signature": [ - "TypeC", - "<{ issueType: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; priority: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; parent: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>" + "{ incidentTypes: string[] | null; severityCode: string | null; }" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", - "lineNumber": 11 + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 16 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.NumberFromString", - "type": "Object", + "id": "def-common.SAVED_OBJECT_TYPES", + "type": "Array", "tags": [], - "label": "NumberFromString", + "label": "SAVED_OBJECT_TYPES", + "description": [ + "\nIf more values are added here please also add them here: x-pack/test/case_api_integration/common/fixtures/plugins" + ], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 22 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SavedObjectFindOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectFindOptions", "description": [], "signature": [ - "Type", - "" + "{ defaultSearchOperator?: \"AND\" | \"OR\" | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; hasReference?: { id: string; type: string; } | { id: string; type: string; }[] | undefined; fields?: string[] | undefined; filter?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }" ], "source": { "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 12 + "lineNumber": 72 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ResilientFieldsRT", - "type": "Object", + "id": "def-common.SECURITY_SOLUTION_OWNER", + "type": "string", "tags": [], - "label": "ResilientFieldsRT", + "label": "SECURITY_SOLUTION_OWNER", + "description": [ + "\nThis must be the same value that the security solution plugin uses to define the case kind when it registers the\nfeature for the 7.13 migration only.\n\nThis variable is being also used by test files and mocks." + ], + "signature": [ + "\"securitySolution\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 85 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SERVICENOW_ITSM_ACTION_TYPE_ID", + "type": "string", + "tags": [], + "label": "SERVICENOW_ITSM_ACTION_TYPE_ID", "description": [], "signature": [ - "TypeC", - "<{ incidentTypes: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "NullC", - "]>; severityCode: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>" + "\".servicenow\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", - "lineNumber": 11 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 61 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SavedObjectFindOptionsRt", - "type": "Object", + "id": "def-common.SERVICENOW_SIR_ACTION_TYPE_ID", + "type": "string", "tags": [], - "label": "SavedObjectFindOptionsRt", + "label": "SERVICENOW_SIR_ACTION_TYPE_ID", "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\">]>; }>" + "\".servicenow-sir\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 62 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowITSMFieldsType", + "type": "Type", + "tags": [], + "label": "ServiceNowITSMFieldsType", + "description": [], + "signature": [ + "{ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 19 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ServiceNowSIRFieldsType", + "type": "Type", + "tags": [], + "label": "ServiceNowSIRFieldsType", + "description": [], + "signature": [ + "{ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" ], "source": { - "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 25 + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 21 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ServiceNowITSMFieldsRT", - "type": "Object", + "id": "def-common.StatusAll", + "type": "string", "tags": [], - "label": "ServiceNowITSMFieldsRT", + "label": "StatusAll", "description": [], "signature": [ - "TypeC", - "<{ impact: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; severity: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; urgency: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; category: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; subcategory: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; }>" + "\"all\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", - "lineNumber": 11 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 21 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.ServiceNowSIRFieldsRT", - "type": "Object", + "id": "def-common.StatusAllType", + "type": "Type", "tags": [], - "label": "ServiceNowSIRFieldsRT", + "label": "StatusAllType", "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", - "]>; }>" + "\"all\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", - "lineNumber": 11 + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 22 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCaseAttributesRt", - "type": "Object", + "id": "def-common.SUB_CASE_DETAILS_URL", + "type": "string", "tags": [], - "label": "SubCaseAttributesRt", + "label": "SUB_CASE_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 42 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASE_SAVED_OBJECT", + "type": "string", + "tags": [], + "label": "SUB_CASE_SAVED_OBJECT", "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", - "]>; }>]>" + "\"cases-sub-case\"" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 20 + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 14 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASE_USER_ACTIONS_URL", + "type": "string", + "tags": [], + "label": "SUB_CASE_USER_ACTIONS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 43 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCasePatchRequestRt", - "type": "Object", + "id": "def-common.SUB_CASES_PATCH_DEL_URL", + "type": "string", "tags": [], - "label": "SubCasePatchRequestRt", + "label": "SUB_CASES_PATCH_DEL_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 40 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUB_CASES_URL", + "type": "string", + "tags": [], + "label": "SUB_CASES_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 41 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCaseAttributes", + "type": "Type", + "tags": [], + "label": "SubCaseAttributes", "description": [], "signature": [ - "IntersectionC", - "<[", - "PartialC", - "<{ status: ", - "UnionC", - "<[", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - ".open>, ", - "LiteralC", - ", ", - "LiteralC", - "<", + "; } & { 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; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 107 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasePatchRequest", + "type": "Type", + "tags": [], + "label": "SubCasePatchRequest", + "description": [], + "signature": [ + "{ status?: ", { "pluginId": "cases", "scope": "common", @@ -19173,39 +6903,24 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - ".closed>]>; }>, ", - "TypeC", - "<{ id: ", - "StringC", - "; version: ", - "StringC", - "; }>]>" + " | undefined; } & { id: string; version: string; }" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 67 + "lineNumber": 111 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCaseResponseRt", - "type": "Object", + "id": "def-common.SubCaseResponse", + "type": "Type", "tags": [], - "label": "SubCaseResponseRt", + "label": "SubCaseResponse", "description": [], "signature": [ - "IntersectionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ status: ", - "UnionC", - "<[", - "LiteralC", - "<", + "{ status: ", { "pluginId": "cases", "scope": "common", @@ -19213,19 +6928,55 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - ".open>, ", - "LiteralC", - ", ", - "LiteralC", - "<", + ".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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 108 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindRequest", + "type": "Type", + "tags": [], + "label": "SubCasesFindRequest", + "description": [], + "signature": [ + "{ status?: ", { "pluginId": "cases", "scope": "common", @@ -19233,139 +6984,32 @@ "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", - "]>; }>]>, ", - "TypeC", - "<{ id: ", - "StringC", - "; totalComment: ", - "NumberC", - "; totalAlerts: ", - "NumberC", - "; version: ", - "StringC", - "; }>, ", - "PartialC", - "<{ comments: ", - "ArrayC", - "<", - "IntersectionC", - "<[", - "UnionC", - "<[", - "IntersectionC", - "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", + " | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; owner?: string | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 113 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesFindResponse", + "type": "Type", + "tags": [], + "label": "SubCasesFindResponse", + "description": [], + "signature": [ + "{ 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", @@ -19373,13 +7017,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", - "<[", - "LiteralC", - "<", + ".user; owner: string; } & { associationType: ", { "pluginId": "cases", "scope": "common", @@ -19387,9 +7025,80 @@ "section": "def-common.AssociationType", "text": "AssociationType" }, - ".case>, ", - "LiteralC", - "<", + "; 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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 110 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesPatchRequest", + "type": "Type", + "tags": [], + "label": "SubCasesPatchRequest", + "description": [], + "signature": [ + "{ subCases: ({ status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; } & { id: string; version: string; })[]; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 112 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SubCasesResponse", + "type": "Type", + "tags": [], + "label": "SubCasesResponse", + "description": [], + "signature": [ + "({ 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", @@ -19397,109 +7106,161 @@ "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", - "]>; }>; 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", - "<[", + "; 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" + } + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 109 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.SUPPORTED_CONNECTORS", + "type": "Array", + "tags": [], + "label": "SUPPORTED_CONNECTORS", + "description": [], + "signature": [ + "string[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 66 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ThirdPartyField", + "type": "Type", + "tags": [], + "label": "ThirdPartyField", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 24 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateKey", + "type": "Type", + "tags": [], + "label": "UpdateKey", + "description": [], + "signature": [ + "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 164 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.User", + "type": "Type", + "tags": [], + "label": "User", + "description": [], + "signature": [ + "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 18 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserAction", + "type": "Type", + "tags": [], + "label": "UserAction", + "description": [], + "signature": [ + "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 66 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserActionField", + "type": "Type", + "tags": [], + "label": "UserActionField", + "description": [], + "signature": [ + "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\")[]" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 67 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.UserActionFieldType", + "type": "Type", + "tags": [], + "label": "UserActionFieldType", + "description": [], + "signature": [ + "\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"owner\" | \"connector\" | \"pushed\" | \"sub_case\"" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 68 + }, + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "cases", + "id": "def-common.AlertCommentRequestRt", + "type": "Object", + "tags": [], + "label": "AlertCommentRequestRt", + "description": [ + "\nThis defines the structure of how alerts (generated or user attached) are stored in saved objects documents. It also\nrepresents of an alert after it has been transformed. A generated alert will be transformed by the connector so that\nit matches this structure. User attached alerts do not need to be transformed." + ], + "signature": [ "TypeC", "<{ type: ", "UnionC", @@ -19514,274 +7275,148 @@ "text": "CommentType" }, ".generatedAlert>, ", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".alert>]>; alertId: ", - "UnionC", - "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", - "<[", + "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": [ "ArrayC", "<", - "StringC", - ">, ", - "StringC", - "]>; rule: ", - "TypeC", - "<{ id: ", - "UnionC", + "IntersectionC", "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", "UnionC", "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", + "IntersectionC", "<[", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" - }, - ".case>, ", - "LiteralC", + "TypeC" + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 132 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.AllCommentsResponseRT", + "type": "Object", + "tags": [], + "label": "AllCommentsResponseRT", + "description": [], + "signature": [ + "ArrayC", "<", - { - "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", - "]>; }>; 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", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>]>, ", - "TypeC", - "<{ id: ", - "StringC", - "; version: ", - "StringC", - "; }>]>>; }>]>" + "IntersectionC", + "<[", + "TypeC" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 44 + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 103 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCasesFindRequestRt", + "id": "def-common.AllReportersFindRequestRt", "type": "Object", "tags": [], - "label": "SubCasesFindRequestRt", + "label": "AllReportersFindRequestRt", "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: ", + "<{ owner: ", "UnionC", "<[", - "LiteralC", - "<\"AND\">, ", - "LiteralC", - "<\"OR\">]>; fields: ", "ArrayC", "<", "StringC", - ">; page: ", - "Type", - "; perPage: ", - "Type", - "; search: ", - "StringC", - "; searchFields: ", + ">, ", + "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", - ">; sortField: ", - "StringC", - "; sortOrder: ", - "UnionC", - "<[", - "LiteralC", - "<\"desc\">, ", - "LiteralC", - "<\"asc\">]>; }>" + ">, ", + "StringC" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 32 + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 278 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCasesFindResponseRt", + "id": "def-common.CaseAttributesRt", "type": "Object", "tags": [], - "label": "SubCasesFindResponseRt", + "label": "CaseAttributesRt", "description": [], "signature": [ "IntersectionC", "<[", "TypeC", - "<{ subCases: ", + "<{ description: ", + "StringC", + "; status: ", + "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", @@ -19789,181 +7424,150 @@ "IntersectionC", "<[", "TypeC", - "<{ status: ", - "UnionC", + "<{ 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", "<[", - "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", + "<{ connector: ", + "IntersectionC", "<[", "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; created_at: ", - "StringC", - "; created_by: ", - "UnionC", - "<[", + "<{ 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", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", + "<{ configuration_id: ", "StringC", - "]>; }>, ", - "NullC", - "]>; updated_at: ", - "UnionC", + "; }>" + ], + "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", "<[", - "StringC", - ", ", - "NullC", - "]>; updated_by: ", - "UnionC", + "IntersectionC", "<[", "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", + "<{ connector: ", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "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", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>, ", "TypeC", "<{ id: ", "StringC", - "; totalComment: ", - "NumberC", - "; totalAlerts: ", - "NumberC", - "; version: ", + "; name: ", "StringC", "; }>, ", - "PartialC", - "<{ comments: ", - "ArrayC", - "<", + "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", "<[", + "PartialC", + "<{ description: ", + "StringC", + "; status: ", "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": [ "IntersectionC", "<[", - "TypeC", - "<{ comment: ", - "StringC", - "; type: ", - "LiteralC", - "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", + "PartialC", + "<{ type: ", "UnionC", "<[", "LiteralC", @@ -19972,178 +7576,182 @@ "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", - "]>; }>; 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", - "<[", + "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", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", + "<{ case_id: ", "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", + "; connector_id: ", "StringC", - "]>; username: ", - "UnionC", + "; }>" + ], + "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", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>, ", "IntersectionC", "<[", "TypeC", - "<{ type: ", + "<{ description: ", + "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: ", "UnionC", "<[", - "LiteralC", + "ArrayC", "<", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".generatedAlert>, ", + "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.CommentType", - "text": "CommentType" + "section": "def-common.CaseType", + "text": "CaseType" }, - ".alert>]>; alertId: ", - "UnionC", + ".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", "<[", - "ArrayC", - "<", - "StringC", - ">, ", - "StringC", - "]>; index: ", - "UnionC", + "PartialC", + ", ", - "StringC", - "]>; rule: ", "TypeC", "<{ id: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; name: ", - "UnionC", + "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", "<[", - "StringC", - ", ", - "NullC", - "]>; }>; }>, ", "TypeC", - "<{ associationType: ", + "<{ 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: ", "UnionC", "<[", "LiteralC", @@ -20152,132 +7760,127 @@ "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" + "section": "def-common.CaseType", + "text": "CaseType" }, - ".subCase>]>; created_at: ", - "StringC", - "; created_by: ", - "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>; pushed_at: ", - "UnionC", - "<[", - "StringC", - ", ", - "NullC", - "]>; pushed_by: ", - "UnionC", + ".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", "<[", "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "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", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; updated_at: ", - "UnionC", + "PartialC", + "<{ description: ", + "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", "<[", - "StringC", - ", ", - "NullC", - "]>; updated_by: ", - "UnionC", + "IntersectionC", "<[", "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", + "<{ 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", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>]>, ", - "TypeC", - "<{ id: ", - "StringC", - "; version: ", + "ArrayC", + "<", "StringC", - "; }>]>>; }>]>>; page: ", - "NumberC", - "; per_page: ", - "NumberC", - "; total: ", - "NumberC", - "; }>, ", + ">, ", + "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", @@ -20285,31 +7888,23 @@ "NumberC", "; count_closed_cases: ", "NumberC", - "; }>]>" + "; }>" ], "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 57 + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 24 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCasesPatchRequestRt", + "id": "def-common.CaseStatusRt", "type": "Object", "tags": [], - "label": "SubCasesPatchRequestRt", + "label": "CaseStatusRt", "description": [], "signature": [ - "TypeC", - "<{ subCases: ", - "ArrayC", - "<", - "IntersectionC", - "<[", - "PartialC", - "<{ status: ", "UnionC", "<[", "LiteralC", @@ -20330,48 +7925,75 @@ "docId": "kibCasesPluginApi", "section": "def-common.CaseStatuses", "text": "CaseStatuses" - }, - "[\"in-progress\"]>, ", - "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": 72 + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 16 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "cases", - "id": "def-common.SubCasesResponseRt", + "id": "def-common.CaseUserActionAttributesRt", "type": "Object", "tags": [], - "label": "SubCasesResponseRt", + "label": "CaseUserActionAttributesRt", "description": [], "signature": [ + "TypeC", + "<{ action_field: ", "ArrayC", "<", - "IntersectionC", + "UnionC", "<[", + "LiteralC", + "<\"comment\">, ", + "LiteralC" + ], + "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", - "<{ status: ", + "<{ 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: ", "UnionC", "<[", "LiteralC", @@ -20380,156 +8002,81 @@ "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" + "section": "def-common.AssociationType", + "text": "AssociationType" }, - ".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", + ".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", "<[", - "TypeC", - "<{ email: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", + "PartialC", + "<{ associationType: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", + "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", + "<[", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>, ", "TypeC", - "<{ id: ", - "StringC", - "; totalComment: ", - "NumberC", - "; totalAlerts: ", - "NumberC", - "; version: ", + "<{ comment: ", "StringC", - "; }>, ", - "PartialC", - "<{ comments: ", - "ArrayC", - "<", - "IntersectionC", - "<[", + "; 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": [ "UnionC", "<[", - "IntersectionC", - "<[", "TypeC", "<{ comment: ", "StringC", @@ -20542,148 +8089,208 @@ "docId": "kibCasesPluginApi", "section": "def-common.CommentType", "text": "CommentType" - }, - ".user>; }>, ", - "TypeC", - "<{ associationType: ", - "UnionC", + } + ], + "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", "<[", - "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", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "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", - "]>; }>; pushed_at: ", - "UnionC", + "IntersectionC", "<[", - "StringC", - ", ", - "NullC", - "]>; pushed_by: ", + "TypeC", + "<{ type: ", "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", - "<{ email: ", - "UnionC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", + "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": [ "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; updated_at: ", + "TypeC", + "<{ issueType: ", "UnionC", "<[", "StringC", ", ", - "NullC", - "]>; updated_by: ", - "UnionC", - "<[", + "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", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", + "<{ action_type: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", + "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: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>, ", - "IntersectionC", + "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": [ + "UnionC", "<[", "TypeC", "<{ type: ", - "UnionC", - "<[", "LiteralC", "<", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" }, - ".generatedAlert>, ", + ".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: ", + "StringC", + "; type: ", "LiteralC", "<", { @@ -20693,39 +8300,271 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".alert>]>; alertId: ", + ".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", + "<[", + "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: ", "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", - "]>; index: ", + ", ", + "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: ", "UnionC", "<[", "ArrayC", "<", "StringC", ">, ", - "StringC", - "]>; rule: ", + "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": [ "TypeC", - "<{ id: ", + "<{ impact: ", "UnionC", "<[", "StringC", ", ", "NullC", - "]>; name: ", + "]>; 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: ", "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", + "<[", "TypeC", - "<{ associationType: ", + "<{ status: ", "UnionC", "<[", "LiteralC", @@ -20734,130 +8573,175 @@ "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", - "section": "def-common.AssociationType", - "text": "AssociationType" - }, - ".case>, ", + "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", + "<[", "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", - "]>; }>; pushed_at: ", - "UnionC", + "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", "<[", - "StringC", - ", ", - "NullC", - "]>; pushed_by: ", - "UnionC", + "IntersectionC", "<[", "TypeC", - "<{ email: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", + "<{ status: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", + "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: ", "UnionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; updated_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", - "]>; updated_by: ", - "UnionC", + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", "<[", + "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", - "<{ email: ", - "UnionC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "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", - "]>; username: ", - "UnionC", + "IntersectionC", "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>, ", - "NullC", - "]>; }>]>]>, ", "TypeC", - "<{ id: ", - "StringC", - "; version: ", - "StringC", - "; }>]>>; }>]>>" + "<{ status: ", + "UnionC" ], "source": { "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 73 + "lineNumber": 105 }, "deprecated": false, "initialIsOpen": false @@ -20878,24 +8762,7 @@ ", ", "NullC", ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>" + "StringC" ], "source": { "path": "x-pack/plugins/cases/common/api/user.ts", @@ -20920,26 +8787,7 @@ "<[", "UndefinedC", ", ", - "NullC", - ", ", - "StringC", - "]>; full_name: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; username: ", - "UnionC", - "<[", - "UndefinedC", - ", ", - "NullC", - ", ", - "StringC", - "]>; }>>" + "NullC" ], "source": { "path": "x-pack/plugins/cases/common/api/user.ts", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 892e3e02e7522..20d371cbcdc6e 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -27,6 +27,9 @@ import casesObj from './cases.json'; ## Server +### Classes + + ### Interfaces diff --git a/api_docs/charts.json b/api_docs/charts.json index 29c1c163d19a0..472631574b9ad 100644 --- a/api_docs/charts.json +++ b/api_docs/charts.json @@ -11,11 +11,11 @@ "label": "ColorPicker", "description": [], "signature": [ - "({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, }: ColorPickerProps) => JSX.Element" + "({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, maxDepth, layerIndex, }: ColorPickerProps) => JSX.Element" ], "source": { "path": "src/plugins/charts/public/static/components/color_picker.tsx", - "lineNumber": 111 + "lineNumber": 119 }, "deprecated": false, "children": [ @@ -24,14 +24,14 @@ "id": "def-public.ColorPicker.$1", "type": "Object", "tags": [], - "label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n}", + "label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n maxDepth,\n layerIndex,\n}", "description": [], "signature": [ "ColorPickerProps" ], "source": { "path": "src/plugins/charts/public/static/components/color_picker.tsx", - "lineNumber": 111 + "lineNumber": 119 }, "deprecated": false, "isRequired": true @@ -179,9 +179,7 @@ "type": "Array", "tags": [], "label": "xValues", - "description": [ - "sorted and unquie x values" - ], + "description": [], "signature": [ "number[]" ], @@ -354,17 +352,7 @@ "> | undefined, splitChartAccessor?: string | number | ", "AccessorFn", " | undefined, negate?: boolean) => (points: [", - "GeometryValue", - ", ", - "XYChartSeriesIdentifier", - "][]) => ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.ClickTriggerEvent", - "text": "ClickTriggerEvent" - } + "GeometryValue" ], "source": { "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", @@ -419,9 +407,7 @@ "type": "Object", "tags": [], "label": "splitSeriesAccessorFnMap", - "description": [ - "needed when using `splitSeriesAccessors` as `AccessorFn`" - ], + "description": [], "signature": [ "Map & { readonly type: ({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element; }" + "React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>" ], "source": { "path": "src/plugins/charts/public/static/components/legend_toggle.tsx", "lineNumber": 51 }, "deprecated": false, - "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "charts", + "id": "def-public.lightenColor", + "type": "Function", + "tags": [], + "label": "lightenColor", + "description": [], + "signature": [ + "(baseColor: string, step: number, totalSteps: number) => string" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/lighten_color.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { "parentPluginId": "charts", - "id": "def-public.props", - "type": "Uncategorized", + "id": "def-public.lightenColor.$1", + "type": "string", "tags": [], - "label": "props", + "label": "baseColor", "description": [], "signature": [ - "P" + "string" ], "source": { - "path": "node_modules/@types/react/index.d.ts", - "lineNumber": 359 + "path": "src/plugins/charts/public/services/palettes/lighten_color.ts", + "lineNumber": 14 }, - "deprecated": false + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "charts", + "id": "def-public.lightenColor.$2", + "type": "number", + "tags": [], + "label": "step", + "description": [], + "signature": [ + "number" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/lighten_color.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "charts", + "id": "def-public.lightenColor.$3", + "type": "number", + "tags": [], + "label": "totalSteps", + "description": [], + "signature": [ + "number" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/lighten_color.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { @@ -1132,6 +1170,86 @@ "lineNumber": 16 }, "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteArguments.stop", + "type": "Array", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "number[] | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteArguments.range", + "type": "CompoundType", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "\"number\" | \"percent\" | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 18 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteArguments.rangeMin", + "type": "number", + "tags": [], + "label": "rangeMin", + "description": [], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteArguments.rangeMax", + "type": "number", + "tags": [], + "label": "rangeMax", + "description": [], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteArguments.continuity", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + "\"above\" | \"below\" | \"all\" | \"none\" | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 21 + }, + "deprecated": false } ], "initialIsOpen": false @@ -1145,7 +1263,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 19 + "lineNumber": 24 }, "deprecated": false, "children": [ @@ -1161,7 +1279,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 20 + "lineNumber": 25 }, "deprecated": false }, @@ -1174,7 +1292,81 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 21 + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteState.stops", + "type": "Array", + "tags": [], + "label": "stops", + "description": [], + "signature": [ + "number[]" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteState.range", + "type": "CompoundType", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "\"number\" | \"percent\"" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteState.rangeMin", + "type": "number", + "tags": [], + "label": "rangeMin", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 29 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteState.rangeMax", + "type": "number", + "tags": [], + "label": "rangeMax", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 30 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.CustomPaletteState.continuity", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + "\"above\" | \"below\" | \"all\" | \"none\" | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 31 }, "deprecated": false } @@ -1383,53 +1575,14 @@ "path": "src/plugins/charts/public/services/palettes/types.ts", "lineNumber": 81 }, - "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", - "id": "def-public.PaletteDefinition.renderEditor", - "type": "Function", - "tags": [], - "label": "renderEditor", - "description": [ - "\nRenders the UI for editing the internal state of the palette.\nNot each palette has to feature an internal state, so this is an optional property." - ], - "signature": [ - "((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined" - ], - "source": { - "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 88 - }, "deprecated": false }, { "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColor", + "id": "def-public.PaletteDefinition.getCategoricalColor", "type": "Function", "tags": [], - "label": "getColor", + "label": "getCategoricalColor", "description": [ "\nColor a series according to the internal rules of the palette." ], @@ -1454,85 +1607,16 @@ ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 97 + "lineNumber": 87 }, - "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": 98 - }, - "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": 99 - }, - "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": 100 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColors", + "id": "def-public.PaletteDefinition.getCategoricalColors", "type": "Function", "tags": [], - "label": "getColors", + "label": "getCategoricalColors", "description": [ "\nGet a spectrum of colors of the current palette.\nThis can be used if the chart wants to control color assignment locally." ], @@ -1541,41 +1625,45 @@ ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 106 + "lineNumber": 96 }, - "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": 106 - }, - "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": 106 - }, - "deprecated": false - } - ] + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.PaletteDefinition.canDynamicColoring", + "type": "CompoundType", + "tags": [], + "label": "canDynamicColoring", + "description": [ + "\nDefine whether a palette supports dynamic coloring (i.e. gradient colors mapped to number values)" + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 100 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-public.PaletteDefinition.getColorForValue", + "type": "Function", + "tags": [], + "label": "getColorForValue", + "description": [ + "\nGet the assigned color for the given value based on its data domain and state settings.\nThis can be used for dynamic coloring based on uniform color distribution or custom stops." + ], + "signature": [ + "((value: number | undefined, state: T, { min, max }: { min: number; max: number; }) => string | undefined) | undefined" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 105 + }, + "deprecated": false } ], "initialIsOpen": false @@ -1599,7 +1687,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 28 + "lineNumber": 38 }, "deprecated": false, "children": [ @@ -1615,7 +1703,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 29 + "lineNumber": 39 }, "deprecated": false }, @@ -1628,7 +1716,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 30 + "lineNumber": 40 }, "deprecated": false }, @@ -1644,7 +1732,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 31 + "lineNumber": 41 }, "deprecated": false } @@ -1660,7 +1748,7 @@ "description": [], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 109 + "lineNumber": 112 }, "deprecated": false, "children": [ @@ -1684,25 +1772,9 @@ ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 110 + "lineNumber": 113 }, - "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": 110 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "charts", @@ -1724,11 +1796,9 @@ ], "source": { "path": "src/plugins/charts/public/services/palettes/types.ts", - "lineNumber": 111 + "lineNumber": 114 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -1953,7 +2023,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 24 + "lineNumber": 34 }, "deprecated": false, "children": [ @@ -1966,7 +2036,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 25 + "lineNumber": 35 }, "deprecated": false } @@ -2035,10 +2105,13 @@ { "parentPluginId": "charts", "id": "def-public.defaultCountLabel", - "type": "string", + "type": "Any", "tags": [], "label": "defaultCountLabel", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", "lineNumber": 26 @@ -2054,7 +2127,7 @@ "label": "LabelRotation", "description": [], "signature": [ - "number" + "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", @@ -2133,7 +2206,7 @@ "label": "ColorMode", "description": [], "signature": [ - "{ readonly Background: \"Background\"; readonly Labels: \"Labels\"; readonly None: \"None\"; }" + "Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>" ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", @@ -2150,7 +2223,7 @@ "label": "LabelRotation", "description": [], "signature": [ - "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; }" + "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" ], "source": { "path": "src/plugins/charts/public/static/components/collections.ts", @@ -2228,10 +2301,13 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.label", - "type": "string", + "type": "Any", "tags": [], "label": "label", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 39 @@ -2295,10 +2371,13 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.label", - "type": "string", + "type": "Any", "tags": [], "label": "label", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 57 @@ -2362,10 +2441,13 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.label", - "type": "string", + "type": "Any", "tags": [], "label": "label", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 75 @@ -2429,10 +2511,13 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.label", - "type": "string", + "type": "Any", "tags": [], "label": "label", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 93 @@ -2496,10 +2581,13 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label", - "type": "string", + "type": "Any", "tags": [], "label": "label", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 111 @@ -2563,10 +2651,13 @@ { "parentPluginId": "charts", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label", - "type": "string", + "type": "Any", "tags": [], "label": "label", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", "lineNumber": 130 @@ -2603,13 +2694,7 @@ "label": "ChartsPluginStart", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.ChartsPluginSetup", - "text": "ChartsPluginSetup" - } + "ChartsPluginSetup" ], "source": { "path": "src/plugins/charts/public/plugin.ts", @@ -2678,22 +2763,11 @@ "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", - "lineNumber": 53 + "lineNumber": 63 }, "deprecated": false, "children": [], @@ -2747,14 +2821,11 @@ "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + } ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 119 + "lineNumber": 175 }, "deprecated": false, "children": [], @@ -2820,6 +2891,86 @@ "lineNumber": 16 }, "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteArguments.stop", + "type": "Array", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "number[] | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 17 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteArguments.range", + "type": "CompoundType", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "\"number\" | \"percent\" | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 18 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteArguments.rangeMin", + "type": "number", + "tags": [], + "label": "rangeMin", + "description": [], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteArguments.rangeMax", + "type": "number", + "tags": [], + "label": "rangeMax", + "description": [], + "signature": [ + "number | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteArguments.continuity", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + "\"above\" | \"below\" | \"all\" | \"none\" | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 21 + }, + "deprecated": false } ], "initialIsOpen": false @@ -2833,7 +2984,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 19 + "lineNumber": 24 }, "deprecated": false, "children": [ @@ -2849,7 +3000,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 20 + "lineNumber": 25 }, "deprecated": false }, @@ -2862,7 +3013,81 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 21 + "lineNumber": 26 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteState.stops", + "type": "Array", + "tags": [], + "label": "stops", + "description": [], + "signature": [ + "number[]" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteState.range", + "type": "CompoundType", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "\"number\" | \"percent\"" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteState.rangeMin", + "type": "number", + "tags": [], + "label": "rangeMin", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 29 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteState.rangeMax", + "type": "number", + "tags": [], + "label": "rangeMax", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 30 + }, + "deprecated": false + }, + { + "parentPluginId": "charts", + "id": "def-common.CustomPaletteState.continuity", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + "\"above\" | \"below\" | \"all\" | \"none\" | undefined" + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 31 }, "deprecated": false } @@ -2888,7 +3113,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 28 + "lineNumber": 38 }, "deprecated": false, "children": [ @@ -2904,7 +3129,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 29 + "lineNumber": 39 }, "deprecated": false }, @@ -2917,7 +3142,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 30 + "lineNumber": 40 }, "deprecated": false }, @@ -2933,7 +3158,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 31 + "lineNumber": 41 }, "deprecated": false } @@ -2949,7 +3174,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 24 + "lineNumber": 34 }, "deprecated": false, "children": [ @@ -2962,7 +3187,7 @@ "description": [], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 25 + "lineNumber": 35 }, "deprecated": false } @@ -3001,7 +3226,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 33 + "lineNumber": 43 }, "deprecated": false, "initialIsOpen": false diff --git a/api_docs/core.json b/api_docs/core.json index 4fedef842a1c4..550b9e337923e 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -1026,7 +1026,7 @@ "Navigation link capabilities." ], "signature": [ - "{ [x: string]: boolean; }" + "Record" ], "source": { "path": "src/core/types/capabilities.ts", @@ -1062,7 +1062,7 @@ "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], "signature": [ - "{ [x: string]: boolean; }" + "Record" ], "source": { "path": "src/core/types/capabilities.ts", @@ -1267,23 +1267,20 @@ "{@link StartServicesAccessor}" ], "signature": [ - "() => Promise<[", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "section": "def-public.StartServicesAccessor", + "text": "StartServicesAccessor" }, - ", TPluginsStart, TStart]>" + "" ], "source": { "path": "src/core/public/index.ts", "lineNumber": 224 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -1632,9 +1629,7 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 24 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -1654,23 +1649,7 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 30 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -1690,26 +1669,7 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 36 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -1737,26 +1697,7 @@ "path": "src/core/public/deprecations/deprecations_service.ts", "lineNumber": 42 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2066,46 +2007,7 @@ "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "lineNumber": 38 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2133,9 +2035,7 @@ "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "lineNumber": 43 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -2171,26 +2071,7 @@ "path": "src/core/public/i18n/i18n_service.tsx", "lineNumber": 65 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2295,39 +2176,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 33 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2347,39 +2196,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 39 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2401,9 +2218,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 45 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -2421,39 +2236,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 54 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2471,23 +2254,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 61 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2505,23 +2272,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 67 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2539,23 +2290,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 72 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2573,23 +2308,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 79 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2607,23 +2326,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 84 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2643,9 +2346,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 90 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -2665,9 +2366,7 @@ "path": "src/core/public/ui_settings/types.ts", "lineNumber": 100 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -2695,153 +2394,15 @@ "{@link ToastsSetup}" ], "signature": [ - "{ get$: () => ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; add: (toastOrTitle: ", + "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.ToastsApi", + "text": "ToastsApi" }, - ") => ", - { - "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" - }, - "; }" + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], "source": { "path": "src/core/public/notifications/notifications_service.ts", @@ -2875,153 +2436,15 @@ "{@link ToastsStart}" ], "signature": [ - "{ 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) => ", + "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastsApi", + "text": "ToastsApi" }, - "; }" + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], "source": { "path": "src/core/public/notifications/notifications_service.ts", @@ -4071,56 +3494,7 @@ "path": "src/core/public/overlays/overlay_service.ts", "lineNumber": 52 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -4161,56 +3535,7 @@ "path": "src/core/public/overlays/overlay_service.ts", "lineNumber": 54 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -4244,57 +3569,7 @@ "path": "src/core/public/overlays/overlay_service.ts", "lineNumber": 56 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -7003,13 +6278,7 @@ "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.FatalErrorsSetup", - "text": "FatalErrorsSetup" - } + "FatalErrorsSetup" ], "source": { "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", @@ -7028,220 +6297,74 @@ "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." ], "signature": [ - "{ 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?: ", + "{ 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; }" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 85 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.MountPoint", + "type": "Type", + "tags": [], + "label": "MountPoint", + "description": [ + "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" + ], + "signature": [ + "(element: T) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "source": { + "path": "src/core/public/types.ts", + "lineNumber": 25 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.PluginInitializer", + "type": "Type", + "tags": [], + "label": "PluginInitializer", + "description": [ + "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" + ], + "signature": [ + "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" }, - "; addDanger: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Plugin", + "text": "Plugin" }, - ", 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", - "lineNumber": 85 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.MountPoint", - "type": "Type", - "tags": [], - "label": "MountPoint", - "description": [ - "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" - ], - "signature": [ - "(element: T) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } - ], - "source": { - "path": "src/core/public/types.ts", - "lineNumber": 25 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginInitializer", - "type": "Type", - "tags": [], - "label": "PluginInitializer", - "description": [ - "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" - ], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Plugin", - "text": "Plugin" - }, - " | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.AsyncPlugin", - "text": "AsyncPlugin" + "section": "def-public.AsyncPlugin", + "text": "AsyncPlugin" }, "" ], @@ -7279,11 +6402,7 @@ "\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", @@ -7319,11 +6438,11 @@ "\nType definition for a Saved Object attribute value\n" ], "signature": [ - "string | number | boolean | ", + "undefined | null | string | number | false | true | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", - "[] | null | undefined" + "[]" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -7342,9 +6461,8 @@ "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" ], "signature": [ - "string | number | boolean | ", - "SavedObjectAttributes", - " | null | undefined" + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -7440,25 +6558,7 @@ "label": "Toast", "description": [], "signature": [ - "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; }" + "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; } & { id: string; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", @@ -7503,25 +6603,7 @@ "\nAllowed fields for {@link ToastInput}.\n" ], "signature": [ - "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; }" + "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; }" ], "source": { "path": "src/core/public/notifications/toasts/toasts_api.tsx", @@ -7573,120 +6655,7 @@ "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", @@ -7738,120 +6707,7 @@ "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", @@ -8058,7 +6914,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 188 + "lineNumber": 210 }, "deprecated": false, "children": [ @@ -8076,7 +6932,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 192 + "lineNumber": 214 }, "deprecated": false }, @@ -8091,7 +6947,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 197 + "lineNumber": 219 }, "deprecated": false }, @@ -8106,7 +6962,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 202 + "lineNumber": 224 }, "deprecated": false }, @@ -8124,7 +6980,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 208 + "lineNumber": 230 }, "deprecated": false }, @@ -8142,7 +6998,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 215 + "lineNumber": 237 }, "deprecated": false }, @@ -8160,7 +7016,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 220 + "lineNumber": 242 }, "deprecated": false }, @@ -8178,7 +7034,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 225 + "lineNumber": 247 }, "deprecated": false }, @@ -8196,7 +7052,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 230 + "lineNumber": 252 }, "deprecated": false }, @@ -8211,7 +7067,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 236 + "lineNumber": 258 }, "deprecated": false }, @@ -8229,7 +7085,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 242 + "lineNumber": 264 }, "deprecated": false }, @@ -8244,7 +7100,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 248 + "lineNumber": 270 }, "deprecated": false }, @@ -8262,7 +7118,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 254 + "lineNumber": 276 }, "deprecated": false }, @@ -8280,7 +7136,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 260 + "lineNumber": 282 }, "deprecated": false }, @@ -8298,7 +7154,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 267 + "lineNumber": 289 }, "deprecated": false }, @@ -8312,11 +7168,11 @@ "\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": [ - "{ [x: string]: string; }" + "Record" ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 277 + "lineNumber": 299 }, "deprecated": false }, @@ -8332,7 +7188,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 279 + "lineNumber": 301 }, "deprecated": false, "children": [ @@ -8348,7 +7204,7 @@ ], "source": { "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 279 + "lineNumber": 301 }, "deprecated": false, "isRequired": true @@ -8748,9 +7604,7 @@ "type": "string", "tags": [], "label": "endpoint", - "description": [ - "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." - ], + "description": [], "signature": [ "string" ], @@ -8767,9 +7621,7 @@ "type": "Object", "tags": [], "label": "clientParams", - "description": [ - "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." - ], + "description": [], "signature": [ "Record" ], @@ -8786,9 +7638,7 @@ "type": "Object", "tags": [], "label": "options", - "description": [ - "- Options that affect the way we call the API and process the result." - ], + "description": [], "signature": [ { "pluginId": "core", @@ -8950,14 +7800,15 @@ "label": "isNotAuthorizedError", "description": [], "signature": [ - "(error: any) => error is ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchError", - "text": "LegacyElasticsearchError" - } + "section": "def-server.LegacyElasticsearchErrorHelpers", + "text": "LegacyElasticsearchErrorHelpers" + }, + ".isNotAuthorizedError" ], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", @@ -8993,14 +7844,15 @@ "label": "decorateNotAuthorizedError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchError", - "text": "LegacyElasticsearchError" - } + "section": "def-server.LegacyElasticsearchErrorHelpers", + "text": "LegacyElasticsearchErrorHelpers" + }, + ".decorateNotAuthorizedError" ], "source": { "path": "src/core/server/elasticsearch/legacy/errors.ts", @@ -9095,7 +7947,7 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 40 + "lineNumber": 39 } }, { @@ -9383,7 +8235,7 @@ "plugin": "data", "link": { "path": "src/plugins/data/server/autocomplete/value_suggestions_route.ts", - "lineNumber": 67 + "lineNumber": 65 } }, { @@ -9439,7 +8291,7 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/routes/api/indices/register_list_route.ts", - "lineNumber": 18 + "lineNumber": 16 } }, { @@ -9460,7 +8312,7 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/routes/api/indices/register_reload_route.ts", - "lineNumber": 33 + "lineNumber": 28 } }, { @@ -9488,14 +8340,14 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/routes/api/templates/register_get_routes.ts", - "lineNumber": 24 + "lineNumber": 22 } }, { "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/routes/api/templates/register_get_routes.ts", - "lineNumber": 65 + "lineNumber": 62 } }, { @@ -9572,14 +8424,14 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/routes/api/component_templates/create.ts", - "lineNumber": 28 + "lineNumber": 24 } }, { "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/routes/api/component_templates/update.ts", - "lineNumber": 32 + "lineNumber": 28 } }, { @@ -9596,181 +8448,6 @@ "lineNumber": 48 } }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.ts", - "lineNumber": 45 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.ts", - "lineNumber": 64 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_delete_route.ts", - "lineNumber": 50 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_fetch_route.ts", - "lineNumber": 27 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_get_route.ts", - "lineNumber": 37 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_pause_route.ts", - "lineNumber": 49 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_resume_route.ts", - "lineNumber": 49 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_update_route.ts", - "lineNumber": 47 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_create_route.ts", - "lineNumber": 52 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_fetch_route.ts", - "lineNumber": 29 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_fetch_route.ts", - "lineNumber": 35 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_get_route.ts", - "lineNumber": 38 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_get_route.ts", - "lineNumber": 58 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_pause_route.ts", - "lineNumber": 47 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_resume_route.ts", - "lineNumber": 47 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", - "lineNumber": 50 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", - "lineNumber": 59 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", - "lineNumber": 64 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.ts", - "lineNumber": 72 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_update_route.ts", - "lineNumber": 53 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_update_route.ts", - "lineNumber": 66 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/follower_index/register_update_route.ts", - "lineNumber": 80 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/cross_cluster_replication/register_permissions_route.ts", - "lineNumber": 40 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/cross_cluster_replication/register_stats_route.ts", - "lineNumber": 29 - } - }, - { - "plugin": "infra", - "link": { - "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", - "lineNumber": 420 - } - }, { "plugin": "lists", "link": { @@ -9803,7 +8480,7 @@ "plugin": "monitoring", "link": { "path": "x-pack/plugins/monitoring/server/plugin.ts", - "lineNumber": 356 + "lineNumber": 361 } }, { @@ -9817,7 +8494,7 @@ "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.ts", - "lineNumber": 52 + "lineNumber": 60 } }, { @@ -10303,7 +8980,7 @@ "plugin": "fleet", "link": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 189 + "lineNumber": 190 } }, { @@ -10503,7 +9180,7 @@ "Navigation link capabilities." ], "signature": [ - "{ [x: string]: boolean; }" + "Record" ], "source": { "path": "src/core/types/capabilities.ts", @@ -10539,7 +9216,7 @@ "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], "signature": [ - "{ [x: string]: boolean; }" + "Record" ], "source": { "path": "src/core/types/capabilities.ts", @@ -10809,7 +9486,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 96 + "lineNumber": 87 }, "deprecated": false, "children": [ @@ -10830,7 +9507,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 + "lineNumber": 100 }, "deprecated": false, "children": [ @@ -10846,7 +9523,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 + "lineNumber": 100 }, "deprecated": false, "isRequired": true @@ -10863,7 +9540,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 + "lineNumber": 100 }, "deprecated": false, "isRequired": true @@ -10882,7 +9559,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 109 + "lineNumber": 100 }, "deprecated": false, "isRequired": false @@ -10907,7 +9584,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 + "lineNumber": 116 }, "deprecated": false, "children": [ @@ -10923,7 +9600,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 + "lineNumber": 116 }, "deprecated": false, "isRequired": true @@ -10940,7 +9617,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 + "lineNumber": 116 }, "deprecated": false, "isRequired": true @@ -10959,7 +9636,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 125 + "lineNumber": 116 }, "deprecated": false, "isRequired": false @@ -10984,7 +9661,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 138 + "lineNumber": 129 }, "deprecated": false, "children": [ @@ -11000,7 +9677,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 138 + "lineNumber": 129 }, "deprecated": false, "isRequired": true @@ -11019,7 +9696,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 138 + "lineNumber": 129 }, "deprecated": false, "isRequired": false @@ -11044,7 +9721,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 154 + "lineNumber": 145 }, "deprecated": false, "children": [ @@ -11060,7 +9737,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 154 + "lineNumber": 145 }, "deprecated": false, "isRequired": true @@ -11079,7 +9756,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 154 + "lineNumber": 145 }, "deprecated": false, "isRequired": false @@ -11443,23 +10120,20 @@ "{@link StartServicesAccessor}" ], "signature": [ - "() => Promise<[", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" + "section": "def-server.StartServicesAccessor", + "text": "StartServicesAccessor" }, - ", TPluginsStart, TStart]>" + "" ], "source": { "path": "src/core/server/index.ts", "lineNumber": 499 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -12072,7 +10746,13 @@ "label": "level", "description": [], "signature": [ - "\"warning\" | \"none\" | \"info\" | \"critical\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MIGRATION_DEPRECATION_LEVEL", + "text": "MIGRATION_DEPRECATION_LEVEL" + } ], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", @@ -12169,6 +10849,24 @@ }, "deprecated": false }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.deprecationType", + "type": "CompoundType", + "tags": [], + "label": "deprecationType", + "description": [ + "\n(optional) Used to identify between different deprecation types.\nExample use case: in Upgrade Assistant, we may want to allow the user to sort by\ndeprecation type or show each type in a separate tab.\n\nFeel free to add new types if necessary.\nPredefined types are necessary to reduce having similar definitions with different keywords\nacross kibana deprecations." + ], + "signature": [ + "\"config\" | \"feature\" | undefined" + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 37 + }, + "deprecated": false + }, { "parentPluginId": "core", "id": "def-server.DeprecationsDetails.documentationUrl", @@ -12181,7 +10879,7 @@ ], "source": { "path": "src/core/server/deprecations/types.ts", - "lineNumber": 29 + "lineNumber": 39 }, "deprecated": false }, @@ -12193,11 +10891,11 @@ "label": "correctiveActions", "description": [], "signature": [ - "{ api?: { path: string; method: \"PUT\" | \"POST\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps?: string[] | undefined; }" + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps: string[]; }" ], "source": { "path": "src/core/server/deprecations/types.ts", - "lineNumber": 31 + "lineNumber": 41 }, "deprecated": false } @@ -12265,7 +10963,7 @@ ], "source": { "path": "src/core/server/deprecations/deprecations_service.ts", - "lineNumber": 103 + "lineNumber": 101 }, "deprecated": false, "children": [ @@ -12289,34 +10987,9 @@ ], "source": { "path": "src/core/server/deprecations/deprecations_service.ts", - "lineNumber": 104 + "lineNumber": 102 }, - "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": 104 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -12482,8 +11155,7 @@ "docId": "kibCorePluginApi", "section": "def-server.LegacyClusterClient", "text": "LegacyClusterClient" - }, - ", \"callAsInternalUser\" | \"asScoped\">; }" + } ], "source": { "path": "src/core/server/elasticsearch/types.ts", @@ -12592,51 +11264,7 @@ "path": "src/core/server/elasticsearch/types.ts", "lineNumber": 116 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -12681,8 +11309,7 @@ "docId": "kibCorePluginApi", "section": "def-server.LegacyClusterClient", "text": "LegacyClusterClient" - }, - ", \"callAsInternalUser\" | \"asScoped\">; }" + } ], "source": { "path": "src/core/server/elasticsearch/types.ts", @@ -12708,14 +11335,7 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 34 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", - "lineNumber": 33 + "lineNumber": 32 } }, { @@ -12929,7 +11549,13 @@ "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; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } ], "source": { "path": "src/core/server/elasticsearch/types.ts", @@ -12949,7 +11575,7 @@ "description": [], "source": { "path": "src/core/server/deprecations/types.ts", - "lineNumber": 60 + "lineNumber": 70 }, "deprecated": false, "children": [ @@ -12971,7 +11597,7 @@ ], "source": { "path": "src/core/server/deprecations/types.ts", - "lineNumber": 61 + "lineNumber": 71 }, "deprecated": false }, @@ -12983,311 +11609,19 @@ "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<", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - ">; 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", - "lineNumber": 62 + "lineNumber": 72 }, "deprecated": false } @@ -13500,702 +11834,196 @@ "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?: ", + " | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + "Stream" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 101 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions", + "type": "Interface", + "tags": [], + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 24 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nHTTP Headers with additional information about 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_resources/types.ts", + "lineNumber": 30 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit", + "type": "Interface", + "tags": [], + "label": "HttpResourcesServiceToolkit", + "description": [ + "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 43 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", + "type": "Function", + "tags": [], + "label": "renderCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application." + ], + "signature": [ + "(options?: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" }, - ") => ", - "KibanaResponse", - "<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, - ">; forbidden: (options?: ", + ">" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", + "type": "Function", + "tags": [], + "label": "renderAnonymousCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + ], + "signature": [ + "(options?: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" }, - ") => ", - "KibanaResponse", - "<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, - ">; notFound: (options?: ", + ">" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml", + "type": "Function", + "tags": [], + "label": "renderHtml", + "description": [ + "To respond with a custom HTML page." + ], + "signature": [ + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, ") => ", - "KibanaResponse", - "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, - ">; conflict: (options?: ", + "" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 49 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs", + "type": "Function", + "tags": [], + "label": "renderJs", + "description": [ + "To respond with a custom JS script file." + ], + "signature": [ + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, ") => ", - "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" - }, - ">) => void" - ], - "source": { - "path": "src/core/server/http_resources/types.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_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 - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions", - "type": "Interface", - "tags": [], - "label": "HttpResourcesRenderOptions", - "description": [ - "\nAllows to configure HTTP response parameters" - ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 24 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "\nHTTP Headers with additional information about 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_resources/types.ts", - "lineNumber": 30 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit", - "type": "Interface", - "tags": [], - "label": "HttpResourcesServiceToolkit", - "description": [ - "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." - ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 43 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", - "type": "Function", - "tags": [], - "label": "renderCoreApp", - "description": [ - "To respond with HTML page bootstrapping Kibana application." - ], - "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 45 - }, - "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", - "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", - "type": "Function", - "tags": [], - "label": "renderAnonymousCoreApp", - "description": [ - "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." - ], - "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 47 - }, - "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", - "id": "def-server.HttpResourcesServiceToolkit.renderHtml", - "type": "Function", - "tags": [], - "label": "renderHtml", - "description": [ - "To respond with a custom HTML page." - ], - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 49 - }, - "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", - "id": "def-server.HttpResourcesServiceToolkit.renderJs", - "type": "Function", - "tags": [], - "label": "renderJs", - "description": [ - "To respond with a custom JS script file." - ], - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, "" ], @@ -14203,32 +12031,7 @@ "path": "src/core/server/http_resources/types.ts", "lineNumber": 51 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -14314,17 +12117,13 @@ "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" ], "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>>; }; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], "source": { "path": "src/core/server/elasticsearch/client/cluster_client.ts", @@ -14358,53 +12157,12 @@ "section": "def-server.IScopedClusterClient", "text": "IScopedClusterClient" } - ], - "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 37 - }, - "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 - } - ] + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 37 + }, + "deprecated": false } ], "initialIsOpen": false @@ -14543,381 +12301,28 @@ "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", - "; }>) => (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" + "text": "RequestHandler" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; noContent: (options?: ", + " ", - "KibanaResponse", - "; }) => Promise<", + ", any, { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", + "Stream", + " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - ">" + ") => ", + "KibanaResponse" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -14969,7 +12374,7 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - ", any, { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + ", any, { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", "Stream", " | undefined>(options: ", { @@ -14980,170 +12385,7 @@ "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", - "; }>" + "KibanaResponse" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -15304,9 +12546,7 @@ "path": "src/core/server/elasticsearch/client/cluster_client.ts", "lineNumber": 50 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -15518,17 +12758,13 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." ], "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>>; }; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], "source": { "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", @@ -15546,17 +12782,13 @@ "\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": [ - "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>>; }; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], "source": { "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", @@ -15600,9 +12832,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 31 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -15620,23 +12850,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 35 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -15654,9 +12868,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 39 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -15676,9 +12888,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 43 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -15696,26 +12906,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 47 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -15733,39 +12924,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 51 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -15783,23 +12942,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 55 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -15817,26 +12960,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 59 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -15854,23 +12978,7 @@ "path": "src/core/server/ui_settings/types.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -15883,28 +12991,12 @@ ], "signature": [ "(key: string) => boolean" - ], - "source": { - "path": "src/core/server/ui_settings/types.ts", - "lineNumber": 67 - }, - "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 - } - ] + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 67 + }, + "deprecated": false } ], "initialIsOpen": false @@ -15957,14 +13049,14 @@ "plugin": "crossClusterReplication", "link": { "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", - "lineNumber": 17 + "lineNumber": 16 } }, { "plugin": "crossClusterReplication", "link": { "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", - "lineNumber": 36 + "lineNumber": 27 } }, { @@ -16443,27 +13535,6 @@ "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": { @@ -19277,9 +16348,7 @@ "path": "src/core/server/metrics/types.ts", "lineNumber": 33 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -19550,7 +16619,7 @@ "The os platform" ], "signature": [ - "\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\" | \"netbsd\"" + "NodeJS.Platform" ], "source": { "path": "src/core/server/metrics/collectors/types.ts", @@ -20186,7 +17255,13 @@ "\nSchema to use to validate the plugin configuration.\n\n{@link PluginConfigSchema}" ], "signature": [ - "Type", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginConfigSchema", + "text": "PluginConfigSchema" + }, "" ], "source": { @@ -20314,21 +17389,14 @@ "signature": [ "{ legacy: { globalConfig$: ", "Observable", - " 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 autocompleteTimeout: 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; }>; }>; 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", - ") => boolean; isLessThan: (other: ", - "ByteSizeValue", - ") => boolean; isEqualTo: (other: ", - "ByteSizeValue", - ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>>; get: () => Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: 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 autocompleteTimeout: 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; }>; }>; 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: ", + "; 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", ") => boolean; isLessThan: (other: ", "ByteSizeValue", ") => boolean; isEqualTo: (other: ", "ByteSizeValue", - ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>; }; create: () => ", - "Observable", - "; get: () => T; }" + ") => 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" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -20552,7 +17620,7 @@ "description": [], "source": { "path": "src/core/server/deprecations/types.ts", - "lineNumber": 56 + "lineNumber": 66 }, "deprecated": false, "children": [ @@ -20584,34 +17652,9 @@ ], "source": { "path": "src/core/server/deprecations/types.ts", - "lineNumber": 57 + "lineNumber": 67 }, - "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": 57 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -20678,56 +17721,7 @@ "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", @@ -21284,7 +18278,13 @@ "\nThe current availability level of the service." ], "signature": [ - "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\"; }>" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatusLevel", + "text": "ServiceStatusLevel" + } ], "source": { "path": "src/core/server/status/types.ts", @@ -21698,9 +18698,7 @@ "path": "src/core/server/status/types.ts", "lineNumber": 226 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -22321,7 +19319,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 79 + "lineNumber": 70 }, "deprecated": false, "initialIsOpen": false @@ -22353,72 +19351,7 @@ "\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", @@ -22435,7 +19368,7 @@ "label": "EcsEventCategory", "description": [], "signature": [ - "\"host\" | \"database\" | \"package\" | \"session\" | \"registry\" | \"network\" | \"web\" | \"file\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + "\"host\" | \"authentication\" | \"database\" | \"package\" | \"session\" | \"registry\" | \"network\" | \"web\" | \"file\" | \"process\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", @@ -22469,7 +19402,7 @@ "label": "EcsEventOutcome", "description": [], "signature": [ - "\"unknown\" | \"success\" | \"failure\"" + "\"success\" | \"failure\" | \"unknown\"" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", @@ -22486,7 +19419,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"connection\" | \"user\" | \"end\" | \"error\" | \"info\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"connection\" | \"end\" | \"user\" | \"info\" | \"error\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", @@ -22505,17 +19438,7 @@ "\nClient used to query the elasticsearch cluster.\n" ], "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>>; }; }" + "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", @@ -22534,15 +19457,7 @@ "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" ], "signature": [ - "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; }" + "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; }" ], "source": { "path": "src/core/server/elasticsearch/client/client_config.ts", @@ -22561,15 +19476,7 @@ "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" ], "signature": [ - "T extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HandlerFunction", - "text": "HandlerFunction" - }, - " ? U : never" + "T extends HandlerFunction ? U : never" ], "source": { "path": "src/core/server/context/container/context.ts", @@ -22588,7 +19495,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", @@ -22633,208 +19540,29 @@ "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" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ") => ", - "KibanaResponse", - " | Buffer | ", + ", response: { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", "Stream", - ">; noContent: (options?: ", + " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - ") => ", + ") => ", "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<", + "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + } ], "source": { "path": "src/core/server/http_resources/types.ts", @@ -22853,13 +19581,7 @@ "\nHTTP Resources response parameters" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } + "HttpResponseOptions" ], "source": { "path": "src/core/server/http_resources/types.ts", @@ -22878,7 +19600,7 @@ "\nA function that returns a context value for a specific key of given context type.\n" ], "signature": [ - "(context: Pick>, request: ", + "(context: Pick>, rest: [request: ", { "pluginId": "core", "scope": "server", @@ -22886,7 +19608,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + ", response: { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", "Stream", " | undefined>(options: ", { @@ -22905,162 +19627,7 @@ "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", @@ -23081,15 +19648,7 @@ "\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: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyAPICaller", - "text": "LegacyAPICaller" - }, - "; asScoped: (request?: ", + "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", { "pluginId": "core", "scope": "server", @@ -23113,15 +19672,7 @@ "section": "def-server.FakeRequest", "text": "FakeRequest" }, - " | undefined) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyScopedClusterClient", - "text": "LegacyScopedClusterClient" - }, - ", \"callAsCurrentUser\" | \"callAsInternalUser\">; }" + " | undefined) => Pick; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", @@ -23341,15 +19892,7 @@ "\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: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyAPICaller", - "text": "LegacyAPICaller" - }, - "; asScoped: (request?: ", + "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", { "pluginId": "core", "scope": "server", @@ -23373,15 +19916,7 @@ "section": "def-server.FakeRequest", "text": "FakeRequest" }, - " | undefined) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyScopedClusterClient", - "text": "LegacyScopedClusterClient" - }, - ", \"callAsCurrentUser\" | \"callAsInternalUser\">; }" + " | undefined) => Pick; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", @@ -23394,28 +19929,14 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 14 + "lineNumber": 12 } }, { "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 42 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", - "lineNumber": 13 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts", - "lineNumber": 69 + "lineNumber": 38 } }, { @@ -23499,7 +20020,7 @@ "plugin": "monitoring", "link": { "path": "x-pack/plugins/monitoring/server/plugin.ts", - "lineNumber": 279 + "lineNumber": 284 } }, { @@ -23594,23 +20115,7 @@ "\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?: ", - { - "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; }" + "{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", @@ -23672,28 +20177,14 @@ "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 43 + "lineNumber": 42 } }, { "plugin": "indexManagement", "link": { "path": "x-pack/plugins/index_management/server/types.ts", - "lineNumber": 50 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/types.ts", - "lineNumber": 8 - } - }, - { - "plugin": "crossClusterReplication", - "link": { - "path": "x-pack/plugins/cross_cluster_replication/server/types.ts", - "lineNumber": 41 + "lineNumber": 49 } }, { @@ -23710,27 +20201,6 @@ "lineNumber": 73 } }, - { - "plugin": "infra", - "link": { - "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", - "lineNumber": 9 - } - }, - { - "plugin": "infra", - "link": { - "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", - "lineNumber": 139 - } - }, - { - "plugin": "infra", - "link": { - "path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts", - "lineNumber": 405 - } - }, { "plugin": "crossClusterReplication", "link": { @@ -23808,17 +20278,7 @@ "label": "LegacyElasticsearchClientConfig", "description": [], "signature": [ - "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; }" + "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; }" ], "source": { "path": "src/core/server/elasticsearch/legacy/elasticsearch_client_config.ts", @@ -23857,73 +20317,7 @@ "\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<", - "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; }" + "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; }" ], "source": { "path": "node_modules/@kbn/logging/target/log_meta.d.ts", @@ -23942,15 +20336,7 @@ "\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 | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MakeUsageFromSchema", - "text": "MakeUsageFromSchema" - }, - " : boolean) | undefined; }" + "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends any[] | undefined ? boolean : T[Key] extends object | undefined ? boolean | MakeUsageFromSchema : boolean) | undefined; }" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -23969,13 +20355,7 @@ "\n{@inheritdoc MetricsServiceSetup}\n" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } + "MetricsServiceSetup" ], "source": { "path": "src/core/server/metrics/types.ts", @@ -24036,8 +20416,7 @@ "\nDedicated type for plugin configuration schema.\n" ], "signature": [ - "Type", - "" + "Type" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -24135,11 +20514,7 @@ "\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", @@ -24158,11 +20533,11 @@ "\nType definition for a Saved Object attribute value\n" ], "signature": [ - "string | number | boolean | ", + "undefined | null | string | number | false | true | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", - "[] | null | undefined" + "[]" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -24181,9 +20556,8 @@ "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" ], "signature": [ - "string | number | boolean | ", - "SavedObjectAttributes", - " | null | undefined" + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes" ], "source": { "path": "src/core/types/saved_objects.ts", @@ -24260,13 +20634,16 @@ "label": "SharedGlobalConfig", "description": [], "signature": [ - "{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: 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 autocompleteTimeout: 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 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; }>; }>; }" + "{ 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" ], "source": { "path": "src/core/server/plugins/types.ts", @@ -24333,7 +20710,7 @@ "\nThe current \"level\" of availability of a service.\n" ], "signature": [ - "{ 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\"; }>; }" + "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\"; }>; }>" ], "source": { "path": "src/core/server/status/types.ts", diff --git a/api_docs/core_application.json b/api_docs/core_application.json index e890b6f92a2ad..51f24e0dccfb0 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -115,9 +115,7 @@ "type": "string", "tags": [], "label": "basePath", - "description": [ - "the URL path scope for the sub history" - ], + "description": [], "signature": [ "string" ], @@ -175,7 +173,7 @@ "\nThe last action dispatched on the history stack." ], "signature": [ - "\"PUSH\" | \"POP\" | \"REPLACE\"" + "Action" ], "source": { "path": "src/core/public/application/scoped_history.ts", @@ -209,9 +207,7 @@ "type": "CompoundType", "tags": [], "label": "pathOrLocation", - "description": [ - "a string or location descriptor" - ], + "description": [], "signature": [ "string | ", "LocationDescriptorObject", @@ -270,9 +266,7 @@ "type": "CompoundType", "tags": [], "label": "pathOrLocation", - "description": [ - "a string or location descriptor" - ], + "description": [], "signature": [ "string | ", "LocationDescriptorObject", @@ -329,9 +323,7 @@ "type": "number", "tags": [], "label": "n", - "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." - ], + "description": [], "signature": [ "number" ], @@ -457,9 +449,7 @@ "type": "Function", "tags": [], "label": "listener", - "description": [ - "a function that receives location updates." - ], + "description": [], "signature": [ "(location: ", "Location", @@ -844,63 +834,20 @@ "\nA mount function called when the user navigates to this app's route." ], "signature": [ - "(params: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppMountParameters", - "text": "AppMountParameters" - }, - ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppUnmount", - "text": "AppUnmount" + "section": "def-public.AppMount", + "text": "AppMount" }, - " | 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, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -1262,7 +1209,7 @@ "\nGets the read-only capabilities." ], "signature": [ - "{ 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; }>; }" + "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; }>; }>" ], "source": { "path": "src/core/public/application/types.ts", @@ -1606,6 +1553,13 @@ "lineNumber": 16 } }, + { + "plugin": "fleet", + "link": { + "path": "x-pack/plugins/fleet/public/applications/integrations/index.tsx", + "lineNumber": 67 + } + }, { "plugin": "fleet", "link": { @@ -1710,7 +1664,7 @@ "plugin": "dashboard", "link": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 298 + "lineNumber": 299 } }, { @@ -1738,14 +1692,21 @@ "plugin": "lens", "link": { "path": "x-pack/plugins/lens/public/app_plugin/types.ts", - "lineNumber": 71 + "lineNumber": 44 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/app_plugin/types.ts", + "lineNumber": 72 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/public/app_plugin/mounter.tsx", - "lineNumber": 171 + "lineNumber": 219 } }, { @@ -1825,34 +1786,6 @@ "lineNumber": 13 } } - ], - "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 - } ] }, { @@ -1879,33 +1812,7 @@ "path": "src/core/public/application/types.ts", "lineNumber": 502 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2062,7 +1969,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", @@ -2078,7 +1985,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", @@ -2094,7 +2001,7 @@ "section": "def-public.AppDeepLink", "text": "AppDeepLink" }, - "[]; })" + "[]; }" ], "source": { "path": "src/core/public/application/types.ts", @@ -2150,7 +2057,7 @@ "signature": [ "(factory: ", "AppLeaveActionFactory", - ", nextAppId?: string | undefined) => ", + ", nextAppId: string | undefined) => ", { "pluginId": "core", "scope": "public", @@ -2303,31 +2210,7 @@ "\nDefines the list of fields that can be updated via an {@link AppUpdater}." ], "signature": [ - "{ 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; }" + "{ status?: AppStatus | undefined; deepLinks?: AppDeepLink[] | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" ], "source": { "path": "src/core/public/application/types.ts", @@ -2381,31 +2264,7 @@ "\nPublic information about a registered app's {@link AppDeepLink | deepLinks}\n" ], "signature": [ - "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" - }, - "; }" + "Pick & { deepLinks: PublicAppDeepLinkInfo[]; keywords: string[]; navLinkStatus: AppNavLinkStatus; }" ], "source": { "path": "src/core/public/application/types.ts", @@ -2424,39 +2283,7 @@ "\nPublic information about a registered {@link App | application}\n" ], "signature": [ - "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" - }, - "[]; }" + "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[]; }" ], "source": { "path": "src/core/public/application/types.ts", diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index fae65ff62c971..997507c911665 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -284,24 +284,7 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "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\">" + "PropsForButton" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -352,7 +335,7 @@ "\nContent of the button (in lieu of `children`)" ], "signature": [ - "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" + "React.ReactNode" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -385,24 +368,7 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "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\">" + "PropsForButton" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -468,24 +434,7 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "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\">" + "PropsForButton" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -551,24 +500,7 @@ "<", "CommonEuiButtonEmptyProps", ", {}>, ", - "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\">" + "PropsForButton" ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", @@ -670,39 +602,20 @@ "label": "mount", "description": [], "signature": [ - "(element: HTMLElement) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" ], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 17 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2459,39 +2372,20 @@ "label": "content", "description": [], "signature": [ - "(element: HTMLDivElement) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 41 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2508,7 +2402,11 @@ "description": [], "signature": [ "CommonProps", - " & { text: React.ReactNode; href?: string | undefined; onClick?: ((event: React.MouseEvent) => void) | undefined; truncate?: boolean | undefined; }" + " & { text: ", + "ReactNode", + "; href?: string | undefined; onClick?: ((event: ", + "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 7bedeac3baf79..fedb0a0e9cd65 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -779,23 +779,15 @@ "label": "fetchOptions", "description": [], "signature": [ - "{ readonly path: string; readonly query?: ", + "Readonly<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", - "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" + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" }, - " | 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", @@ -861,7 +853,7 @@ "label": "request", "description": [], "signature": [ - "{ 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; }" + "Readonly" ], "source": { "path": "src/core/public/http/types.ts", @@ -920,7 +912,7 @@ "\nA BodyInit object or null to set request's body." ], "signature": [ - "string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined" + "string | ArrayBuffer | Blob | URLSearchParams | ArrayBufferView | FormData | ReadableStream | null | undefined" ], "source": { "path": "src/core/public/http/types.ts", @@ -1187,23 +1179,15 @@ "The original {@link HttpFetchOptionsWithPath} used to send this request." ], "signature": [ - "{ readonly path: string; readonly query?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + "Readonly<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" }, - " | 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", @@ -1221,7 +1205,7 @@ "Raw request sent to Kibana server." ], "signature": [ - "{ 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; }" + "Readonly" ], "source": { "path": "src/core/public/http/types.ts", @@ -1792,9 +1776,7 @@ "path": "src/core/public/http/types.ts", "lineNumber": 78 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -1812,23 +1794,7 @@ "path": "src/core/public/http/types.ts", "lineNumber": 83 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -1846,23 +1812,7 @@ "path": "src/core/public/http/types.ts", "lineNumber": 88 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -2226,13 +2176,7 @@ "\nSee {@link HttpSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "source": { "path": "src/core/public/http/types.ts", @@ -2611,9 +2555,9 @@ "matched route details" ], "signature": [ - "{ readonly path: string; readonly method: ", + "Readonly<{ path: string; method: ", "RecursiveReadonly", - "; readonly options: ", + "; options: ", "RecursiveReadonly", "<", { @@ -2623,7 +2567,7 @@ "section": "def-server.KibanaRequestRouteOptions", "text": "KibanaRequestRouteOptions" }, - ">; }" + ">; }>" ], "source": { "path": "src/core/server/http/router/request.ts", @@ -2641,7 +2585,13 @@ "\nReadonly copy of incoming request headers." ], "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; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } ], "source": { "path": "src/core/server/http/router/request.ts", @@ -3242,33 +3192,7 @@ "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 123 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -3293,9 +3217,7 @@ "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 129 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -3320,26 +3242,7 @@ "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 134 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -3516,70 +3419,19 @@ "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" ], "signature": [ - "(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" - }, - ") => { status: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" - }, - "; state: T; }" + "section": "def-server.GetAuthState", + "text": "GetAuthState" + } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 51 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -3591,62 +3443,19 @@ "\nReturns authentication status for a request.\n{@link IsAuthenticated}" ], "signature": [ - "(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" - }, - ") => boolean" + "section": "def-server.IsAuthenticated", + "text": "IsAuthenticated" + } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 56 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -3676,9 +3485,13 @@ "HTTP message to send to the client" ], "signature": [ - "string | Record | Buffer | ", - "Stream", - " | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponsePayload", + "text": "HttpResponsePayload" + } ], "source": { "path": "src/core/server/http/router/response.ts", @@ -3853,33 +3666,7 @@ "path": "src/core/server/http/types.ts", "lineNumber": 136 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -3905,183 +3692,42 @@ "path": "src/core/server/http/types.ts", "lineNumber": 150 }, - "deprecated": false, - "returnComment": [], - "children": [ + "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: ", { - "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 - } - ] + "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.registerOnPreAuth", + "id": "def-server.HttpServiceSetup.registerAuth", "type": "Function", "tags": [], - "label": "registerOnPreAuth", + "label": "registerAuth", "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" + "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" ], "signature": [ "(handler: ", @@ -4089,192 +3735,51 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthHandler", - "text": "OnPreAuthHandler" + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 162 + "lineNumber": 174 }, - "deprecated": false, - "returnComment": [], - "children": [ + "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: ", { - "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 - } - ] + "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 }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerAuth", + "id": "def-server.HttpServiceSetup.registerOnPreResponse", "type": "Function", "tags": [], - "label": "registerAuth", + "label": "registerOnPreResponse", "description": [ - "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" + "\nTo define custom logic to perform for the server response.\n" ], "signature": [ "(handler: ", @@ -4282,591 +3787,78 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthenticationHandler", - "text": "AuthenticationHandler" + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 174 + "lineNumber": 198 }, - "deprecated": false, - "returnComment": [], - "children": [ + "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<", { - "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 - } - ] + "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.registerOnPostAuth", - "type": "Function", - "tags": [], - "label": "registerOnPostAuth", + "id": "def-server.HttpServiceSetup.auth", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "auth", "description": [ - "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" + "\nAuth status.\nSee {@link HttpAuth}\n" ], "signature": [ - "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthHandler", - "text": "OnPostAuthHandler" - }, - ") => void" + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 186 + "lineNumber": 212 }, - "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 - } - ] + "deprecated": true, + "references": [] }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreResponse", - "type": "Function", + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", "tags": [], - "label": "registerOnPreResponse", + "label": "csp", "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." + "\nThe CSP config used for Kibana." ], "signature": [ { @@ -4923,9 +3915,7 @@ "path": "src/core/server/http/types.ts", "lineNumber": 234 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", @@ -4966,224 +3956,7 @@ "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 - } - ] + "deprecated": false }, { "parentPluginId": "core", @@ -5208,9 +3981,7 @@ "path": "src/core/server/http/types.ts", "lineNumber": 277 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -5238,39 +4009,15 @@ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], "signature": [ - "{ remove: (path: string) => string; get: (request: ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.BasePath", + "text": "BasePath" }, - " | ", - { - "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; }" + ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" ], "source": { "path": "src/core/server/http/types.ts", @@ -5325,9 +4072,7 @@ "path": "src/core/server/http/types.ts", "lineNumber": 326 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -5743,5838 +4488,1559 @@ "\nRegister a route handler for `GET` request." ], "signature": [ - "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + "<\"get\", Context>" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 73 + }, + "deprecated": false + }, + { + "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.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", + "<\"post\", Context>" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 80 + }, + "deprecated": false + }, + { + "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.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" }, - ") => ", - "KibanaResponse", - "<", + "<\"put\", Context>" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 87 + }, + "deprecated": false + }, + { + "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.ResponseError", - "text": "ResponseError" + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" }, - ">; unauthorized: (options?: ", + "<\"patch\", Context>" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 94 + }, + "deprecated": false + }, + { + "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.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" }, - ") => ", - "KibanaResponse", - "<", + "<\"delete\", Context>" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 101 + }, + "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": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; forbidden: (options?: ", + "section": "def-server.RequestHandlerWrapper", + "text": "RequestHandlerWrapper" + } + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 107 + }, + "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": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "section": "def-server.KibanaRequestRouteOptions", + "text": "KibanaRequestRouteOptions" }, - ") => ", - "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" - ], - "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": [ - "\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 - }, - { - "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/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", - "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.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, - "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.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, - "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.RouteValidatorConfig", - "type": "Interface", - "tags": [], - "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/router/validator/validator.ts", - "lineNumber": 87 - }, - "deprecated": false, - "children": [ - { - "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 - }, - { - "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 - }, - { - "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" - ], - "source": { - "path": "src/core/server/http/router/validator/validator.ts", - "lineNumber": 110 - }, - "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", - "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.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 - }, - { - "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.SessionStorage", - "text": "SessionStorage" - }, - "" - ], - "source": { - "path": "src/core/server/http/session_storage.ts", - "lineNumber": 14 - }, - "deprecated": false, - "children": [ - { - "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": [] - }, - { - "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": [] - }, - { - "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.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": "name", - "description": [ - "\nName of the session cookie." - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 24 - }, - "deprecated": false - }, - { - "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 - }, - { - "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, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.sessionValue", - "type": "CompoundType", - "tags": [], - "label": "sessionValue", - "description": [], - "signature": [ - "T | T[]" - ], - "source": { - "path": "src/core/server/http/cookie_session_storage.ts", - "lineNumber": 32 - }, - "deprecated": false - } - ] - }, - { - "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 - }, - { - "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 - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "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": "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", - "type": "Type", - "tags": [], - "label": "AuthenticationHandler", - "description": [ - "\nSee {@link AuthToolkit}." - ], - "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" - }, - " | ", + "" + ], + "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.Authenticated", - "text": "Authenticated" + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" }, - " | ", + " extends ", + "Request" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 84 + }, + "deprecated": true, + "references": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthNotHandled", - "text": "AuthNotHandled" + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/saved_objects/index.ts", + "lineNumber": 8 + } }, - " | ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - }, - ">" + "plugin": "security", + "link": { + "path": "x-pack/plugins/security/server/saved_objects/index.ts", + "lineNumber": 34 + } + } ], - "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 147 - }, - "deprecated": false, + "children": [], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.AuthHeaders", - "type": "Type", + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", "tags": [], - "label": "AuthHeaders", - "description": [ - "\nAuth Headers map" - ], - "signature": [ - "{ [x: string]: string | string[]; }" - ], + "label": "OnPostAuthToolkit", + "description": [], "source": { - "path": "src/core/server/http/lifecycle/auth.ts", - "lineNumber": 82 + "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 + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.AuthResult", - "type": "Type", + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", "tags": [], - "label": "AuthResult", + "label": "OnPreAuthToolkit", "description": [], - "signature": [ - { - "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": 44 + "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 + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.DestructiveRouteMethod", - "type": "Type", + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", "tags": [], - "label": "DestructiveRouteMethod", + "label": "OnPreResponseExtensions", "description": [ - "\nSet of HTTP methods changing the state of the server." - ], - "signature": [ - "\"post\" | \"put\" | \"delete\" | \"patch\"" + "\nAdditional data to extend a response." ], "source": { - "path": "src/core/server/http/router/route.ts", - "lineNumber": 19 + "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.GetAuthHeaders", - "type": "Type", - "tags": [ - "return" - ], - "label": "GetAuthHeaders", + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "tags": [], + "label": "OnPreResponseInfo", "description": [ - "\nGet headers to authenticate a user against Elasticsearch." - ], - "signature": [ - "(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" - }, - ") => Record | undefined" + "\nResponse status code." ], "source": { - "path": "src/core/server/http/auth_headers_storage.ts", - "lineNumber": 18 + "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.GetAuthState", - "type": "Type", + "id": "def-server.OnPreResponseRender", + "type": "Interface", "tags": [], - "label": "GetAuthState", + "label": "OnPreResponseRender", "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor." + "\nAdditional data to extend a response when rendering a new body" ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | ", + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 45 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" + "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 }, - ") => { status: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" - }, - "; state: T; }" + "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 + } ], - "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 35 - }, - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.Headers", - "type": "Type", + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", "tags": [], - "label": "Headers", + "label": "OnPreResponseToolkit", "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; }" + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." ], "source": { - "path": "src/core/server/http/router/headers.ts", - "lineNumber": 40 + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 88 }, "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": [ - "string | Record | Buffer | ", - "Stream", - " | undefined" + "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 + }, + { + "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 + } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 73 - }, - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IBasePath", - "type": "Type", + "id": "def-server.OnPreRoutingToolkit", + "type": "Interface", "tags": [], - "label": "IBasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" - ], - "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; }" - ], + "label": "OnPreRoutingToolkit", + "description": [], "source": { - "path": "src/core/server/http/base_path_service.ts", - "lineNumber": 104 + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 55 }, "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IsAuthenticated", - "type": "Type", - "tags": [], - "label": "IsAuthenticated", - "description": [ - "\nReturns authentication status for a request." - ], - "signature": [ - "(request: ", + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "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.LegacyRequest", - "text": "LegacyRequest" - }, - ") => boolean" + "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 + } ], - "source": { - "path": "src/core/server/http/auth_state_storage.ts", - "lineNumber": 44 - }, - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KibanaRequestRouteOptions", - "type": "Type", + "id": "def-server.RouteConfig", + "type": "Interface", "tags": [], - "label": "KibanaRequestRouteOptions", + "label": "RouteConfig", "description": [ - "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + "\nRoute specific configuration." ], "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" + "section": "def-server.RouteConfig", + "text": "RouteConfig" }, - ">" + "" ], "source": { - "path": "src/core/server/http/router/request.ts", - "lineNumber": 44 + "path": "src/core/server/http/router/route.ts", + "lineNumber": 157 }, "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaResponseFactory", - "type": "Type", - "tags": [], - "label": "KibanaResponseFactory", - "description": [ - "\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?: ", + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - "<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "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 }, - ">; notFound: (options?: ", { - "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" + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" }, - ">; conflict: (options?: ", + "" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 106 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - "<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "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 }, - ">; customError: (options: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "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.ResponseError", - "text": "ResponseError" + "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 }, - ">) => ", - "KibanaResponse", - "<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; redirected: (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 + } + ], + "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": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; ok: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; accepted: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; noContent: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }" + "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 + } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 323 - }, - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.KnownHeaders", - "type": "Type", + "id": "def-server.RouteValidationResultFactory", + "type": "Interface", "tags": [], - "label": "KnownHeaders", + "label": "RouteValidationResultFactory", "description": [ - "\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\"" + "\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/headers.ts", - "lineNumber": 34 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 20 }, "deprecated": false, + "children": [ + { + "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 + }, + { + "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 + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.LifecycleResponseFactory", - "type": "Type", + "id": "def-server.RouteValidatorConfig", + "type": "Interface", "tags": [], - "label": "LifecycleResponseFactory", + "label": "RouteValidatorConfig", "description": [ - "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." + "\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": [ - "{ 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" + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" }, - "<", + "" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 87 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "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 }, - ">) => ", - "KibanaResponse", - "<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "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 }, - ">; redirected: (options: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }" + "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" ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 329 + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 110 }, "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.OnPostAuthHandler", - "type": "Type", + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", "tags": [], - "label": "OnPostAuthHandler", + "label": "SessionCookieValidationResult", "description": [ - "\nSee {@link OnPostAuthToolkit}." + "\nReturn type from a function to validate cookie contents." ], - "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: ", + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 48 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthToolkit", - "text": "OnPostAuthToolkit" - }, - ") => ", - "KibanaResponse", - " | Next | Promise<", - "KibanaResponse", - " | Next>" + "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 + } ], - "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", + "id": "def-server.SessionStorage", + "type": "Interface", "tags": [], - "label": "OnPreAuthHandler", + "label": "SessionStorage", "description": [ - "\nSee {@link OnPreAuthToolkit}." + "\nProvides an interface to store and retrieve data across requests." ], "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" + "section": "def-server.SessionStorage", + "text": "SessionStorage" }, - ">) => ", - "KibanaResponse", - "<", + "" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 14 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "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": [] }, - ">; redirected: (options: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "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": [] }, - ") => ", - "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/lifecycle/on_pre_auth.ts", - "lineNumber": 55 - }, - "deprecated": false, + "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.OnPreResponseHandler", - "type": "Type", + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", "tags": [], - "label": "OnPreResponseHandler", + "label": "SessionStorageCookieOptions", "description": [ - "\nSee {@link OnPreRoutingToolkit}." + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." ], "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" + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" }, - ") => Render | Next | Promise" + "" ], "source": { - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "lineNumber": 104 + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 20 }, "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler", - "type": "Type", - "tags": [], - "label": "OnPreRoutingHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "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: ", + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "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.ResponseError", - "text": "ResponseError" + "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 }, - ">) => ", - "KibanaResponse", - "<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "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 }, - ">; redirected: (options: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "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 }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingToolkit", - "text": "OnPreRoutingToolkit" - }, - ") => Next | RewriteUrl | ", - "KibanaResponse", - " | Promise>" + "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 + } ], - "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", + "id": "def-server.SessionStorageFactory", + "type": "Interface", "tags": [], - "label": "RedirectResponseOptions", + "label": "SessionStorageFactory", "description": [ - "\nHTTP response parameters for redirection response" + "\nSessionStorage factory to bind one to an incoming request" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" }, - " & { headers: { location: string; }; }" + "" ], "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 93 + "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 + } + ], "initialIsOpen": false - }, + } + ], + "enums": [ { "parentPluginId": "core", - "id": "def-server.RequestHandler", - "type": "Type", + "id": "def-server.AuthResultType", + "type": "Enum", "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: ", - { - "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" - }, - ">" - ], + "label": "AuthResultType", + "description": [], "source": { - "path": "src/core/server/http/router/router.ts", - "lineNumber": 351 + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 22 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RequestHandlerContextContainer", - "type": "Type", + "id": "def-server.AuthStatus", + "type": "Enum", "tags": [], - "label": "RequestHandlerContextContainer", + "label": "AuthStatus", "description": [ - "\nAn object that handles registration of http request context providers." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } + "\nStatus indicating an outcome of the authentication." ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 30 + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 15 }, "deprecated": false, "initialIsOpen": false - }, + } + ], + "misc": [ { "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider", + "id": "def-server.AuthenticationHandler", "type": "Type", "tags": [], - "label": "RequestHandlerContextProvider", + "label": "AuthenticationHandler", "description": [ - "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" + "\nSee {@link AuthToolkit}." ], "signature": [ - "(context: Pick>, request: ", + "(request: ", { "pluginId": "core", "scope": "server", @@ -11582,19 +6048,7 @@ "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?: ", + ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", @@ -11619,217 +6073,368 @@ "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", - "<", + } + ], + "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": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.Authenticated", + "text": "Authenticated" }, - ">; customError: (options: ", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" }, - "<", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">) => ", - "KibanaResponse", - "<", + "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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ">; redirected: (options: ", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; ok: (options?: ", + ") => 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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; accepted: (options?: ", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; noContent: (options?: ", + ") => { status: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.AuthStatus", + "text": "AuthStatus" }, - ") => ", - "KibanaResponse", - "; }) => Context[ContextName] | Promise" + "; state: T; }" ], "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 38 + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 35 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper", + "id": "def-server.Headers", "type": "Type", "tags": [], - "label": "RequestHandlerWrapper", + "label": "Headers", "description": [ - "\nType-safe wrapper for {@link RequestHandler} function." + "\nHttp request headers to read." ], "signature": [ - " | 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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteMethod", - "text": "RouteMethod" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - " = any, ResponseFactory extends { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", + ") => boolean" + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRouteOptions", + "type": "Type", + "tags": [], + "label": "KibanaRequestRouteOptions", + "description": [ + "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + ], + "signature": [ + "Method extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" }, - ") => ", - "KibanaResponse", - "<", + " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required>" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 44 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaResponseFactory", + "type": "Type", + "tags": [], + "label": "KibanaResponseFactory", + "description": [ + "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." + ], + "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; }" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 323 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KnownHeaders", + "type": "Type", + "tags": [], + "label": "KnownHeaders", + "description": [ + "\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/headers.ts", + "lineNumber": 34 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.LifecycleResponseFactory", + "type": "Type", + "tags": [], + "label": "LifecycleResponseFactory", + "description": [ + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." + ], + "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>; }" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 329 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPostAuthHandler", + "description": [ + "\nSee {@link OnPostAuthToolkit}." + ], + "signature": [ + "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ">; unauthorized: (options?: ", + ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", @@ -11847,25 +6452,41 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - ">; forbidden: (options?: ", + ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", + } + ], + "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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ">; notFound: (options?: ", + ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", @@ -11883,109 +6504,84 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - ">; conflict: (options?: ", + ">; 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" - }, - ">; 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?: ", + } + ], + "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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; accepted: (options?: ", + ", preResponse: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; noContent: (options?: ", + ", toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" }, - ") => ", - "KibanaResponse", - "; } = { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + ") => 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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", + ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", @@ -12010,144 +6606,153 @@ "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" - }, - "<", + } + ], + "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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ">) => ", - "KibanaResponse", - "<", + ", response: ResponseFactory) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, - ">; redirected: (options: ", + " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; ok: (options?: ", + ">" + ], + "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: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ") => ", - "KibanaResponse", - " | Buffer | ", + ", response: { custom: | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", "Stream", - ">; accepted: (options?: ", + " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - ") => ", + ") => ", "KibanaResponse", - " | Buffer | ", - "Stream", - ">; noContent: (options?: ", + "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>(handler: ", + "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: ", { "pluginId": "core", "scope": "server", @@ -12277,7 +6882,7 @@ "\nRoute handler common definition\n" ], "signature": [ - "(route: ", + "(route: ", { "pluginId": "core", "scope": "server", @@ -12293,7 +6898,7 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + " | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", "Stream", " | undefined>(options: ", { @@ -12304,170 +6909,7 @@ "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" + "KibanaResponse" ], "source": { "path": "src/core/server/http/router/router.ts", @@ -12551,21 +6993,7 @@ "\nRoute validations config and options merged into one object" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorConfig", - "text": "RouteValidatorConfig" - }, - " & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorOptions", - "text": "RouteValidatorOptions" - } + "RouteValidatorConfig & RouteValidatorOptions" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", @@ -12668,7 +7096,7 @@ "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" ], "signature": [ - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + " | Error | Buffer | { message: string | Error; attributes?: Record | undefined; } | ", "Stream", " | undefined>(options: ", { diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index adf0612a28faf..8edf6fce295f6 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -161,9 +161,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], + "description": [], "signature": [ { "pluginId": "core", @@ -310,7 +308,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">) => Promise<", { "pluginId": "core", "scope": "public", @@ -342,7 +340,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">" ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", @@ -453,9 +451,7 @@ "type": "Array", "tags": [], "label": "objects", - "description": [ - "- an array ids, or an array of objects containing id and optionally type" - ], + "description": [], "signature": [ "{ id: string; type: string; }[]" ], @@ -1539,113 +1535,15 @@ "{@link SavedObjectsClient}" ], "signature": [ - "{ 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<", + "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" }, - ">; }" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ], "source": { "path": "src/core/public/saved_objects/saved_objects_service.ts", @@ -1744,113 +1642,7 @@ "\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n" ], "signature": [ - "{ 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" - }, - ">; }" + "{ 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>; }" ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", @@ -3102,7 +2894,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">, dependencies?: ", { "pluginId": "core", "scope": "server", @@ -3142,7 +2934,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">" + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", @@ -3422,8 +3214,15 @@ "label": "isSavedObjectsClientError", "description": [], "signature": [ - "(error: any) => error is ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isSavedObjectsClientError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3459,8 +3258,15 @@ "label": "decorateBadRequestError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateBadRequestError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3513,8 +3319,15 @@ "label": "createBadRequestError", "description": [], "signature": [ - "(reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createBadRequestError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3550,8 +3363,15 @@ "label": "createUnsupportedTypeError", "description": [], "signature": [ - "(type: string) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createUnsupportedTypeError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3587,9 +3407,15 @@ "label": "isBadRequestError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isBadRequestError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3626,8 +3452,15 @@ "label": "createInvalidVersionError", "description": [], "signature": [ - "(versionInput?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createInvalidVersionError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3663,9 +3496,15 @@ "label": "isInvalidVersionError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isInvalidVersionError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3702,8 +3541,15 @@ "label": "decorateNotAuthorizedError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateNotAuthorizedError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3756,10 +3602,16 @@ "label": "isNotAuthorizedError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" - ], + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isNotAuthorizedError" + ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", "lineNumber": 112 @@ -3795,8 +3647,15 @@ "label": "decorateForbiddenError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateForbiddenError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3849,9 +3708,15 @@ "label": "isForbiddenError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isForbiddenError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3888,8 +3753,15 @@ "label": "decorateRequestEntityTooLargeError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateRequestEntityTooLargeError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3942,9 +3814,15 @@ "label": "isRequestEntityTooLargeError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isRequestEntityTooLargeError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -3981,8 +3859,15 @@ "label": "createGenericNotFoundError", "description": [], "signature": [ - "(type?: string | null, id?: string | null) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createGenericNotFoundError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4035,8 +3920,15 @@ "label": "createIndexAliasNotFoundError", "description": [], "signature": [ - "(alias: string) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createIndexAliasNotFoundError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4072,8 +3964,15 @@ "label": "decorateIndexAliasNotFoundError", "description": [], "signature": [ - "(error: Error, alias: string) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateIndexAliasNotFoundError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4126,9 +4025,15 @@ "label": "isNotFoundError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isNotFoundError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4165,8 +4070,15 @@ "label": "decorateConflictError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateConflictError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4219,8 +4131,15 @@ "label": "createConflictError", "description": [], "signature": [ - "(type: string, id: string, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createConflictError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4290,9 +4209,15 @@ "label": "isConflictError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isConflictError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4329,8 +4254,15 @@ "label": "decorateTooManyRequestsError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateTooManyRequestsError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4383,8 +4315,15 @@ "label": "createTooManyRequestsError", "description": [], "signature": [ - "(type: string, id: string) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createTooManyRequestsError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4437,9 +4376,15 @@ "label": "isTooManyRequestsError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isTooManyRequestsError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4476,8 +4421,15 @@ "label": "decorateEsCannotExecuteScriptError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateEsCannotExecuteScriptError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4530,9 +4482,15 @@ "label": "isEsCannotExecuteScriptError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isEsCannotExecuteScriptError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4569,8 +4527,15 @@ "label": "decorateEsUnavailableError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateEsUnavailableError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4623,9 +4588,15 @@ "label": "isEsUnavailableError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isEsUnavailableError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4662,8 +4633,15 @@ "label": "decorateGeneralError", "description": [], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateGeneralError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4716,9 +4694,15 @@ "label": "isGeneralError", "description": [], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isGeneralError" ], "source": { "path": "src/core/server/saved_objects/service/lib/errors.ts", @@ -4759,7 +4743,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 36 + "lineNumber": 35 }, "deprecated": false, "children": [ @@ -4771,307 +4755,39 @@ "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?: ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - "[], options?: ", + ", \"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<", - { - "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", @@ -5079,30 +4795,6 @@ }, "deprecated": false }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportTransforms", - "type": "Object", - "tags": [], - "label": "#exportTransforms", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportTransform", - "text": "SavedObjectsExportTransform" - }, - "; }" - ], - "source": { - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 38 - }, - "deprecated": false - }, { "parentPluginId": "core", "id": "def-server.SavedObjectsExporter.exportSizeLimit", @@ -5112,7 +4804,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 39 + "lineNumber": 38 }, "deprecated": false }, @@ -5128,7 +4820,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 40 + "lineNumber": 39 }, "deprecated": false }, @@ -5144,7 +4836,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 42 + "lineNumber": 41 }, "deprecated": false, "children": [ @@ -5157,7 +4849,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 47 + "lineNumber": 46 }, "deprecated": false, "children": [ @@ -5169,311 +4861,19 @@ "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?: ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - " | 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" - }, - "; }" + ", \"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": 48 + "lineNumber": 47 }, "deprecated": false }, @@ -5485,43 +4885,19 @@ "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: () => ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" }, - "[]; 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\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 49 + "lineNumber": 48 }, "deprecated": false }, @@ -5534,7 +4910,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 50 + "lineNumber": 49 }, "deprecated": false }, @@ -5550,7 +4926,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 51 + "lineNumber": 50 }, "deprecated": false } @@ -5585,7 +4961,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 74 + "lineNumber": 73 }, "deprecated": false, "children": [ @@ -5607,7 +4983,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 74 + "lineNumber": 73 }, "deprecated": false, "isRequired": true @@ -5641,7 +5017,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 93 + "lineNumber": 92 }, "deprecated": false, "children": [ @@ -5663,7 +5039,7 @@ ], "source": { "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "lineNumber": 93 + "lineNumber": 92 }, "deprecated": false, "isRequired": true @@ -5775,14 +5151,15 @@ "label": "exportSizeExceeded", "description": [], "signature": [ - "(limit: number) => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsExportError", "text": "SavedObjectsExportError" - } + }, + ".exportSizeExceeded" ], "source": { "path": "src/core/server/saved_objects/export/errors.ts", @@ -5818,16 +5195,15 @@ "label": "objectFetchError", "description": [], "signature": [ - "(objects: ", - "SavedObject", - "[]) => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsExportError", "text": "SavedObjectsExportError" - } + }, + ".objectFetchError" ], "source": { "path": "src/core/server/saved_objects/export/errors.ts", @@ -5866,16 +5242,15 @@ "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" ], "signature": [ - "(objects: ", - "SavedObject", - "[], cause: Error) => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsExportError", "text": "SavedObjectsExportError" - } + }, + ".objectTransformError" ], "source": { "path": "src/core/server/saved_objects/export/errors.ts", @@ -5931,14 +5306,15 @@ "\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": [ - "(objectKeys: string[]) => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsExportError", "text": "SavedObjectsExportError" - } + }, + ".invalidTransformError" ], "source": { "path": "src/core/server/saved_objects/export/errors.ts", @@ -5990,259 +5366,779 @@ "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?: ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", + ", \"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": 30 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.typeRegistry", + "type": "Object", + "tags": [], + "label": "#typeRegistry", + "description": [], + "signature": [ + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" }, - "[], 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?: ", + ", \"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 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.importSizeLimit", + "type": "number", + "tags": [], + "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": [ + "Record Promise<", + "[]>" + ], + "source": { + "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": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; find: (options: ", + "parentPluginId": "core", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit", + "type": "Object", + "tags": [], + "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "description": [], + "source": { + "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": [ + "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/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<", + { + "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/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.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" }, - ">; bulkGet: (objects?: ", + ">" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", + "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.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" }, ") => 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" + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" }, - ") => Promise<", + ">" + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88 + }, + "deprecated": false, + "children": [ { - "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.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": [ + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - ") => Promise<", + ".importSizeExceeded" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", + "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": [ + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - "[], options?: ", + ".nonUniqueImportObjects" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", + "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": [ + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - ">; updateObjectsSpaces: (objects: ", + ".nonUniqueRetryObjects" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + "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": [ + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - " | undefined) => Promise<", + ".nonUniqueRetryDestinations" + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", + "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": [ + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", + ".referencesFetchError" + ], + "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.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" + "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 }, - ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "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.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - " | undefined) => Promise<", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - ">; openPointInTimeForType: (type: string | string[], options?: ", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" }, - ") => Promise<", + ">" + ], + "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.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" }, - ">; closePointInTime: (id: string, options?: ", + "[], options?: ", { "pluginId": "core", "scope": "server", @@ -6250,971 +6146,635 @@ "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, - " | undefined) => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" }, - ">; 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) => ", + ">" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 548 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" + "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 }, - "; errors: typeof ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "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 + } ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 30 - }, - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.typeRegistry", - "type": "Object", - "tags": [], - "label": "#typeRegistry", - "description": [], + "id": "def-server.SavedObjectsRepository.delete", + "type": "Function", + "tags": [ + "property" + ], + "label": "delete", + "description": [ + "\nDeletes an object\n" + ], "signature": [ - "{ getType: (type: string) => ", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, - " | undefined; getVisibleTypes: () => ", + ") => Promise<{}>" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 635 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "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 }, - "[]; getAllTypes: () => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "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 }, - "[]; 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; }" + "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 + } ], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 31 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.importSizeLimit", - "type": "number", - "tags": [], - "label": "#importSizeLimit", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 32 - }, - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.importHooks", - "type": "Object", + "id": "def-server.SavedObjectsRepository.deleteByNamespace", + "type": "Function", "tags": [], - "label": "#importHooks", - "description": [], + "label": "deleteByNamespace", + "description": [ + "\nDeletes all objects from the provided namespace.\n" + ], "signature": [ - "{ [x: string]: ", + "(namespace: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportHook", - "text": "SavedObjectsImportHook" + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" }, - "[]; }" - ], - "source": { - "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" + ") => Promise" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 35 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 697 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit", - "type": "Object", + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", + "type": "string", "tags": [], - "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "label": "namespace", "description": [], + "signature": [ + "string" + ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 39 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 698 }, "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 - }, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ { - "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 + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" } - ] - } - ], - "returnComment": [] + ], + "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.SavedObjectsImporter.import", + "id": "def-server.SavedObjectsRepository.find", "type": "Function", "tags": [ - "throws" - ], - "label": "import", - "description": [ - "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" ], + "label": "find", + "description": [], "signature": [ - "({ readStream, createNewCopies, namespace, overwrite, }: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, - ">" + ">" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 64 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 759 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.import.$1", + "id": "def-server.SavedObjectsRepository.find.$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.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" } ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 64 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 760 }, "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.resolveImportErrors", + "id": "def-server.SavedObjectsRepository.bulkGet", "type": "Function", "tags": [ - "throws" + "property" ], - "label": "resolveImportErrors", + "label": "bulkGet", "description": [ - "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" + "\nReturns an array of objects by id\n" ], "signature": [ - "({ readStream, createNewCopies, namespace, retries, }: ", + "(objects?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" + "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.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" }, - ">" + ">" ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 926 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.resolveImportErrors.$1", + "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": "{\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.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" } ], "source": { - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 928 }, "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" + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }] }" + ] }, - " extends Error" - ], - "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 14 - }, - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.importSizeExceeded", + "id": "def-server.SavedObjectsRepository.get", "type": "Function", - "tags": [], - "label": "importSizeExceeded", - "description": [], + "tags": [ + "property" + ], + "label": "get", + "description": [ + "\nGets a single object\n" + ], "signature": [ - "(limit: number) => ", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - } + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 27 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1013 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", - "type": "number", + "id": "def-server.SavedObjectsRepository.get.$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/service/lib/repository.ts", + "lineNumber": 1014 }, "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", + "id": "def-server.SavedObjectsRepository.get.$2", + "type": "string", "tags": [], - "label": "nonUniqueEntries", + "label": "id", "description": [], "signature": [ - "string[]" + "string" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 34 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1015 }, "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", + "id": "def-server.SavedObjectsRepository.get.$3", + "type": "Object", "tags": [], - "label": "nonUniqueRetryObjects", + "label": "options", "description": [], "signature": [ - "string[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1016 }, "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "- { id, type, version, attributes }" + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", + "id": "def-server.SavedObjectsRepository.resolve", "type": "Function", - "tags": [], - "label": "nonUniqueRetryDestinations", - "description": [], + "tags": [ + "property" + ], + "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], "signature": [ - "(nonUniqueRetryDestinations: string[]) => ", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - } + "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/import/errors.ts", - "lineNumber": 48 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1055 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", - "type": "Array", + "id": "def-server.SavedObjectsRepository.resolve.$1", + "type": "string", "tags": [], - "label": "nonUniqueRetryDestinations", + "label": "type", "description": [], "signature": [ - "string[]" + "string" ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 48 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1056 }, "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.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.SavedObjectsImportError.referencesFetchError.$1", - "type": "Array", + "id": "def-server.SavedObjectsRepository.resolve.$3", + "type": "Object", "tags": [], - "label": "objects", + "label": "options", "description": [], "signature": [ - "SavedObject", - "[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/import/errors.ts", - "lineNumber": 55 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1058 }, "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": [ + "returnComment": [ + "- { saved_object, outcome }" + ] + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create", + "id": "def-server.SavedObjectsRepository.update", "type": "Function", "tags": [ - "property", - "property", "property", "property", "property" ], - "label": "create", + "label": "update", "description": [ - "\nPersists an object\n" + "\nUpdates an object\n" ], "signature": [ - "(type: string, attributes: T, options?: ", + "(type: string, id: string, attributes: Partial, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" }, - ") => Promise<", - "SavedObject", ">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 269 + "lineNumber": 1185 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$1", + "id": "def-server.SavedObjectsRepository.update.$1", "type": "string", "tags": [], "label": "type", @@ -7224,31 +6784,48 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 270 + "lineNumber": 1186 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$2", - "type": "Uncategorized", + "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": [ - "T" + "Partial" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 271 + "lineNumber": 1188 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$3", + "id": "def-server.SavedObjectsRepository.update.$4", "type": "Object", "tags": [], "label": "options", @@ -7258,96 +6835,92 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 272 + "lineNumber": 1189 }, "deprecated": false, "isRequired": true } ], - "returnComment": [ - "- { id, type, version, attributes }" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences", "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "bulkCreate", + "tags": [], + "label": "collectMultiNamespaceReferences", "description": [ - "\nCreates multiple documents at once\n" + "\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: ", + "(objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" }, - "[], options?: ", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" }, - ") => Promise<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" }, - ">" + ">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 362 + "lineNumber": 1283 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate.$1", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1", "type": "Array", "tags": [], "label": "objects", "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" + "The objects to get the references for." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" }, - "[]" + "[]" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 363 + "lineNumber": 1284 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate.$2", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2", "type": "Object", "tags": [], "label": "options", @@ -7357,67 +6930,66 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 364 + "lineNumber": 1285 }, "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces", "type": "Function", "tags": [], - "label": "checkConflicts", + "label": "updateObjectsSpaces", "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." + "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" ], "signature": [ - "(objects?: ", + "(objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" }, - "[], options?: ", + "[], 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.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" }, ">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 548 + "lineNumber": 1307 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts.$1", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1", "type": "Array", "tags": [], "label": "objects", @@ -7427,21 +6999,55 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" }, "[]" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 549 + "lineNumber": 1308 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts.$2", + "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", @@ -7451,85 +7057,95 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 550 + "lineNumber": 1311 }, "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete", + "id": "def-server.SavedObjectsRepository.bulkUpdate", "type": "Function", "tags": [ + "property", "property" ], - "label": "delete", + "label": "bulkUpdate", "description": [ - "\nDeletes an object\n" + "\nUpdates multiple objects in bulk\n" ], "signature": [ - "(type: string, id: string, options?: ", + "(objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" }, - ") => Promise<{}>" + "[], 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": 635 + "lineNumber": 1334 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$1", - "type": "string", + "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", + "type": "Array", "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" ], - "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" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 635 + "lineNumber": 1335 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$3", + "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", "type": "Object", "tags": [], "label": "options", @@ -7539,141 +7155,93 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" } ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 635 + "lineNumber": 1336 }, "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace", + "id": "def-server.SavedObjectsRepository.removeReferencesTo", "type": "Function", "tags": [], - "label": "deleteByNamespace", + "label": "removeReferencesTo", "description": [ - "\nDeletes all objects from the provided namespace.\n" + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" ], "signature": [ - "(namespace: string, options?: ", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" }, - ") => Promise" + ") => 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": 697 + "lineNumber": 1551 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", "type": "string", "tags": [], - "label": "namespace", + "label": "type", "description": [], "signature": [ "string" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 698 + "lineNumber": 1552 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", - "type": "Object", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$2", + "type": "string", "tags": [], - "label": "options", + "label": "id", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - } + "string" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 699 + "lineNumber": 1553 }, "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", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", "type": "Object", "tags": [], "label": "options", @@ -7683,225 +7251,245 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" } ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 760 + "lineNumber": 1554 }, "deprecated": false, "isRequired": true } ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet", + "id": "def-server.SavedObjectsRepository.incrementCounter", "type": "Function", - "tags": [ - "property" - ], - "label": "bulkGet", + "tags": [], + "label": "incrementCounter", "description": [ - "\nReturns an array of objects by id\n" + "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" ], "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", + "(type: string, id: string, counterFields: (string | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" }, - ") => Promise<", + ")[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" }, + ") => Promise<", + "SavedObject", ">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 926 + "lineNumber": 1662 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet.$1", + "id": "def-server.SavedObjectsRepository.incrementCounter.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of saved object whose fields should be incremented" + ], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1663 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.incrementCounter.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The id of the document whose fields should be incremented" + ], + "signature": [ + "string" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1664 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.incrementCounter.$3", "type": "Array", "tags": [], - "label": "objects", + "label": "counterFields", "description": [ - "- an array of objects containing id, type and optionally fields" + "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}" ], "signature": [ + "(string | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" }, - "[]" + ")[]" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 927 + "lineNumber": 1665 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet.$2", + "id": "def-server.SavedObjectsRepository.incrementCounter.$4", "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- {@link SavedObjectsIncrementCounterOptions}" + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + "" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 928 + "lineNumber": 1666 }, "deprecated": false, "isRequired": true } ], "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }] }" + "The saved object after the specified fields were incremented" ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType", "type": "Function", "tags": [ + "property", "property" ], - "label": "get", + "label": "openPointInTimeForType", "description": [ - "\nGets a single object\n" + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" ], "signature": [ - "(type: string, id: string, options?: ", + "(type: string | string[], { keepAlive, preference }?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" }, ") => Promise<", - "SavedObject", - ">" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1013 + "lineNumber": 1822 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$1", - "type": "string", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1", + "type": "CompoundType", "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" + "string | string[]" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1015 + "lineNumber": 1823 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$3", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2", "type": "Object", "tags": [], - "label": "options", + "label": "{ keepAlive = '5m', preference }", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" } ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1016 + "lineNumber": 1824 }, "deprecated": false, "isRequired": true } ], "returnComment": [ - "- { id, type, version, attributes }" + "- { id: string }" ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve", + "id": "def-server.SavedObjectsRepository.closePointInTime", "type": "Function", - "tags": [ - "property" - ], - "label": "resolve", + "tags": [], + "label": "closePointInTime", "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" ], "signature": [ - "(type: string, id: string, options?: ", + "(id: string, options?: ", { "pluginId": "core", "scope": "server", @@ -7909,63 +7497,48 @@ "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, - ") => Promise<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" }, - ">" + ">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1055 + "lineNumber": 1895 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$1", + "id": "def-server.SavedObjectsRepository.closePointInTime.$1", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "signature": [ "string" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1056 + "lineNumber": 1896 }, "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", + "id": "def-server.SavedObjectsRepository.closePointInTime.$2", "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- {@link SavedObjectsClosePointInTimeOptions}" + ], "signature": [ { "pluginId": "core", @@ -7973,544 +7546,448 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" - } + }, + " | undefined" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1058 + "lineNumber": 1897 }, "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ - "- { saved_object, outcome }" + "- {@link SavedObjectsClosePointInTimeResponse}" ] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update", + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder", "type": "Function", - "tags": [ - "property", - "property", - "property" - ], - "label": "update", + "tags": [], + "label": "createPointInTimeFinder", "description": [ - "\nUpdates an object\n" + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" ], "signature": [ - "(type: string, id: string, attributes: Partial, options?: ", + "(findOptions: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, - ") => Promise<", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">, dependencies?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" }, - ">" + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1185 + "lineNumber": 1951 }, "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", + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1", "type": "Object", "tags": [], - "label": "attributes", + "label": "findOptions", "description": [], "signature": [ - "Partial" + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\">" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1188 + "lineNumber": 1952 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$4", + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", "type": "Object", "tags": [], - "label": "options", + "label": "dependencies", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" }, - "" + " | undefined" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1189 + "lineNumber": 1953 }, "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsSerializer", + "type": "Class", + "tags": [], + "label": "SavedObjectsSerializer", + "description": [ + "\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 26 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences", + "id": "def-server.SavedObjectsSerializer.isRawSavedObject", "type": "Function", "tags": [], - "label": "collectMultiNamespaceReferences", + "label": "isRawSavedObject", "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" + "\nDetermines whether or not the raw document can be converted to a saved object.\n" ], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", + "(doc: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" }, - " | undefined) => Promise<", + ", options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" }, - ">" + ") => boolean" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1283 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1", - "type": "Array", + "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1", + "type": "Object", "tags": [], - "label": "objects", + "label": "doc", "description": [ - "The objects to get the references for." + "- The raw ES document to be tested" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[]" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1284 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2", + "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2", "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- Options for parsing the raw document." + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined" + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1285 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 }, "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject", "type": "Function", "tags": [], - "label": "updateObjectsSpaces", + "label": "rawToSavedObject", "description": [ - "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" ], "signature": [ - "(objects: ", + "(doc: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + ", options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" }, - " | undefined) => Promise<", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" }, - ">" + "" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1307 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 79 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1", - "type": "Array", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1", + "type": "Object", "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[]" + "label": "doc", + "description": [ + "- The raw ES document to be converted to saved object format." ], - "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[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1310 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 80 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$4", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2", "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- Options for parsing the raw document." + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined" + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1311 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 81 }, "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate", + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "bulkUpdate", + "tags": [], + "label": "savedObjectToRaw", "description": [ - "\nUpdates multiple objects in bulk\n" + "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" ], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", + "(savedObj: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" }, - ") => Promise<", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1334 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 125 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", - "type": "Array", + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1", + "type": "CompoundType", "tags": [], - "label": "objects", + "label": "savedObj", "description": [ - "- [{ type, id, attributes, options: { version, namespace } references }]" + "- The saved object to be converted to raw ES format." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" }, - "[]" - ], - "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 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 125 }, "deprecated": false, "isRequired": true } ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo", + "id": "def-server.SavedObjectsSerializer.generateRawId", "type": "Function", "tags": [], - "label": "removeReferencesTo", + "label": "generateRawId", "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + "\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\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" - }, - ">" + "(namespace: string | undefined, type: string, id: string) => string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1551 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 166 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", + "id": "def-server.SavedObjectsSerializer.generateRawId.$1", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "namespace", + "description": [ + "- The namespace of the saved object" + ], "signature": [ - "string" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1552 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 166 }, "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$2", + "id": "def-server.SavedObjectsSerializer.generateRawId.$2", "type": "string", "tags": [], - "label": "id", - "description": [], + "label": "type", + "description": [ + "- The saved object type" + ], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1553 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 166 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", - "type": "Object", + "id": "def-server.SavedObjectsSerializer.generateRawId.$3", + "type": "string", "tags": [], - "label": "options", - "description": [], + "label": "id", + "description": [ + "- The id of the saved object" + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - } + "string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1554 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 166 }, "deprecated": false, "isRequired": true @@ -8520,311 +7997,185 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", "type": "Function", "tags": [], - "label": "incrementCounter", + "label": "generateRawLegacyUrlAliasId", "description": [ - "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" + "\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n" ], "signature": [ - "(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", - ">" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1662 - }, - "deprecated": false, - "children": [ + "(namespace: string, type: string, id: string) => string" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 179 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$1", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1", "type": "string", "tags": [], - "label": "type", + "label": "namespace", "description": [ - "- The type of saved object whose fields should be incremented" + "- The namespace of the saved object" ], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1663 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 179 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$2", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2", "type": "string", "tags": [], - "label": "id", + "label": "type", "description": [ - "- The id of the document whose fields should be incremented" + "- The saved object type" ], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1664 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$3", - "type": "Array", - "tags": [], - "label": "counterFields", - "description": [ - "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}" - ], - "signature": [ - "(string | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" - }, - ")[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1665 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 179 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$4", - "type": "Object", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3", + "type": "string", "tags": [], - "label": "options", + "label": "id", "description": [ - "- {@link SavedObjectsIncrementCounterOptions}" + "- The id of the saved object" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" - }, - "" + "string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1666 + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 179 }, "deprecated": false, "isRequired": true } ], - "returnComment": [ - "The saved object after the specified fields were incremented" - ] - }, + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUtils", + "type": "Class", + "tags": [], + "label": "SavedObjectsUtils", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 22 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.openPointInTimeForType", + "id": "def-server.SavedObjectsUtils.namespaceIdToString", "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "openPointInTimeForType", + "tags": [], + "label": "namespaceIdToString", "description": [ - "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" ], "signature": [ - "(type: string | string[], { keepAlive, preference }?: ", - { - "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" - }, - ">" + "(namespace?: string | undefined) => string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1822 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 29 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | string[]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1823 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2", - "type": "Object", + "id": "def-server.SavedObjectsUtils.namespaceIdToString.$1", + "type": "string", "tags": [], - "label": "{ keepAlive = '5m', preference }", + "label": "namespace", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - } + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1824 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 29 }, "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [ - "- { id: string }" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.closePointInTime", + "id": "def-server.SavedObjectsUtils.namespaceStringToId", "type": "Function", "tags": [], - "label": "closePointInTime", + "label": "namespaceStringToId", "description": [ - "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" ], "signature": [ - "(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" - }, - ">" + "(namespace: string) => string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1895 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.closePointInTime.$1", + "id": "def-server.SavedObjectsUtils.namespaceStringToId.$1", "type": "string", "tags": [], - "label": "id", + "label": "namespace", "description": [], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1896 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43 }, "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.closePointInTime.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- {@link SavedObjectsClosePointInTimeOptions}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1897 - }, - "deprecated": false, - "isRequired": false } ], - "returnComment": [ - "- {@link SavedObjectsClosePointInTimeResponse}" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.createPointInTimeFinder", + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", "type": "Function", "tags": [], - "label": "createPointInTimeFinder", + "label": "createEmptyFindResponse", "description": [ - "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." ], "signature": [ - "(findOptions: Pick<", + "({ page, perPage, }: ", { "pluginId": "core", "scope": "server", @@ -8832,75 +8183,119 @@ "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" + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, "" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1951 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1", + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", "type": "Object", "tags": [], - "label": "findOptions", + "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", "description": [], "signature": [ - "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\">" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1952 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54 }, "deprecated": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUtils.generateId", + "type": "Function", + "tags": [], + "label": "generateId", + "description": [ + "\nGenerates a random ID for a saved objects." + ], + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" + }, + ".generateId" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 67 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUtils.isRandomId", + "type": "Function", + "tags": [ + "todo" + ], + "label": "isRandomId", + "description": [ + "\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" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", - "type": "Object", + "id": "def-server.SavedObjectsUtils.isRandomId.$1", + "type": "string", "tags": [], - "label": "dependencies", - "description": [], + "label": "id", + "description": [ + "The ID of a saved object." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1953 + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77 }, "deprecated": false, "isRequired": false @@ -8913,99 +8308,110 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer", + "id": "def-server.SavedObjectTypeRegistry", "type": "Class", "tags": [], - "label": "SavedObjectsSerializer", + "label": "SavedObjectTypeRegistry", "description": [ - "\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n" + "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 26 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 24 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.isRawSavedObject", + "id": "def-server.SavedObjectTypeRegistry.registerType", "type": "Function", "tags": [], - "label": "isRawSavedObject", + "label": "registerType", "description": [ - "\nDetermines whether or not the raw document can be converted to a saved object.\n" + "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." ], "signature": [ - "(doc: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - }, - ", options?: ", + "(type: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => boolean" + ") => void" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1", + "id": "def-server.SavedObjectTypeRegistry.registerType.$1", "type": "Object", "tags": [], - "label": "doc", - "description": [ - "- The raw ES document to be tested" - ], + "label": "type", + "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" } ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31 }, "deprecated": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.getType", + "type": "Function", + "tags": [], + "label": "getType", + "description": [ + "\nReturn the {@link SavedObjectsType | type} definition for given type name." + ], + "signature": [ + "(type: string) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2", - "type": "Object", + "id": "def-server.SavedObjectTypeRegistry.getType.$1", + "type": "string", "tags": [], - "label": "options", - "description": [ - "- Options for parsing the raw document." - ], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - } + "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42 }, "deprecated": false, "isRequired": true @@ -9015,92 +8421,119 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.rawToSavedObject", + "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", "type": "Function", "tags": [], - "label": "rawToSavedObject", + "label": "getVisibleTypes", "description": [ - "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" + "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." ], "signature": [ - "(doc: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - }, - ", options?: ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => ", + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 51 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.getAllTypes", + "type": "Function", + "tags": [], + "label": "getAllTypes", + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." + ], + "signature": [ + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - "" + "[]" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 79 - }, + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 60 + }, "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", + "type": "Function", + "tags": [], + "label": "getImportableAndExportableTypes", + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." + ], + "signature": [ + "() => ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1", - "type": "Object", - "tags": [], - "label": "doc", - "description": [ - "- The raw ES document to be converted to saved object format." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - } - ], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 80 - }, - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 67 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", + "type": "Function", + "tags": [], + "label": "isNamespaceAgnostic", + "description": [ + "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" + ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2", - "type": "Object", + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1", + "type": "string", "tags": [], - "label": "options", - "description": [ - "- Options for parsing the raw document." - ], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - } + "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 81 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75 }, "deprecated": false, "isRequired": true @@ -9110,59 +8543,35 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", "type": "Function", "tags": [], - "label": "savedObjectToRaw", + "label": "isSingleNamespace", "description": [ - "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" + "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" ], "signature": [ - "(savedObj: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - } + "(type: string) => boolean" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 125 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1", + "type": "string", "tags": [], - "label": "savedObj", - "description": [ - "- The saved object to be converted to raw ES format." - ], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" - }, - "" + "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 125 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83 }, "deprecated": false, "isRequired": true @@ -9172,75 +8581,111 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId", + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", "type": "Function", "tags": [], - "label": "generateRawId", + "label": "isMultiNamespace", "description": [ - "\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n" + "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" ], "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" + "(type: string) => boolean" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 166 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId.$1", + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1", "type": "string", "tags": [], - "label": "namespace", - "description": [ - "- The namespace of the saved object" - ], + "label": "type", + "description": [], "signature": [ - "string | undefined" + "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 166 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92 }, "deprecated": false, - "isRequired": false - }, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isShareable", + "type": "Function", + "tags": [], + "label": "isShareable", + "description": [ + "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" + ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId.$2", + "id": "def-server.SavedObjectTypeRegistry.isShareable.$1", "type": "string", "tags": [], "label": "type", - "description": [ - "- The saved object type" - ], + "description": [], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 166 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101 }, "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isHidden", + "type": "Function", + "tags": [], + "label": "isHidden", + "description": [ + "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId.$3", + "id": "def-server.SavedObjectTypeRegistry.isHidden.$1", "type": "string", "tags": [], - "label": "id", - "description": [ - "- The id of the saved object" - ], + "label": "type", + "description": [], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 166 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109 }, "deprecated": false, "isRequired": true @@ -9250,75 +8695,73 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", + "id": "def-server.SavedObjectTypeRegistry.getIndex", "type": "Function", "tags": [], - "label": "generateRawLegacyUrlAliasId", + "label": "getIndex", "description": [ - "\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n" + "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." ], "signature": [ - "(namespace: string, type: string, id: string) => string" + "(type: string) => string | undefined" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 179 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "- The namespace of the saved object" - ], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 179 - }, - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2", + "id": "def-server.SavedObjectTypeRegistry.getIndex.$1", "type": "string", "tags": [], "label": "type", - "description": [ - "- The saved object type" - ], + "description": [], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 179 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117 }, "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "type": "Function", + "tags": [], + "label": "isImportableAndExportable", + "description": [ + "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + ], + "signature": [ + "(type: string) => boolean" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", "type": "string", "tags": [], - "label": "id", - "description": [ - "- The id of the saved object" - ], + "label": "type", + "description": [], "signature": [ "string" ], "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 179 + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125 }, "deprecated": false, "isRequired": true @@ -9328,950 +8771,693 @@ } ], "initialIsOpen": false - }, + } + ], + "functions": [], + "interfaces": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils", - "type": "Class", + "id": "def-server.ISavedObjectsPointInTimeFinder", + "type": "Interface", "tags": [], - "label": "SavedObjectsUtils", + "label": "ISavedObjectsPointInTimeFinder", "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "" + ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 22 + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 42 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceIdToString", + "id": "def-server.ISavedObjectsPointInTimeFinder.find", "type": "Function", "tags": [], - "label": "namespaceIdToString", + "label": "find", "description": [ - "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" + "\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size." ], "signature": [ - "(namespace?: string | undefined) => string" + "() => AsyncGenerator<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ", any, unknown>" ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 29 + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 49 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceIdToString.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "The namespace ID, which must be either a non-empty string or `undefined`." - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 29 - }, - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceStringToId", + "id": "def-server.ISavedObjectsPointInTimeFinder.close", "type": "Function", "tags": [], - "label": "namespaceStringToId", + "label": "close", "description": [ - "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" + "\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason." ], "signature": [ - "(namespace: string) => string | undefined" + "() => Promise" ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 43 + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 60 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceStringToId.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "The namespace string, which must be non-empty." - ], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 43 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectExportBaseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectExportBaseOptions", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 13 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", - "type": "Function", + "id": "def-server.SavedObjectExportBaseOptions.request", + "type": "Object", "tags": [], - "label": "createEmptyFindResponse", + "label": "request", "description": [ - "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." + "The http request initiating the export." ], "signature": [ - "({ page, perPage, }: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - "" + "" ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 54 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 15 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", - "type": "Object", - "tags": [], - "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 54 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.generateId", - "type": "Function", + "id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep", + "type": "CompoundType", "tags": [], - "label": "generateId", + "label": "includeReferencesDeep", "description": [ - "\nGenerates a random ID for a saved objects." + "flag to also include all related saved objects in the export stream." ], "signature": [ - "() => string" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 67 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 17 }, - "deprecated": false, - "children": [], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.isRandomId", - "type": "Function", - "tags": [ - "todo" + "id": "def-server.SavedObjectExportBaseOptions.includeNamespaces", + "type": "CompoundType", + "tags": [], + "label": "includeNamespaces", + "description": [ + "\nFlag to also include namespace information in the export stream. By default, namespace information is not included in exported objects.\nThis is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP\nroute for exports." ], - "label": "isRandomId", + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 23 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", + "type": "CompoundType", + "tags": [], + "label": "excludeExportDetails", "description": [ - "\nValidates that a saved object ID has been randomly generated.\n" + "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." ], "signature": [ - "(id: string | undefined) => boolean" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 77 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 25 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.isRandomId.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of a saved object." - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 77 - }, - "deprecated": false, - "isRequired": false - } + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectExportBaseOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "optional namespace to override the namespace used by the savedObjectsClient." ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 27 + }, + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry", - "type": "Class", + "id": "def-server.SavedObjectMigrationContext", + "type": "Interface", "tags": [], - "label": "SavedObjectTypeRegistry", + "label": "SavedObjectMigrationContext", "description": [ - "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" + "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 24 + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.registerType", - "type": "Function", + "id": "def-server.SavedObjectMigrationContext.log", + "type": "Object", "tags": [], - "label": "registerType", + "label": "log", "description": [ - "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." + "\nlogger instance to be used by the migration handler" ], "signature": [ - "(type: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - ") => void" + "section": "def-server.SavedObjectsMigrationLogger", + "text": "SavedObjectsMigrationLogger" + } ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 31 + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 59 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.registerType.$1", - "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_type_registry.ts", - "lineNumber": 31 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getType", - "type": "Function", + "id": "def-server.SavedObjectMigrationContext.migrationVersion", + "type": "string", "tags": [], - "label": "getType", + "label": "migrationVersion", "description": [ - "\nReturn the {@link SavedObjectsType | type} definition for given type name." - ], - "signature": [ - "(type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined" + "\nThe migration version that this migration function is defined for" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 42 + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 63 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getType.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 42 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", - "type": "Function", + "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", + "type": "string", "tags": [], - "label": "getVisibleTypes", + "label": "convertToMultiNamespaceTypeVersion", "description": [ - "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." + "\nThe version in which this object type is being converted to a multi-namespace type" ], "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 51 + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 67 }, - "deprecated": false, - "children": [], - "returnComment": [] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationMap", + "type": "Interface", + "tags": [], + "label": "SavedObjectMigrationMap", + "description": [ + "\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 87 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getAllTypes", - "type": "Function", + "id": "def-server.SavedObjectMigrationMap.Unnamed", + "type": "Any", "tags": [], - "label": "getAllTypes", - "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." - ], + "label": "Unnamed", + "description": [], "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]" + "any" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 60 + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 88 }, - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", - "type": "Function", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectReferenceWithContext", + "description": [ + "\nA returned input object or one of its references, with additional context.\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 66 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.type", + "type": "string", "tags": [], - "label": "getImportableAndExportableTypes", + "label": "type", "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]" + "The type of the referenced object" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 67 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 68 }, - "deprecated": false, - "children": [], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", - "type": "Function", + "id": "def-server.SavedObjectReferenceWithContext.id", + "type": "string", "tags": [], - "label": "isNamespaceAgnostic", + "label": "id", "description": [ - "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" - ], - "signature": [ - "(type: string) => boolean" + "The ID of the referenced object" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 75 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 70 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 75 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", - "type": "Function", + "id": "def-server.SavedObjectReferenceWithContext.spaces", + "type": "Array", "tags": [], - "label": "isSingleNamespace", + "label": "spaces", "description": [ - "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" + "The space(s) that the referenced object exists in" ], "signature": [ - "(type: string) => boolean" + "string[]" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 83 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 72 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 83 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", - "type": "Function", + "id": "def-server.SavedObjectReferenceWithContext.inboundReferences", + "type": "Array", "tags": [], - "label": "isMultiNamespace", + "label": "inboundReferences", "description": [ - "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" + "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" ], "signature": [ - "(type: string) => boolean" + "{ type: string; id: string; name: string; }[]" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 92 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 77 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 92 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isShareable", - "type": "Function", + "id": "def-server.SavedObjectReferenceWithContext.isMissing", + "type": "CompoundType", "tags": [], - "label": "isShareable", + "label": "isMissing", "description": [ - "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" + "Whether or not this object or reference is missing" ], "signature": [ - "(type: string) => boolean" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 101 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 86 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isShareable.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 101 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isHidden", - "type": "Function", + "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases", + "type": "Array", "tags": [], - "label": "isHidden", + "label": "spacesWithMatchingAliases", "description": [ - "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + "The space(s) that legacy URL aliases matching this type/id exist in" ], "signature": [ - "(type: string) => boolean" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 109 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 88 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isHidden.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 109 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBaseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBaseOptions", + "description": [ + "\n" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 162 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getIndex", - "type": "Function", + "id": "def-server.SavedObjectsBaseOptions.namespace", + "type": "string", "tags": [], - "label": "getIndex", + "label": "namespace", "description": [ - "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." - ], - "signature": [ - "(type: string) => string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 117 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getIndex.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 117 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", - "type": "Function", - "tags": [], - "label": "isImportableAndExportable", - "description": [ - "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + "Specify the namespace for this operation" ], "signature": [ - "(type: string) => boolean" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 125 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 164 }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 125 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false } ], "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ + }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsPointInTimeFinder", + "id": "def-server.SavedObjectsBulkCreateObject", "type": "Interface", "tags": [], - "label": "ISavedObjectsPointInTimeFinder", - "description": [], + "label": "SavedObjectsBulkCreateObject", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - "" + "" ], "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 42 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 75 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsPointInTimeFinder.find", - "type": "Function", + "id": "def-server.SavedObjectsBulkCreateObject.id", + "type": "string", "tags": [], - "label": "find", - "description": [ - "\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size." - ], + "label": "id", + "description": [], "signature": [ - "() => AsyncGenerator<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ", any, unknown>" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 49 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 76 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsPointInTimeFinder.close", - "type": "Function", + "id": "def-server.SavedObjectsBulkCreateObject.type", + "type": "string", "tags": [], - "label": "close", - "description": [ - "\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason." - ], + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 77 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], "signature": [ - "() => Promise" + "T" ], "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 60 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 78 }, - "deprecated": false, - "returnComment": [], - "children": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectExportBaseOptions", - "description": [], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 13 - }, - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.request", - "type": "Object", + "id": "def-server.SavedObjectsBulkCreateObject.version", + "type": "string", "tags": [], - "label": "request", - "description": [ - "The http request initiating the export." - ], + "label": "version", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 15 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 79 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep", - "type": "CompoundType", + "id": "def-server.SavedObjectsBulkCreateObject.references", + "type": "Array", "tags": [], - "label": "includeReferencesDeep", - "description": [ - "flag to also include all related saved objects in the export stream." - ], + "label": "references", + "description": [], "signature": [ - "boolean | undefined" + "SavedObjectReference", + "[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 17 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 80 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.includeNamespaces", - "type": "CompoundType", + "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", + "type": "Object", "tags": [], - "label": "includeNamespaces", + "label": "migrationVersion", "description": [ - "\nFlag to also include namespace information in the export stream. By default, namespace information is not included in exported objects.\nThis is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP\nroute for exports." + "{@inheritDoc SavedObjectsMigrationVersion}" ], "signature": [ - "boolean | undefined" + "SavedObjectsMigrationVersion", + " | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 23 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 82 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", - "type": "CompoundType", + "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", + "type": "string", "tags": [], - "label": "excludeExportDetails", + "label": "coreMigrationVersion", "description": [ - "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." + "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" ], "signature": [ - "boolean | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 25 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 92 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.namespace", + "id": "def-server.SavedObjectsBulkCreateObject.originId", "type": "string", "tags": [], - "label": "namespace", + "label": "originId", "description": [ - "optional namespace to override the namespace used by the savedObjectsClient." + "Optional ID of the original saved object, if this object's `id` was regenerated" ], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 27 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 94 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext", - "type": "Interface", - "tags": [], - "label": "SavedObjectMigrationContext", - "description": [ - "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [ + "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types." + ], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 101 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkGetObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkGetObject", + "description": [ + "\n" ], "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 55 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 268 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.log", - "type": "Object", + "id": "def-server.SavedObjectsBulkGetObject.id", + "type": "string", "tags": [], - "label": "log", - "description": [ - "\nlogger instance to be used by the migration handler" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMigrationLogger", - "text": "SavedObjectsMigrationLogger" - } - ], + "label": "id", + "description": [], "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 59 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 269 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.migrationVersion", + "id": "def-server.SavedObjectsBulkGetObject.type", "type": "string", "tags": [], - "label": "migrationVersion", - "description": [ - "\nThe migration version that this migration function is defined for" - ], + "label": "type", + "description": [], "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 63 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 270 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", - "type": "string", + "id": "def-server.SavedObjectsBulkGetObject.fields", + "type": "Array", "tags": [], - "label": "convertToMultiNamespaceTypeVersion", + "label": "fields", "description": [ - "\nThe version in which this object type is being converted to a multi-namespace type" + "SavedObject fields to include in the response" ], "signature": [ - "string | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 67 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 272 }, "deprecated": false } @@ -10280,32 +9466,43 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationMap", + "id": "def-server.SavedObjectsBulkResponse", "type": "Interface", "tags": [], - "label": "SavedObjectMigrationMap", + "label": "SavedObjectsBulkResponse", "description": [ - "\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + "" ], "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 87 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 129 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationMap.Unnamed", - "type": "Any", + "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "type": "Array", "tags": [], - "label": "Unnamed", + "label": "saved_objects", "description": [], "signature": [ - "any" + "SavedObject", + "[]" ], "source": { - "path": "src/core/server/saved_objects/migrations/types.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 130 }, "deprecated": false } @@ -10314,118 +9511,145 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext", + "id": "def-server.SavedObjectsBulkResponse", "type": "Interface", "tags": [], - "label": "SavedObjectReferenceWithContext", + "label": "SavedObjectsBulkResponse", "description": [ - "\nA returned input object or one of its references, with additional context.\n" + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + "" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 66 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 279 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.type", - "type": "string", + "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "type": "Array", "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" + "label": "saved_objects", + "description": [], + "signature": [ + "SavedObject", + "[]" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 68 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 280 }, "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateObject", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" }, + " extends Pick<", { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 70 - }, - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" }, + ", \"version\" | \"references\">" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 108 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.spaces", - "type": "Array", + "id": "def-server.SavedObjectsBulkUpdateObject.id", + "type": "string", "tags": [], - "label": "spaces", + "label": "id", "description": [ - "The space(s) that the referenced object exists in" - ], - "signature": [ - "string[]" + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 72 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 111 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.inboundReferences", - "type": "Array", + "id": "def-server.SavedObjectsBulkUpdateObject.type", + "type": "string", "tags": [], - "label": "inboundReferences", + "label": "type", "description": [ - "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" - ], - "signature": [ - "{ type: string; id: string; name: string; }[]" + " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 77 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 113 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.isMissing", - "type": "CompoundType", + "id": "def-server.SavedObjectsBulkUpdateObject.attributes", + "type": "Object", "tags": [], - "label": "isMissing", + "label": "attributes", "description": [ - "Whether or not this object or reference is missing" + "{@inheritdoc SavedObjectAttributes}" ], "signature": [ - "boolean | undefined" + "Partial" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 86 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 115 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases", - "type": "Array", + "id": "def-server.SavedObjectsBulkUpdateObject.namespace", + "type": "string", "tags": [], - "label": "spacesWithMatchingAliases", + "label": "namespace", "description": [ - "The space(s) that legacy URL aliases matching this type/id exist in" + "\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`." ], "signature": [ - "string[] | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 88 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 122 }, "deprecated": false } @@ -10434,34 +9658,51 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBaseOptions", + "id": "def-server.SavedObjectsBulkUpdateOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBaseOptions", + "label": "SavedObjectsBulkUpdateOptions", "description": [ "\n" ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 162 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 248 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBaseOptions.namespace", - "type": "string", + "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "namespace", + "label": "refresh", "description": [ - "Specify the namespace for this operation" + "The Elasticsearch Refresh setting for this operation" ], "signature": [ - "string | undefined" + "boolean | \"wait_for\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 164 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 250 }, "deprecated": false } @@ -10470,10 +9711,10 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject", + "id": "def-server.SavedObjectsBulkUpdateResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkCreateObject", + "label": "SavedObjectsBulkUpdateResponse", "description": [ "\n" ], @@ -10482,165 +9723,256 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" }, "" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 75 + "lineNumber": 287 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.id", - "type": "string", + "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", + "type": "Array", "tags": [], - "label": "id", + "label": "saved_objects", "description": [], "signature": [ - "string | undefined" + { + "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": 76 + "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.SavedObjectsBulkCreateObject.type", + "id": "def-server.SavedObjectsCheckConflictsObject.id", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 77 + "lineNumber": 195 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.attributes", - "type": "Uncategorized", + "id": "def-server.SavedObjectsCheckConflictsObject.type", + "type": "string", "tags": [], - "label": "attributes", + "label": "type", "description": [], - "signature": [ - "T" - ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 78 + "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.SavedObjectsBulkCreateObject.version", - "type": "string", + "id": "def-server.SavedObjectsCheckConflictsResponse.errors", + "type": "Array", "tags": [], - "label": "version", + "label": "errors", "description": [], "signature": [ - "string | undefined" + "{ id: string; type: string; error: ", + "SavedObjectError", + "; }[]" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 79 + "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.SavedObjectsBulkCreateObject.references", + "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", "type": "Array", "tags": [], - "label": "references", + "label": "excludedWrappers", "description": [], "signature": [ - "SavedObjectReference", - "[] | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 80 + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 58 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", - "type": "Object", + "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", + "type": "Array", "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" - ], + "label": "includedHiddenTypes", + "description": [], "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 82 + "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.SavedObjectsBulkCreateObject.coreMigrationVersion", - "type": "string", + "id": "def-server.SavedObjectsClientWrapperOptions.client", + "type": "Object", "tags": [], - "label": "coreMigrationVersion", - "description": [ - "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" - ], + "label": "client", + "description": [], "signature": [ - "string | 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/service/saved_objects_client.ts", - "lineNumber": 92 + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 20 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.originId", - "type": "string", + "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", + "type": "Object", "tags": [], - "label": "originId", - "description": [ - "Optional ID of the original saved object, if this object's `id` was regenerated" - ], + "label": "typeRegistry", + "description": [], "signature": [ - "string | undefined" + "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/service/saved_objects_client.ts", - "lineNumber": 94 + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 21 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", - "type": "Array", + "id": "def-server.SavedObjectsClientWrapperOptions.request", + "type": "Object", "tags": [], - "label": "initialNamespaces", - "description": [ - "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types." - ], + "label": "request", + "description": [], "signature": [ - "string[] | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 101 + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 22 }, "deprecated": false } @@ -10649,60 +9981,88 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject", + "id": "def-server.SavedObjectsClosePointInTimeResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkGetObject", - "description": [ - "\n" - ], + "label": "SavedObjectsClosePointInTimeResponse", + "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 268 + "lineNumber": 355 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.id", - "type": "string", + "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", + "type": "boolean", "tags": [], - "label": "id", - "description": [], + "label": "succeeded", + "description": [ + "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 269 + "lineNumber": 360 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.type", + "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", + "type": "number", + "tags": [], + "label": "num_freed", + "description": [ + "\nThe number of search contexts that have been successfully closed." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 364 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesObject", + "description": [ + "\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 45 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 270 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 46 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.fields", - "type": "Array", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type", + "type": "string", "tags": [], - "label": "fields", - "description": [ - "SavedObject fields to include in the response" - ], - "signature": [ - "string[] | undefined" - ], + "label": "type", + "description": [], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 272 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 47 }, "deprecated": false } @@ -10711,43 +10071,51 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkResponse", + "label": "SavedObjectsCollectMultiNamespaceReferencesOptions", "description": [ - "\n" + "\nOptions for collecting references.\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" }, - "" + " 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": 129 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse.saved_objects", - "type": "Array", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose", + "type": "CompoundType", "tags": [], - "label": "saved_objects", - "description": [], + "label": "purpose", + "description": [ + "Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'" + ], "signature": [ - "SavedObject", - "[]" + "\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 130 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 58 }, "deprecated": false } @@ -10756,43 +10124,39 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkResponse", + "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - "" + "\nThe response when object references are collected.\n" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 279 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 96 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", "type": "Array", "tags": [], - "label": "saved_objects", + "label": "objects", "description": [], "signature": [ - "SavedObject", - "[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectReferenceWithContext", + "text": "SavedObjectReferenceWithContext" + }, + "[]" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 280 + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "lineNumber": 97 }, "deprecated": false } @@ -10801,204 +10165,104 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject", + "id": "def-server.SavedObjectsComplexFieldMapping", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkUpdateObject", + "label": "SavedObjectsComplexFieldMapping", "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - " extends Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ", \"version\" | \"references\">" + "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 108 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 141 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.id", - "type": "string", + "id": "def-server.SavedObjectsComplexFieldMapping.dynamic", + "type": "CompoundType", "tags": [], - "label": "id", + "label": "dynamic", "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + "\nThe dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings.\n\nNote: To limit the number of mapping fields Saved Object types should\n*never* use `dynamic: true`." + ], + "signature": [ + "false | \"strict\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 111 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 150 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.type", - "type": "string", + "id": "def-server.SavedObjectsComplexFieldMapping.enabled", + "type": "CompoundType", "tags": [], - "label": "type", - "description": [ - " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." + "label": "enabled", + "description": [], + "signature": [ + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 113 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 151 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.attributes", - "type": "Object", + "id": "def-server.SavedObjectsComplexFieldMapping.doc_values", + "type": "CompoundType", "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], + "label": "doc_values", + "description": [], "signature": [ - "{ [P in keyof T]?: T[P] | undefined; }" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 115 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 152 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.namespace", + "id": "def-server.SavedObjectsComplexFieldMapping.type", "type": "string", "tags": [], - "label": "namespace", - "description": [ - "\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`." - ], + "label": "type", + "description": [], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 122 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " 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": 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 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 153 }, "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", + "id": "def-server.SavedObjectsComplexFieldMapping.properties", + "type": "Object", "tags": [], - "label": "saved_objects", + "label": "properties", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - "[]" + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" + } ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 288 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 154 }, "deprecated": false } @@ -11007,128 +10271,93 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject", + "id": "def-server.SavedObjectsCoreFieldMapping", "type": "Interface", "tags": [], - "label": "SavedObjectsCheckConflictsObject", + "label": "SavedObjectsCoreFieldMapping", "description": [ - "\n" + "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 194 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 123 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject.id", + "id": "def-server.SavedObjectsCoreFieldMapping.type", "type": "string", "tags": [], - "label": "id", + "label": "type", "description": [], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 195 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 124 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject.type", - "type": "string", + "id": "def-server.SavedObjectsCoreFieldMapping.null_value", + "type": "CompoundType", "tags": [], - "label": "type", + "label": "null_value", "description": [], + "signature": [ + "string | number | boolean | undefined" + ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 196 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 125 }, "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", + "id": "def-server.SavedObjectsCoreFieldMapping.index", + "type": "CompoundType", "tags": [], - "label": "errors", + "label": "index", "description": [], "signature": [ - "{ id: string; type: string; error: ", - "SavedObjectError", - "; }[]" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 204 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 126 }, "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", + "id": "def-server.SavedObjectsCoreFieldMapping.doc_values", + "type": "CompoundType", "tags": [], - "label": "excludedWrappers", + "label": "doc_values", "description": [], "signature": [ - "string[] | undefined" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 58 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 127 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", - "type": "Array", + "id": "def-server.SavedObjectsCoreFieldMapping.fields", + "type": "Object", "tags": [], - "label": "includedHiddenTypes", + "label": "fields", "description": [], "signature": [ - "string[] | undefined" + "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 59 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 128 }, "deprecated": false } @@ -11137,403 +10366,288 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions", + "id": "def-server.SavedObjectsCreateOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsClientWrapperOptions", + "label": "SavedObjectsCreateOptions", "description": [ - "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 19 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 35 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.client", - "type": "Object", + "id": "def-server.SavedObjectsCreateOptions.id", + "type": "string", "tags": [], - "label": "client", - "description": [], + "label": "id", + "description": [ + "(not recommended) Specify an id for the document" + ], "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<", + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 37 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "Overwrite existing documents (defaults to false)" + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 46 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 56 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 57 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.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": 59 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 61 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [ + "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types." + ], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 68 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreatePointInTimeFinderDependencies", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 29 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "Pick>; 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" - }, - "; }" + ", \"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/scoped_client_provider.ts", - "lineNumber": 20 + "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "lineNumber": 30 }, "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteByNamespaceOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" }, + " 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": 144 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", - "type": "Object", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "typeRegistry", - "description": [], + "label": "refresh", + "description": [ + "The Elasticsearch supports only boolean flag for this operation" + ], "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/service/lib/scoped_client_provider.ts", - "lineNumber": 21 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "lineNumber": 22 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 146 }, "deprecated": false } @@ -11542,44 +10656,69 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeResponse", + "id": "def-server.SavedObjectsDeleteOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsClosePointInTimeResponse", - "description": [], + "label": "SavedObjectsDeleteOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " 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": 355 + "lineNumber": 257 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", - "type": "boolean", + "id": "def-server.SavedObjectsDeleteOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "succeeded", + "label": "refresh", "description": [ - "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." + "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": 360 + "lineNumber": 259 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", - "type": "number", + "id": "def-server.SavedObjectsDeleteOptions.force", + "type": "CompoundType", "tags": [], - "label": "num_freed", + "label": "force", "description": [ - "\nThe number of search contexts that have been successfully closed." + "Force deletion of an object that exists in multiple namespaces" + ], + "signature": [ + "boolean | undefined" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 364 + "lineNumber": 261 }, "deprecated": false } @@ -11588,42 +10727,51 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "id": "def-server.SavedObjectsExportByObjectOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesObject", + "label": "SavedObjectsExportByObjectOptions", "description": [ - "\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n" + "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectExportBaseOptions", + "text": "SavedObjectExportBaseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 45 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 49 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 46 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type", - "type": "string", + "id": "def-server.SavedObjectsExportByObjectOptions.objects", + "type": "Array", "tags": [], - "label": "type", - "description": [], + "label": "objects", + "description": [ + "optional array of objects to export." + ], + "signature": [ + "{ id: string; type: string; }[]" + ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 47 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 51 }, "deprecated": false } @@ -11632,92 +10780,94 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "id": "def-server.SavedObjectsExportByTypeOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesOptions", + "label": "SavedObjectsExportByTypeOptions", "description": [ - "\nOptions for collecting references.\n" + "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" }, " extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectExportBaseOptions", + "text": "SavedObjectExportBaseOptions" } ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 55 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 35 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose", - "type": "CompoundType", + "id": "def-server.SavedObjectsExportByTypeOptions.types", + "type": "Array", "tags": [], - "label": "purpose", + "label": "types", "description": [ - "Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'" + "array of saved object types." ], "signature": [ - "\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined" + "string[]" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 58 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 37 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", - "description": [ - "\nThe response when object references are collected.\n" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 96 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", + "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", "type": "Array", "tags": [], - "label": "objects", - "description": [], + "label": "hasReference", + "description": [ + "optional array of references to search object for." + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectReferenceWithContext", - "text": "SavedObjectReferenceWithContext" + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" }, - "[]" + "[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "lineNumber": 97 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportByTypeOptions.search", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "optional query string to filter exported objects." + ], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 41 }, "deprecated": false } @@ -11726,104 +10876,107 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsComplexFieldMapping", + "id": "def-server.SavedObjectsExportResultDetails", "type": "Interface", "tags": [], - "label": "SavedObjectsComplexFieldMapping", + "label": "SavedObjectsExportResultDetails", "description": [ - "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" + "\nStructure of the export result details entry" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 141 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 63 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsComplexFieldMapping.dynamic", - "type": "CompoundType", + "id": "def-server.SavedObjectsExportResultDetails.exportedCount", + "type": "number", "tags": [], - "label": "dynamic", + "label": "exportedCount", "description": [ - "\nThe dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings.\n\nNote: To limit the number of mapping fields Saved Object types should\n*never* use `dynamic: true`." - ], - "signature": [ - "false | \"strict\" | undefined" + "number of successfully exported objects" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 150 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 65 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsComplexFieldMapping.enabled", - "type": "CompoundType", + "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", + "type": "number", "tags": [], - "label": "enabled", - "description": [], - "signature": [ - "boolean | undefined" + "label": "missingRefCount", + "description": [ + "number of missing references" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 151 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 67 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsComplexFieldMapping.doc_values", - "type": "CompoundType", + "id": "def-server.SavedObjectsExportResultDetails.missingReferences", + "type": "Array", "tags": [], - "label": "doc_values", - "description": [], - "signature": [ - "boolean | undefined" + "label": "missingReferences", + "description": [ + "missing references details" ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 152 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsComplexFieldMapping.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], "signature": [ - "string | undefined" + "{ id: string; type: string; }[]" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 153 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 69 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportTransformContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectsExportTransformContext", + "description": [ + "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 82 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsComplexFieldMapping.properties", + "id": "def-server.SavedObjectsExportTransformContext.request", "type": "Object", "tags": [], - "label": "properties", - "description": [], + "label": "request", + "description": [ + "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" + ], "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMappingProperties", - "text": "SavedObjectsMappingProperties" - } + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 154 + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 87 }, "deprecated": false } @@ -11832,290 +10985,370 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCoreFieldMapping", + "id": "def-server.SavedObjectsFindOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsCoreFieldMapping", + "label": "SavedObjectsFindOptions", "description": [ - "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" + "\n" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 123 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 78 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsCoreFieldMapping.type", - "type": "string", + "id": "def-server.SavedObjectsFindOptions.type", + "type": "CompoundType", "tags": [], "label": "type", "description": [], + "signature": [ + "string | string[]" + ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 124 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 79 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCoreFieldMapping.null_value", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindOptions.page", + "type": "number", "tags": [], - "label": "null_value", + "label": "page", "description": [], "signature": [ - "string | number | boolean | undefined" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 125 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 80 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCoreFieldMapping.index", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindOptions.perPage", + "type": "number", "tags": [], - "label": "index", + "label": "perPage", "description": [], "signature": [ - "boolean | undefined" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 126 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 81 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCoreFieldMapping.doc_values", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindOptions.sortField", + "type": "string", "tags": [], - "label": "doc_values", + "label": "sortField", "description": [], "signature": [ - "boolean | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 127 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 82 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCoreFieldMapping.fields", - "type": "Object", + "id": "def-server.SavedObjectsFindOptions.sortOrder", + "type": "CompoundType", "tags": [], - "label": "fields", + "label": "sortOrder", "description": [], "signature": [ - "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" + "\"asc\" | \"desc\" | \"_doc\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 128 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 83 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCreateOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" }, - " 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": 35 - }, - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.id", - "type": "string", + "id": "def-server.SavedObjectsFindOptions.fields", + "type": "Array", "tags": [], - "label": "id", + "label": "fields", "description": [ - "(not recommended) Specify an id for the document" + "\nAn array of fields to include in the results" ], "signature": [ - "string | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 37 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 89 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.overwrite", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindOptions.search", + "type": "string", "tags": [], - "label": "overwrite", + "label": "search", "description": [ - "Overwrite existing documents (defaults to false)" + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" ], "signature": [ - "boolean | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 39 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 91 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.version", - "type": "string", + "id": "def-server.SavedObjectsFindOptions.searchFields", + "type": "Array", "tags": [], - "label": "version", + "label": "searchFields", "description": [ - "\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control." + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" ], "signature": [ - "string | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 44 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 93 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.migrationVersion", - "type": "Object", + "id": "def-server.SavedObjectsFindOptions.searchAfter", + "type": "Array", "tags": [], - "label": "migrationVersion", + "label": "searchAfter", "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" + "\nUse the sort values from the previous page to retrieve the next page of results." ], "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 46 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 97 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", + "id": "def-server.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", + "tags": [], + "label": "rootSearchFields", "description": [ - "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" + "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." ], "signature": [ - "string | undefined" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 56 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 102 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.references", - "type": "Array", + "id": "def-server.SavedObjectsFindOptions.hasReference", + "type": "CompoundType", "tags": [], - "label": "references", - "description": [], + "label": "hasReference", + "description": [ + "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + ], "signature": [ - "SavedObjectReference", + { + "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" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 57 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 108 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.refresh", + "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", "type": "CompoundType", "tags": [], - "label": "refresh", + "label": "hasReferenceOperator", "description": [ - "The Elasticsearch Refresh setting for this operation" + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" ], "signature": [ - "boolean | \"wait_for\" | undefined" + "\"AND\" | \"OR\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 59 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 112 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.originId", + "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", + "tags": [], + "label": "defaultSearchOperator", + "description": [ + "\nThe search operator to use with the provided filter. Defaults to `OR`" + ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 117 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 118 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.aggs", + "type": "Object", + "tags": [ + "alpha" + ], + "label": "aggs", + "description": [ + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + ], + "signature": [ + "Record | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 140 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 141 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "tags": [], + "label": "typeToNamespacesMap", + "description": [ + "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + ], + "signature": [ + "Map | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 149 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.preference", "type": "string", "tags": [], - "label": "originId", + "label": "preference", "description": [ - "Optional ID of the original saved object, if this object's `id` was regenerated" + "An optional ES preference value to be used for the query" ], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 61 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 151 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", - "type": "Array", + "id": "def-server.SavedObjectsFindOptions.pit", + "type": "Object", "tags": [], - "label": "initialNamespaces", + "label": "pit", "description": [ - "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types." + "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." ], "signature": [ - "string[] | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" + }, + " | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 68 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 155 }, "deprecated": false } @@ -12124,78 +11357,40 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "id": "def-server.SavedObjectsFindOptionsReference", "type": "Interface", "tags": [], - "label": "SavedObjectsCreatePointInTimeFinderDependencies", + "label": "SavedObjectsFindOptionsReference", "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 29 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 61 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client", - "type": "Object", + "id": "def-server.SavedObjectsFindOptionsReference.type", + "type": "string", "tags": [], - "label": "client", + "label": "type", "description": [], - "signature": [ - "{ 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" - }, - ">; 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" - }, - ">; }" - ], "source": { - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "lineNumber": 30 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 62 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptionsReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 63 }, "deprecated": false } @@ -12204,122 +11399,120 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteByNamespaceOptions", + "id": "def-server.SavedObjectsFindResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsDeleteByNamespaceOptions", + "label": "SavedObjectsFindResponse", "description": [ - "\n" + "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, - " 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": 144 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 181 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch supports only boolean flag for this operation" + "label": "aggregations", + "description": [], + "signature": [ + "A | undefined" ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 182 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" + }, + "[]" ], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 146 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 183 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsDeleteOptions", - "description": [ - "\n" - ], - "signature": [ + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 184 + }, + "deprecated": false }, - " 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": 257 - }, - "deprecated": false, - "children": [ + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.per_page", + "type": "number", + "tags": [], + "label": "per_page", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 185 + }, + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteOptions.refresh", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindResponse.page", + "type": "number", "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - "boolean | \"wait_for\" | undefined" - ], + "label": "page", + "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 259 + "lineNumber": 186 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteOptions.force", - "type": "CompoundType", + "id": "def-server.SavedObjectsFindResponse.pit_id", + "type": "string", "tags": [], - "label": "force", - "description": [ - "Force deletion of an object that exists in multiple namespaces" - ], + "label": "pit_id", + "description": [], "signature": [ - "boolean | undefined" + "string | undefined" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 261 + "lineNumber": 187 }, "deprecated": false } @@ -12328,51 +11521,61 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByObjectOptions", + "id": "def-server.SavedObjectsFindResult", "type": "Interface", "tags": [], - "label": "SavedObjectsExportByObjectOptions", + "label": "SavedObjectsFindResult", "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" + "\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectExportBaseOptions", - "text": "SavedObjectExportBaseOptions" - } + " extends ", + "SavedObject", + "" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 49 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 137 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByObjectOptions.objects", + "id": "def-server.SavedObjectsFindResult.score", + "type": "number", + "tags": [], + "label": "score", + "description": [ + "\nThe Elasticsearch `_score` of this result." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 141 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResult.sort", "type": "Array", "tags": [], - "label": "objects", + "label": "sort", "description": [ - "optional array of objects to export." + "\nThe Elasticsearch `sort` value of this result.\n" ], "signature": [ - "{ id: string; type: string; }[]" + "string[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 51 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 170 }, "deprecated": false } @@ -12381,94 +11584,80 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions", + "id": "def-server.SavedObjectsImportActionRequiredWarning", "type": "Interface", "tags": [], - "label": "SavedObjectsExportByTypeOptions", + "label": "SavedObjectsImportActionRequiredWarning", "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectExportBaseOptions", - "text": "SavedObjectExportBaseOptions" - } + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 35 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 200 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions.types", - "type": "Array", + "id": "def-server.SavedObjectsImportActionRequiredWarning.type", + "type": "string", "tags": [], - "label": "types", - "description": [ - "array of saved object types." - ], + "label": "type", + "description": [], "signature": [ - "string[]" + "\"action_required\"" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 37 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 201 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", - "type": "Array", + "id": "def-server.SavedObjectsImportActionRequiredWarning.message", + "type": "string", "tags": [], - "label": "hasReference", + "label": "message", "description": [ - "optional array of references to search object for." + "The translated message to display to the user." ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined" + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 203 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "tags": [], + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to address this warning." ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 39 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 205 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions.search", + "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", "type": "string", "tags": [], - "label": "search", + "label": "buttonLabel", "description": [ - "optional query string to filter exported objects." + "An optional label to use for the link button. If unspecified, a default label will be used." ], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 41 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 207 }, "deprecated": false } @@ -12477,64 +11666,48 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails", + "id": "def-server.SavedObjectsImportAmbiguousConflictError", "type": "Interface", "tags": [], - "label": "SavedObjectsExportResultDetails", + "label": "SavedObjectsImportAmbiguousConflictError", "description": [ - "\nStructure of the export result details entry" + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 63 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 53 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.exportedCount", - "type": "number", - "tags": [], - "label": "exportedCount", - "description": [ - "number of successfully exported objects" - ], - "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 65 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", - "type": "number", + "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", "tags": [], - "label": "missingRefCount", - "description": [ - "number of missing references" + "label": "type", + "description": [], + "signature": [ + "\"ambiguous_conflict\"" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 67 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 54 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.missingReferences", + "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", "type": "Array", "tags": [], - "label": "missingReferences", - "description": [ - "missing references details" - ], + "label": "destinations", + "description": [], "signature": [ - "{ id: string; type: string; }[]" + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 69 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 55 }, "deprecated": false } @@ -12543,41 +11716,48 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportTransformContext", + "id": "def-server.SavedObjectsImportConflictError", "type": "Interface", "tags": [], - "label": "SavedObjectsExportTransformContext", + "label": "SavedObjectsImportConflictError", "description": [ - "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" + "\nRepresents a failure to import due to a conflict." ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 82 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 44 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportTransformContext.request", - "type": "Object", + "id": "def-server.SavedObjectsImportConflictError.type", + "type": "string", "tags": [], - "label": "request", - "description": [ - "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" + "label": "type", + "description": [], + "signature": [ + "\"conflict\"" ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportConflictError.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/export/types.ts", - "lineNumber": 87 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 46 }, "deprecated": false } @@ -12586,370 +11766,326 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions", + "id": "def-server.SavedObjectsImportFailure", "type": "Interface", "tags": [], - "label": "SavedObjectsFindOptions", + "label": "SavedObjectsImportFailure", "description": [ - "\n" + "\nRepresents a failure to import." ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 78 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 89 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | string[]" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 79 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.page", - "type": "number", + "id": "def-server.SavedObjectsImportFailure.id", + "type": "string", "tags": [], - "label": "page", + "label": "id", "description": [], - "signature": [ - "number | undefined" - ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 80 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 90 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.perPage", - "type": "number", + "id": "def-server.SavedObjectsImportFailure.type", + "type": "string", "tags": [], - "label": "perPage", + "label": "type", "description": [], - "signature": [ - "number | undefined" - ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 81 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 91 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.sortField", + "id": "def-server.SavedObjectsImportFailure.title", "type": "string", - "tags": [], - "label": "sortField", + "tags": [ + "deprecated" + ], + "label": "title", "description": [], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 82 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 95 }, - "deprecated": false + "deprecated": true, + "references": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.sortOrder", - "type": "CompoundType", + "id": "def-server.SavedObjectsImportFailure.meta", + "type": "Object", "tags": [], - "label": "sortOrder", + "label": "meta", "description": [], "signature": [ - "\"asc\" | \"desc\" | \"_doc\" | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 83 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.fields", - "type": "Array", - "tags": [], - "label": "fields", - "description": [ - "\nAn array of fields to include in the results" - ], - "signature": [ - "string[] | undefined" + "{ title?: string | undefined; icon?: string | undefined; }" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 89 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 96 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.search", - "type": "string", + "id": "def-server.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", "tags": [], - "label": "search", + "label": "overwrite", "description": [ - "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." ], "signature": [ - "string | undefined" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 91 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 100 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.searchFields", - "type": "Array", + "id": "def-server.SavedObjectsImportFailure.error", + "type": "CompoundType", "tags": [], - "label": "searchFields", - "description": [ - "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" - ], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 93 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.searchAfter", - "type": "Array", - "tags": [], - "label": "searchAfter", - "description": [ - "\nUse the sort values from the previous page to retrieve the next page of results." - ], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 97 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.rootSearchFields", - "type": "Array", - "tags": [], - "label": "rootSearchFields", - "description": [ - "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." - ], - "signature": [ - "string[] | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 102 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.hasReference", - "type": "CompoundType", - "tags": [], - "label": "hasReference", - "description": [ - "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." - ], + "label": "error", + "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "section": "def-server.SavedObjectsImportConflictError", + "text": "SavedObjectsImportConflictError" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "section": "def-server.SavedObjectsImportAmbiguousConflictError", + "text": "SavedObjectsImportAmbiguousConflictError" }, - "[] | undefined" + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnsupportedTypeError", + "text": "SavedObjectsImportUnsupportedTypeError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportMissingReferencesError", + "text": "SavedObjectsImportMissingReferencesError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnknownError", + "text": "SavedObjectsImportUnknownError" + } ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 108 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportHookResult", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportHookResult", + "description": [ + "\nResult from a {@link SavedObjectsImportHook | import hook}\n" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 227 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", - "type": "CompoundType", + "id": "def-server.SavedObjectsImportHookResult.warnings", + "type": "Array", "tags": [], - "label": "hasReferenceOperator", + "label": "warnings", "description": [ - "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + "\nAn optional list of warnings to display in the UI when the import succeeds." ], "signature": [ - "\"AND\" | \"OR\" | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 112 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 231 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportMissingReferencesError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportMissingReferencesError", + "description": [ + "\nRepresents a failure to import due to missing references." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 80 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", - "type": "CompoundType", + "id": "def-server.SavedObjectsImportMissingReferencesError.type", + "type": "string", "tags": [], - "label": "defaultSearchOperator", - "description": [ - "\nThe search operator to use with the provided filter. Defaults to `OR`" - ], + "label": "type", + "description": [], "signature": [ - "\"AND\" | \"OR\" | undefined" + "\"missing_references\"" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 117 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 81 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.filter", - "type": "Any", + "id": "def-server.SavedObjectsImportMissingReferencesError.references", + "type": "Array", "tags": [], - "label": "filter", + "label": "references", "description": [], "signature": [ - "any" + "{ type: string; id: string; }[]" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 118 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 82 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportOptions", + "description": [ + "\nOptions to control the import operation." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 153 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.aggs", + "id": "def-server.SavedObjectsImportOptions.readStream", "type": "Object", - "tags": [ - "alpha" - ], - "label": "aggs", + "tags": [], + "label": "readStream", "description": [ - "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + "The stream of {@link SavedObject | saved objects} to import" ], "signature": [ - "Record | undefined" + "Readable" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 155 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.namespaces", - "type": "Array", + "id": "def-server.SavedObjectsImportOptions.overwrite", + "type": "boolean", "tags": [], - "label": "namespaces", - "description": [], - "signature": [ - "string[] | undefined" + "label": "overwrite", + "description": [ + "If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option." ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 141 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 157 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", - "type": "Object", + "id": "def-server.SavedObjectsImportOptions.namespace", + "type": "string", "tags": [], - "label": "typeToNamespacesMap", + "label": "namespace", "description": [ - "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + "if specified, will import in given namespace, else will import as global object" ], "signature": [ - "Map | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 149 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 159 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.preference", - "type": "string", + "id": "def-server.SavedObjectsImportOptions.createNewCopies", + "type": "boolean", "tags": [], - "label": "preference", + "label": "createNewCopies", "description": [ - "An optional ES preference value to be used for the query" - ], - "signature": [ - "string | undefined" + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 151 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.pit", - "type": "Object", - "tags": [], - "label": "pit", - "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 155 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 161 }, "deprecated": false } @@ -12958,225 +12094,238 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptionsReference", + "id": "def-server.SavedObjectsImportResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsFindOptionsReference", - "description": [], + "label": "SavedObjectsImportResponse", + "description": [ + "\nThe response describing the result of an import." + ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 61 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 141 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptionsReference.type", - "type": "string", + "id": "def-server.SavedObjectsImportResponse.success", + "type": "boolean", "tags": [], - "label": "type", + "label": "success", "description": [], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 62 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 142 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptionsReference.id", - "type": "string", + "id": "def-server.SavedObjectsImportResponse.successCount", + "type": "number", "tags": [], - "label": "id", + "label": "successCount", "description": [], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 63 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 143 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindResponse", - "description": [ - "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" }, - "" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 181 - }, - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.aggregations", - "type": "Uncategorized", + "id": "def-server.SavedObjectsImportResponse.successResults", + "type": "Array", "tags": [], - "label": "aggregations", + "label": "successResults", "description": [], "signature": [ - "A | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" + }, + "[] | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 182 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 144 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.saved_objects", + "id": "def-server.SavedObjectsImportResponse.warnings", "type": "Array", "tags": [], - "label": "saved_objects", + "label": "warnings", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResult", - "text": "SavedObjectsFindResult" + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" }, - "[]" + "[]" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 183 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 145 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.total", - "type": "number", + "id": "def-server.SavedObjectsImportResponse.errors", + "type": "Array", "tags": [], - "label": "total", + "label": "errors", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" + }, + "[] | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 146 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportRetry", + "description": [ + "\nDescribes a retry operation for importing a saved object." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 16 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.type", + "type": "string", + "tags": [], + "label": "type", "description": [], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 184 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 17 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.per_page", - "type": "number", + "id": "def-server.SavedObjectsImportRetry.id", + "type": "string", "tags": [], - "label": "per_page", + "label": "id", "description": [], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 185 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 18 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.page", - "type": "number", + "id": "def-server.SavedObjectsImportRetry.overwrite", + "type": "boolean", "tags": [], - "label": "page", + "label": "overwrite", "description": [], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 186 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 19 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.pit_id", + "id": "def-server.SavedObjectsImportRetry.destinationId", "type": "string", "tags": [], - "label": "pit_id", - "description": [], + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 187 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 23 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResult", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindResult", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResult", - "text": "SavedObjectsFindResult" }, - " extends ", - "SavedObject", - "" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 137 - }, - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResult.score", - "type": "number", + "id": "def-server.SavedObjectsImportRetry.replaceReferences", + "type": "Array", "tags": [], - "label": "score", - "description": [ - "\nThe Elasticsearch `_score` of this result." + "label": "replaceReferences", + "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 141 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 24 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResult.sort", - "type": "Array", + "id": "def-server.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", "tags": [], - "label": "sort", + "label": "createNewCopy", "description": [ - "\nThe Elasticsearch `sort` value of this result.\n" + "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." ], "signature": [ - "string[] | undefined" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 170 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 33 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "tags": [], + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 37 }, "deprecated": false } @@ -13185,130 +12334,177 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning", + "id": "def-server.SavedObjectsImportSimpleWarning", "type": "Interface", "tags": [], - "label": "SavedObjectsImportActionRequiredWarning", + "label": "SavedObjectsImportSimpleWarning", "description": [ - "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" + "\nA simple informative warning that will be displayed to the user.\n" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 200 + "lineNumber": 186 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.type", + "id": "def-server.SavedObjectsImportSimpleWarning.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ - "\"action_required\"" + "\"simple\"" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 201 + "lineNumber": 187 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.message", + "id": "def-server.SavedObjectsImportSimpleWarning.message", "type": "string", "tags": [], "label": "message", "description": [ - "The translated message to display to the user." + "The translated message to display to the user" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 203 + "lineNumber": 189 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSuccess", + "description": [ + "\nRepresents a successful import." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 113 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 114 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", + "id": "def-server.SavedObjectsImportSuccess.type", "type": "string", "tags": [], - "label": "actionPath", - "description": [ - "The path (without the basePath) that the user should be redirect to address this warning." - ], + "label": "type", + "description": [], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 205 + "lineNumber": 115 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", + "id": "def-server.SavedObjectsImportSuccess.destinationId", "type": "string", "tags": [], - "label": "buttonLabel", + "label": "destinationId", "description": [ - "An optional label to use for the link button. If unspecified, a default label will be used." + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." ], "signature": [ "string | undefined" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 207 + "lineNumber": 119 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportAmbiguousConflictError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportAmbiguousConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 53 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", - "type": "string", + "id": "def-server.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "createNewCopy", + "description": [], + "signature": [ + "boolean | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 126 + }, + "deprecated": true, + "references": [ + { + "plugin": "savedObjectsManagement", + "link": { + "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts", + "lineNumber": 223 + } + }, + { + "plugin": "spaces", + "link": { + "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx", + "lineNumber": 142 + } + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess.meta", + "type": "Object", "tags": [], - "label": "type", + "label": "meta", "description": [], "signature": [ - "\"ambiguous_conflict\"" + "{ title?: string | undefined; icon?: string | undefined; }" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 54 + "lineNumber": 127 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", - "type": "Array", + "id": "def-server.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", "tags": [], - "label": "destinations", - "description": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], "signature": [ - "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + "boolean | undefined" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 55 + "lineNumber": 134 }, "deprecated": false } @@ -13317,48 +12513,58 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportConflictError", + "id": "def-server.SavedObjectsImportUnknownError", "type": "Interface", "tags": [], - "label": "SavedObjectsImportConflictError", + "label": "SavedObjectsImportUnknownError", "description": [ - "\nRepresents a failure to import due to a conflict." + "\nRepresents a failure to import due to an unknown reason." ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 44 + "lineNumber": 70 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportConflictError.type", + "id": "def-server.SavedObjectsImportUnknownError.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ - "\"conflict\"" + "\"unknown\"" ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 45 + "lineNumber": 71 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportConflictError.destinationId", + "id": "def-server.SavedObjectsImportUnknownError.message", "type": "string", "tags": [], - "label": "destinationId", + "label": "message", "description": [], - "signature": [ - "string | undefined" - ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 46 + "lineNumber": 72 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 73 }, "deprecated": false } @@ -13367,192 +12573,187 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure", + "id": "def-server.SavedObjectsImportUnsupportedTypeError", "type": "Interface", "tags": [], - "label": "SavedObjectsImportFailure", + "label": "SavedObjectsImportUnsupportedTypeError", "description": [ - "\nRepresents a failure to import." + "\nRepresents a failure to import due to having an unsupported saved object type." ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 89 + "lineNumber": 62 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.id", + "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", "type": "string", "tags": [], - "label": "id", + "label": "type", "description": [], + "signature": [ + "\"unsupported_type\"" + ], "source": { "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 90 + "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.SavedObjectsImportFailure.type", + "id": "def-server.SavedObjectsIncrementCounterField.fieldName", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "fieldName", + "description": [ + "The field name to increment the counter by." + ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 91 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 163 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.title", - "type": "string", - "tags": [ - "deprecated" + "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", + "type": "number", + "tags": [], + "label": "incrementBy", + "description": [ + "The number to increment the field by (defaults to 1)." ], - "label": "title", - "description": [], "signature": [ - "string | undefined" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 95 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 165 }, - "deprecated": true, - "references": [] + "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.SavedObjectsImportFailure.meta", - "type": "Object", + "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", + "type": "CompoundType", "tags": [], - "label": "meta", - "description": [], + "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": [ - "{ title?: string | undefined; icon?: string | undefined; }" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 96 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 126 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.overwrite", - "type": "CompoundType", + "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", + "type": "Object", "tags": [], - "label": "overwrite", + "label": "migrationVersion", "description": [ - "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + "{@link SavedObjectsMigrationVersion}" ], "signature": [ - "boolean | undefined" + "SavedObjectsMigrationVersion", + " | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 100 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 128 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.error", + "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", "type": "CompoundType", "tags": [], - "label": "error", - "description": [], + "label": "refresh", + "description": [ + "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportConflictError", - "text": "SavedObjectsImportConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportAmbiguousConflictError", - "text": "SavedObjectsImportAmbiguousConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnsupportedTypeError", - "text": "SavedObjectsImportUnsupportedTypeError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportMissingReferencesError", - "text": "SavedObjectsImportMissingReferencesError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnknownError", - "text": "SavedObjectsImportUnknownError" - } + "boolean | \"wait_for\" | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 101 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 133 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportHookResult", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportHookResult", - "description": [ - "\nResult from a {@link SavedObjectsImportHook | import hook}\n" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 227 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportHookResult.warnings", - "type": "Array", + "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", + "type": "Uncategorized", "tags": [], - "label": "warnings", + "label": "upsertAttributes", "description": [ - "\nAn optional list of warnings to display in the UI when the import succeeds." + "\nAttributes to use when upserting the document if it doesn't exist." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, - "[] | undefined" + "Attributes | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 231 + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 137 }, "deprecated": false } @@ -13561,48 +12762,32 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportMissingReferencesError", + "id": "def-server.SavedObjectsMappingProperties", "type": "Interface", "tags": [], - "label": "SavedObjectsImportMissingReferencesError", + "label": "SavedObjectsMappingProperties", "description": [ - "\nRepresents a failure to import due to missing references." + "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 80 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 87 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportMissingReferencesError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"missing_references\"" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 81 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportMissingReferencesError.references", - "type": "Array", + "id": "def-server.SavedObjectsMappingProperties.Unnamed", + "type": "Any", "tags": [], - "label": "references", + "label": "Unnamed", "description": [], "signature": [ - "{ type: string; id: string; }[]" + "any" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 82 + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 88 }, "deprecated": false } @@ -13611,82 +12796,130 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions", + "id": "def-server.SavedObjectsMigrationLogger", "type": "Interface", "tags": [], - "label": "SavedObjectsImportOptions", - "description": [ - "\nOptions to control the import operation." - ], + "label": "SavedObjectsMigrationLogger", + "description": [], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 153 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 19 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.readStream", - "type": "Object", + "id": "def-server.SavedObjectsMigrationLogger.debug", + "type": "Function", "tags": [], - "label": "readStream", - "description": [ - "The stream of {@link SavedObject | saved objects} to import" - ], + "label": "debug", + "description": [], "signature": [ - "Readable" + "(msg: string) => void" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 155 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 20 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.overwrite", - "type": "boolean", + "id": "def-server.SavedObjectsMigrationLogger.info", + "type": "Function", "tags": [], - "label": "overwrite", - "description": [ - "If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option." + "label": "info", + "description": [], + "signature": [ + "(msg: string) => void" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 157 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 21 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "if specified, will import in given namespace, else will import as global object" + "id": "def-server.SavedObjectsMigrationLogger.warning", + "type": "Function", + "tags": [ + "deprecated" ], + "label": "warning", + "description": [], "signature": [ - "string | undefined" + "(msg: string) => void" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 159 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 25 + }, + "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 + } + } + ] + }, + { + "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 }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.createNewCopies", - "type": "boolean", + "id": "def-server.SavedObjectsMigrationLogger.error", + "type": "Function", "tags": [], - "label": "createNewCopies", - "description": [ - "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." + "label": "error", + "description": [], + "signature": [ + "(msg: string, meta: Meta) => void" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 161 + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27 }, "deprecated": false } @@ -13695,111 +12928,143 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse", + "id": "def-server.SavedObjectsOpenPointInTimeOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsImportResponse", - "description": [ - "\nThe response describing the result of an import." + "label": "SavedObjectsOpenPointInTimeOptions", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 141 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 326 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.success", - "type": "boolean", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", + "type": "string", "tags": [], - "label": "success", - "description": [], + "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/import/types.ts", - "lineNumber": 142 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 330 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.successCount", - "type": "number", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "type": "string", "tags": [], - "label": "successCount", - "description": [], + "label": "preference", + "description": [ + "\nAn optional ES preference value to be used for the query." + ], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 143 + "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.SavedObjectsImportResponse.successResults", - "type": "Array", + "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", + "type": "string", "tags": [], - "label": "successResults", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, - "[] | undefined" + "label": "id", + "description": [ + "\nPIT ID returned from ES." ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 144 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 344 }, "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsPitParams", + "type": "Interface", + "tags": [], + "label": "SavedObjectsPitParams", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 69 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.warnings", - "type": "Array", + "id": "def-server.SavedObjectsPitParams.id", + "type": "string", "tags": [], - "label": "warnings", + "label": "id", "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, - "[]" - ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 145 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 70 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.errors", - "type": "Array", + "id": "def-server.SavedObjectsPitParams.keepAlive", + "type": "string", "tags": [], - "label": "errors", + "label": "keepAlive", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportFailure", - "text": "SavedObjectsImportFailure" - }, - "[] | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 146 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 71 }, "deprecated": false } @@ -13808,125 +13073,77 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry", + "id": "def-server.SavedObjectsRawDoc", "type": "Interface", "tags": [], - "label": "SavedObjectsImportRetry", + "label": "SavedObjectsRawDoc", "description": [ - "\nDescribes a retry operation for importing a saved object." + "\nA raw document as represented directly in the saved object index.\n" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 16 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.type", + "id": "def-server.SavedObjectsRawDoc._id", "type": "string", "tags": [], - "label": "type", + "label": "_id", "description": [], "source": { - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/server/saved_objects/serialization/types.ts", "lineNumber": 17 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.id", - "type": "string", + "id": "def-server.SavedObjectsRawDoc._source", + "type": "Object", "tags": [], - "label": "id", + "label": "_source", "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 18 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.overwrite", - "type": "boolean", - "tags": [], - "label": "overwrite", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 19 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [ - "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." - ], "signature": [ - "string | undefined" + "SavedObjectsRawDocSource" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 23 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 18 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.replaceReferences", - "type": "Array", + "id": "def-server.SavedObjectsRawDoc._seq_no", + "type": "number", "tags": [], - "label": "replaceReferences", + "label": "_seq_no", "description": [], "signature": [ - "{ type: string; from: string; to: string; }[]" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 24 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.createNewCopy", - "type": "CompoundType", - "tags": [], - "label": "createNewCopy", - "description": [ - "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." - ], - "signature": [ - "boolean | undefined" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 33 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 19 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", - "type": "CompoundType", + "id": "def-server.SavedObjectsRawDoc._primary_term", + "type": "number", "tags": [], - "label": "ignoreMissingReferences", - "description": [ - "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." - ], + "label": "_primary_term", + "description": [], "signature": [ - "boolean | undefined" + "number | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 37 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 20 }, "deprecated": false } @@ -13935,47 +13152,34 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSimpleWarning", + "id": "def-server.SavedObjectsRawDocParseOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsImportSimpleWarning", + "label": "SavedObjectsRawDocParseOptions", "description": [ - "\nA simple informative warning that will be displayed to the user.\n" + "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 186 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 78 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSimpleWarning.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"simple\"" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 187 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSimpleWarning.message", - "type": "string", + "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", + "type": "CompoundType", "tags": [], - "label": "message", + "label": "namespaceTreatment", "description": [ - "The translated message to display to the user" + "\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" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 189 + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 86 }, "deprecated": false } @@ -13984,128 +13188,51 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess", + "id": "def-server.SavedObjectsRemoveReferencesToOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsImportSuccess", + "label": "SavedObjectsRemoveReferencesToOptions", "description": [ - "\nRepresents a successful import." + "\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 113 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 230 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 114 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 115 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [ - "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." - ], - "signature": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 119 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.createNewCopy", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "createNewCopy", - "description": [], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 126 - }, - "deprecated": true, - "references": [ - { - "plugin": "savedObjectsManagement", - "link": { - "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts", - "lineNumber": 223 - } - }, - { - "plugin": "spaces", - "link": { - "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx", - "lineNumber": 142 - } - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.meta", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 127 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.overwrite", + "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", "type": "CompoundType", "tags": [], - "label": "overwrite", + "label": "refresh", "description": [ - "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + "The Elasticsearch Refresh setting for this operation. Defaults to `true`" ], "signature": [ "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 134 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 232 }, "deprecated": false } @@ -14114,531 +13241,22 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError", + "id": "def-server.SavedObjectsRemoveReferencesToResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsImportUnknownError", + "label": "SavedObjectsRemoveReferencesToResponse", "description": [ - "\nRepresents a failure to import due to an unknown reason." - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 70 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"unknown\"" - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 71 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError.message", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 72 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 73 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnsupportedTypeError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportUnsupportedTypeError", - "description": [ - "\nRepresents a failure to import due to having an unsupported saved object type." - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 62 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "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 - } + "\n" ], - "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" + "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/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": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 88 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger", - "type": "Interface", - "tags": [], - "label": "SavedObjectsMigrationLogger", - "description": [], - "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 19 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.debug", - "type": "Function", - "tags": [], - "label": "debug", - "description": [], - "signature": [ - "(msg: string) => void" - ], - "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 20 - }, - "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.SavedObjectsMigrationLogger.info", - "type": "Function", - "tags": [], - "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": [ - "(msg: string) => void" - ], - "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 25 - }, - "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.ts", - "lineNumber": 245 - } - }, - { - "plugin": "lens", - "link": { - "path": "x-pack/plugins/lens/server/migrations.ts", - "lineNumber": 312 - } - } - ], - "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.SavedObjectsOpenPointInTimeOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsOpenPointInTimeOptions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - " extends ", + " extends ", { "pluginId": "core", "scope": "server", @@ -14649,1902 +13267,100 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 326 - }, - "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", - "tags": [], - "label": "preference", - "description": [ - "\nAn optional ES preference value to be used for the query." - ], - "signature": [ - "string | undefined" - ], - "source": { - "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.SavedObjectsOpenPointInTimeResponse.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\nPIT ID returned from ES." - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 344 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams", - "type": "Interface", - "tags": [], - "label": "SavedObjectsPitParams", - "description": [], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 69 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams.id", - "type": "string", - "tags": [], - "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": [ - "string | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 71 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRawDoc", - "description": [ - "\nA raw document as represented directly in the saved object index.\n" - ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 16 - }, - "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", - "type": "Object", - "tags": [], - "label": "_source", - "description": [], - "signature": [ - "SavedObjectsRawDocSource" - ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 18 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._seq_no", - "type": "number", - "tags": [], - "label": "_seq_no", - "description": [], - "signature": [ - "number | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 19 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._primary_term", - "type": "number", - "tags": [], - "label": "_primary_term", - "description": [], - "signature": [ - "number | undefined" - ], - "source": { - "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.SavedObjectsRawDocParseOptions.namespaceTreatment", - "type": "CompoundType", - "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" - ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 86 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRemoveReferencesToOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " 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 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation. Defaults to `true`" - ], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 232 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToResponse", - "type": "Interface", - "tags": [], - "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": 239 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", - "type": "number", - "tags": [], - "label": "updated", - "description": [ - "The number of objects that have been updated by this operation" - ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 241 - }, - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory", - "type": "Interface", - "tags": [], - "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/saved_objects_service.ts", - "lineNumber": 226 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.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": 234 - }, - "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.SavedObjectsRepositoryFactory.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": 244 - }, - "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.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 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", - "type": "Array", - "tags": [], - "label": "retries", - "description": [ - "saved object import references to retry" - ], - "signature": [ - { - "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.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 - } - ], - "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": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", - "type": "Function", - "tags": [], - "label": "setClientFactoryProvider", - "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." - ], - "signature": [ - "(clientFactoryProvider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientFactoryProvider", - "text": "SavedObjectsClientFactoryProvider" - }, - ") => void" - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 90 - }, - "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.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", - "type": "Function", - "tags": [], - "label": "getScopedClient", - "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}." - ], - "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<", - { - "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, - "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.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, - "returnComment": [], - "children": [ - { - "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.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, - "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.SavedObjectsServiceStart.createSerializer", - "type": "Function", - "tags": [], - "label": "createSerializer", - "description": [ - "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsSerializer", - "text": "SavedObjectsSerializer" - } - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 202 - }, - "deprecated": false, - "returnComment": [], - "children": [] - }, - { - "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, - "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.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, - "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 - } - ] - }, + "lineNumber": 239 + }, + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", - "type": "Function", + "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", + "type": "number", "tags": [], - "label": "getTypeRegistry", + "label": "updated", "description": [ - "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" - ], - "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\">" + "The number of objects that have been updated by this operation" ], "source": { - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "lineNumber": 215 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 241 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectStatusMeta", + "id": "def-server.SavedObjectsRepositoryFactory", "type": "Interface", "tags": [], - "label": "SavedObjectStatusMeta", + "label": "SavedObjectsRepositoryFactory", "description": [ - "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" + "\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": 50 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 226 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectStatusMeta.migratedIndices", - "type": "Object", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", + "type": "Function", "tags": [], - "label": "migratedIndices", - "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": [ - "{ [status: string]: number; skipped: number; migrated: number; }" + "(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": 51 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 234 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepositoryFactory.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": 244 }, "deprecated": false } @@ -16553,198 +13369,269 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType", + "id": "def-server.SavedObjectsResolveImportErrorsOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsType", - "description": [], + "label": "SavedObjectsResolveImportErrorsOptions", + "description": [ + "\nOptions to control the \"resolve import\" operation." + ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 256 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 168 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.name", - "type": "string", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", + "type": "Object", "tags": [], - "label": "name", + "label": "readStream", "description": [ - "\nThe name of the type, which is also used as the internal id." + "The stream of {@link SavedObject | saved objects} to resolve errors from" + ], + "signature": [ + "Readable" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 260 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 170 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.hidden", - "type": "boolean", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", + "type": "Array", "tags": [], - "label": "hidden", + "label": "retries", "description": [ - "\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}." + "saved object import references to retry" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportRetry", + "text": "SavedObjectsImportRetry" + }, + "[]" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 267 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 172 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.namespaceType", - "type": "CompoundType", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", + "type": "string", "tags": [], - "label": "namespaceType", + "label": "namespace", "description": [ - "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." + "if specified, will import in given namespace" ], "signature": [ - "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 271 + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 174 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.indexPattern", - "type": "string", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", + "type": "boolean", "tags": [], - "label": "indexPattern", + "label": "createNewCopies", "description": [ - "\nIf defined, the type instances will be stored in the given index instead of the default one." + "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": [ - "string | undefined" + "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 275 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 316 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.convertToAliasScript", + "id": "def-server.SavedObjectsResolveResponse.aliasTargetId", "type": "string", "tags": [], - "label": "convertToAliasScript", + "label": "aliasTargetId", "description": [ - "\nIf defined, will be used to convert the type to an alias." + "\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/types.ts", - "lineNumber": 279 + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 320 }, "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": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.mappings", - "type": "Object", + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", + "type": "Function", "tags": [], - "label": "mappings", + "label": "setClientFactoryProvider", "description": [ - "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." + "\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.SavedObjectsTypeMappingDefinition", - "text": "SavedObjectsTypeMappingDefinition" - } + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" + }, + ") => void" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 283 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 90 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.migrations", - "type": "CompoundType", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", + "type": "Function", "tags": [], - "label": "migrations", + "label": "addClientWrapper", "description": [ - "\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type." + "\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.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - " | (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" }, - ") | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 287 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion", - "type": "string", - "tags": [], - "label": "convertToMultiNamespaceTypeVersion", - "description": [ - "\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process." - ], - "signature": [ - "string | undefined" + ") => void" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 336 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 95 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsType.management", - "type": "Object", + "id": "def-server.SavedObjectsServiceSetup.registerType", + "type": "Function", "tags": [], - "label": "management", + "label": "registerType", "description": [ - "\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type." + "\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.SavedObjectsTypeManagementDefinition", - "text": "SavedObjectsTypeManagementDefinition" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - " | undefined" + ") => void" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 340 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 144 }, "deprecated": false } @@ -16753,180 +13640,237 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition", + "id": "def-server.SavedObjectsServiceStart", "type": "Interface", "tags": [], - "label": "SavedObjectsTypeManagementDefinition", + "label": "SavedObjectsServiceStart", "description": [ - "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\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/types.ts", - "lineNumber": 348 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 162 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", - "type": "CompoundType", - "tags": [], - "label": "importableAndExportable", - "description": [ - "\nIs the type importable or exportable. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 352 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", - "type": "string", + "id": "def-server.SavedObjectsServiceStart.getScopedClient", + "type": "Function", "tags": [], - "label": "defaultSearchField", + "label": "getScopedClient", "description": [ - "\nThe default search field to use for this type. Defaults to `id`." + "\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": [ - "string | undefined" + "(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<", + { + "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/types.ts", - "lineNumber": 356 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 172 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.icon", - "type": "string", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository", + "type": "Function", "tags": [], - "label": "icon", + "label": "createScopedRepository", "description": [ - "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" ], "signature": [ - "string | undefined" + "(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": 361 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 188 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", + "id": "def-server.SavedObjectsServiceStart.createInternalRepository", "type": "Function", "tags": [], - "label": "getTitle", + "label": "createInternalRepository", "description": [ - "\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label." + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" ], "signature": [ - "((savedObject: ", - "SavedObject", - ") => 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": 366 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 198 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", + "id": "def-server.SavedObjectsServiceStart.createSerializer", "type": "Function", "tags": [], - "label": "getEditUrl", + "label": "createSerializer", "description": [ - "\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed." + "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." ], "signature": [ - "((savedObject: ", - "SavedObject", - ") => string) | undefined" + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsSerializer", + "text": "SavedObjectsSerializer" + } ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 371 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 202 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", + "id": "def-server.SavedObjectsServiceStart.createExporter", "type": "Function", "tags": [], - "label": "getInAppUrl", + "label": "createExporter", "description": [ - "\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n" + "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." ], "signature": [ - "((savedObject: ", - "SavedObject", - ") => { path: string; uiCapabilitiesPath: string; }) | undefined" + "(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/types.ts", - "lineNumber": 380 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 206 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", + "id": "def-server.SavedObjectsServiceStart.createImporter", "type": "Function", "tags": [], - "label": "onExport", + "label": "createImporter", "description": [ - "\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n" + "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." ], "signature": [ + "(client: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportTransform", - "text": "SavedObjectsExportTransform" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - " | undefined" + ", \"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/types.ts", - "lineNumber": 391 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 210 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", + "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", "type": "Function", "tags": [], - "label": "onImport", + "label": "getTypeRegistry", "description": [ - "\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n" + "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" ], "signature": [ + "() => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportHook", - "text": "SavedObjectsImportHook" + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" }, - " | undefined" + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" ], "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 434 + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 215 }, "deprecated": false } @@ -16935,200 +13879,238 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeMappingDefinition", + "id": "def-server.SavedObjectStatusMeta", "type": "Interface", "tags": [], - "label": "SavedObjectsTypeMappingDefinition", + "label": "SavedObjectStatusMeta", "description": [ - "\nDescribe a saved object type mapping.\n" + "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 36 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 50 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", - "type": "CompoundType", + "id": "def-server.SavedObjectStatusMeta.migratedIndices", + "type": "Object", "tags": [], - "label": "dynamic", + "label": "migratedIndices", + "description": [], + "signature": [ + "{ [status: string]: number; skipped: number; migrated: number; }" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 51 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsType", + "type": "Interface", + "tags": [], + "label": "SavedObjectsType", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 256 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.name", + "type": "string", + "tags": [], + "label": "name", "description": [ - "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." + "\nThe name of the type, which is also used as the internal id." ], - "signature": [ - "false | \"strict\" | undefined" + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 260 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.hidden", + "type": "boolean", + "tags": [], + "label": "hidden", + "description": [ + "\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}." ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 40 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 267 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeMappingDefinition.properties", - "type": "Object", + "id": "def-server.SavedObjectsType.namespaceType", + "type": "CompoundType", "tags": [], - "label": "properties", + "label": "namespaceType", "description": [ - "The underlying properties of the type mapping" + "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMappingProperties", - "text": "SavedObjectsMappingProperties" + "section": "def-server.SavedObjectsNamespaceType", + "text": "SavedObjectsNamespaceType" } ], "source": { - "path": "src/core/server/saved_objects/mappings/types.ts", - "lineNumber": 42 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 271 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesObject", - "description": [ - "\nAn object that should have its spaces updated.\n" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 34 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id", + "id": "def-server.SavedObjectsType.indexPattern", "type": "string", "tags": [], - "label": "id", + "label": "indexPattern", "description": [ - "The type of the object to update" + "\nIf defined, the type instances will be stored in the given index instead of the default one." + ], + "signature": [ + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 36 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 275 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type", + "id": "def-server.SavedObjectsType.convertToAliasScript", "type": "string", "tags": [], - "label": "type", + "label": "convertToAliasScript", "description": [ - "The ID of the object to update" + "\nIf defined, will be used to convert the type to an alias." + ], + "signature": [ + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 38 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 279 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesOptions", - "description": [ - "\nOptions for the update operation.\n" - ], - "signature": [ + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.mappings", + "type": "Object", + "tags": [], + "label": "mappings", + "description": [ + "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeMappingDefinition", + "text": "SavedObjectsTypeMappingDefinition" + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 283 + }, + "deprecated": false }, - " extends ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 58 - }, - "deprecated": false, - "children": [ + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.migrations", + "type": "CompoundType", + "tags": [], + "label": "migrations", + "description": [ + "\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + " | (() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ") | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 287 + }, + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.refresh", - "type": "CompoundType", + "id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion", + "type": "string", "tags": [], - "label": "refresh", + "label": "convertToMultiNamespaceTypeVersion", "description": [ - "The Elasticsearch Refresh setting for this operation" + "\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process." ], "signature": [ - "boolean | \"wait_for\" | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 60 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 336 }, "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesResponse", - "description": [ - "\nThe response when objects' spaces are updated.\n" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 68 - }, - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects", - "type": "Array", + "id": "def-server.SavedObjectsType.management", + "type": "Object", "tags": [], - "label": "objects", - "description": [], + "label": "management", + "description": [ + "\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type." + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", - "text": "SavedObjectsUpdateObjectsSpacesResponseObject" + "section": "def-server.SavedObjectsTypeManagementDefinition", + "text": "SavedObjectsTypeManagementDefinition" }, - "[]" + " | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 69 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 340 }, "deprecated": false } @@ -17137,548 +14119,304 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", + "id": "def-server.SavedObjectsTypeManagementDefinition", "type": "Interface", "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesResponseObject", + "label": "SavedObjectsTypeManagementDefinition", "description": [ - "\nDetails about a specific object's update result.\n" + "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 77 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 348 }, "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 79 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 81 - }, - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces", - "type": "Array", + "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", + "type": "CompoundType", "tags": [], - "label": "spaces", + "label": "importableAndExportable", "description": [ - "The space(s) that the referenced object exists in" + "\nIs the type importable or exportable. Defaults to `false`." ], "signature": [ - "string[]" + "boolean | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 83 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 352 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error", - "type": "Object", + "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", + "type": "string", "tags": [], - "label": "error", + "label": "defaultSearchField", "description": [ - "Included if there was an error updating this object's spaces" + "\nThe default search field to use for this type. Defaults to `id`." ], "signature": [ - "SavedObjectError", - " | undefined" + "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "lineNumber": 85 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 356 }, "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", + "id": "def-server.SavedObjectsTypeManagementDefinition.icon", "type": "string", "tags": [], - "label": "version", + "label": "icon", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." ], "signature": [ "string | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 217 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 361 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.references", - "type": "Array", + "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", + "type": "Function", "tags": [], - "label": "references", + "label": "getTitle", "description": [ - "{@inheritdoc SavedObjectReference}" + "\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label." ], "signature": [ - "SavedObjectReference", - "[] | undefined" + "((savedObject: ", + "SavedObject", + ") => string) | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 219 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 366 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.refresh", - "type": "CompoundType", + "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", + "type": "Function", "tags": [], - "label": "refresh", + "label": "getEditUrl", "description": [ - "The Elasticsearch Refresh setting for this operation" + "\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed." ], "signature": [ - "boolean | \"wait_for\" | undefined" + "((savedObject: ", + "SavedObject", + ") => string) | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 221 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 371 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.upsert", - "type": "Uncategorized", + "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", + "type": "Function", "tags": [], - "label": "upsert", + "label": "getInAppUrl", "description": [ - "If specified, will be used to perform an upsert if the document doesn't exist" + "\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n" ], "signature": [ - "Attributes | undefined" + "((savedObject: ", + "SavedObject", + ") => { path: string; uiCapabilitiesPath: string; }) | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 223 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 380 }, "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", + "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", + "type": "Function", "tags": [], - "label": "attributes", - "description": [], + "label": "onExport", + "description": [ + "\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n" + ], "signature": [ - "{ [P in keyof T]?: T[P] | undefined; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportTransform", + "text": "SavedObjectsExportTransform" + }, + " | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 297 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 391 }, "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse.references", - "type": "Array", + "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", + "type": "Function", "tags": [], - "label": "references", - "description": [], + "label": "onImport", + "description": [ + "\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n" + ], "signature": [ - "SavedObjectReference", - "[] | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportHook", + "text": "SavedObjectsImportHook" + }, + " | undefined" ], "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 298 + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 434 }, "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": 31 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter", - "type": "Type", - "tags": [], - "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", + "id": "def-server.SavedObjectsTypeMappingDefinition", + "type": "Interface", "tags": [], - "label": "ISavedObjectsRepository", + "label": "SavedObjectsTypeMappingDefinition", "description": [ - "\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: ", + "\nDescribe a saved object type mapping.\n" + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 36 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", + "type": "CompoundType", + "tags": [], + "label": "dynamic", + "description": [ + "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." + ], + "signature": [ + "false | \"strict\" | undefined" + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 40 + }, + "deprecated": false }, - "[], options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeMappingDefinition.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [ + "The underlying properties of the type mapping" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" + } + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 42 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesObject", + "description": [ + "\nAn object that should have its spaces updated.\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 34 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The type of the object to update" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 36 + }, + "deprecated": false }, - ">; updateObjectsSpaces: (objects: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The ID of the object to update" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 38 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesOptions", + "description": [ + "\nOptions for the update operation.\n" + ], + "signature": [ { "pluginId": "core", "scope": "server", @@ -17686,129 +14424,407 @@ "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", "text": "SavedObjectsUpdateObjectsSpacesOptions" }, - " | undefined) => Promise<", + " extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 58 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.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/lib/update_objects_spaces.ts", + "lineNumber": 60 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesResponse", + "description": [ + "\nThe response when objects' spaces are updated.\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 68 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", + "text": "SavedObjectsUpdateObjectsSpacesResponseObject" + }, + "[]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 69 + }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesResponseObject", + "description": [ + "\nDetails about a specific object's update result.\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 77 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The type of the referenced object" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 79 + }, + "deprecated": false }, - ") => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the referenced object" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", + "lineNumber": 81 + }, + "deprecated": false }, - ">; removeReferencesTo: (type: string, id: string, options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" + "parentPluginId": "core", + "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 }, - ") => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; incrementCounter: (type: string, id: string, counterFields: (string | ", + "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.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" }, - ")[], options?: ", + " extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" - }, - ") => Promise<", - "SavedObject", - ">; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: ", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 215 + }, + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "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 }, - ") => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" + "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 }, - ">; closePointInTime: (id: string, options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "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 }, - " | undefined) => Promise<", + { + "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.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" }, - ">; createPointInTimeFinder: (findOptions: Pick<", + " 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": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "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 }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", + { + "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.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" }, - " | undefined) => ", + ">; updateObjectsSpaces: (objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], spacesToRemove: string[], options?: SavedObjectsUpdateObjectsSpacesOptions | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" }, - "; }" + ">; 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", @@ -17827,39 +14843,7 @@ "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" ], "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; }" + "{ 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; }" ], "source": { "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", @@ -17878,7 +14862,7 @@ "\nElasticsearch Refresh setting for mutating operation" ], "signature": [ - "boolean | \"wait_for\"" + "false | true | \"wait_for\"" ], "source": { "path": "src/core/server/saved_objects/types.ts", @@ -17959,17 +14943,7 @@ "\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?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; delete: (type: string, id: string, options?: ", + "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", @@ -17977,7 +14951,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", @@ -17985,9 +14959,7 @@ "section": "def-server.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", + " | undefined) => Promise>; bulkCreate: (objects: ", { "pluginId": "core", "scope": "server", @@ -18010,256 +14982,7 @@ "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", @@ -18278,7 +15001,7 @@ "\nDescribes the factory used to create instances of the Saved Objects Client." ], "signature": [ - "({ request, includedHiddenTypes, }: { request: ", + "(__0: { request: ", { "pluginId": "core", "scope": "server", @@ -18380,13 +15103,7 @@ "label": "SavedObjectsClosePointInTimeOptions", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "SavedObjectsBaseOptions" ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", @@ -18403,9 +15120,7 @@ "label": "SavedObjectsCreatePointInTimeFinderOptions", "description": [], "signature": [ - "{ 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?: ", + "{ 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?: ", { "pluginId": "core", "scope": "server", @@ -18421,7 +15136,7 @@ "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, - "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; }" + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; }" ], "source": { "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", @@ -18440,7 +15155,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 9c3dccb95bc07..cbef00025320b 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -42,8 +42,7 @@ "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" - }, - ">" + } ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", @@ -243,8 +242,7 @@ ", partial?: Partial) => ", - "DashboardPanelState", - "" + "DashboardPanelState" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", @@ -541,24 +539,7 @@ "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", @@ -742,10 +723,7 @@ "docId": "kibDashboardPluginApi", "section": "def-public.DashboardContainer", "text": "DashboardContainer" - }, - ", ", - "SavedObjectAttributes", - ">" + } ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", @@ -872,7 +850,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "() => string" + "() => any" ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", @@ -955,16 +933,7 @@ "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", @@ -1069,43 +1038,7 @@ "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "lineNumber": 74 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "dashboard", @@ -1139,26 +1072,7 @@ "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "lineNumber": 76 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -1321,7 +1235,7 @@ "label": "dashboardCapabilities", "description": [], "signature": [ - "DashboardCapabilities", + "DashboardAppCapabilities", " | undefined" ], "source": { @@ -1406,7 +1320,13 @@ "label": "timeRange", "description": [], "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", @@ -1525,7 +1445,13 @@ "label": "query", "description": [], "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", @@ -1571,7 +1497,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 91 + "lineNumber": 92 }, "deprecated": false, "children": [ @@ -1584,7 +1510,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 92 + "lineNumber": 93 }, "deprecated": false } @@ -1787,119 +1713,7 @@ "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: () => ", + "Pick<", { "pluginId": "data", "scope": "common", @@ -1907,63 +1721,7 @@ "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", - "[]; }; }" + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "source": { "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", @@ -2036,26 +1794,7 @@ "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "lineNumber": 33 }, - "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": 33 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2361,18 +2100,11 @@ "label": "DashboardUrlGenerator", "description": [], "signature": [ - { - "pluginId": "share", - "scope": "public", - "docId": "kibSharePluginApi", - "section": "def-public.UrlGeneratorContract", - "text": "UrlGeneratorContract" - }, - "<\"DASHBOARD_APP_URL_GENERATOR\">" + "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 89 + "lineNumber": 90 }, "deprecated": false, "initialIsOpen": false @@ -2387,19 +2119,11 @@ "\nThis should always represent the latest dashboard panel shape, after all possible migrations." ], "signature": [ - "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; }" + "Pick & { readonly id?: string | undefined; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 38 + "lineNumber": 46 }, "deprecated": false, "initialIsOpen": false @@ -2539,7 +2263,7 @@ ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 123 + "lineNumber": 124 }, "deprecated": false, "lifecycle": "setup", @@ -2554,7 +2278,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 125 + "lineNumber": 126 }, "deprecated": false, "children": [ @@ -2577,11 +2301,9 @@ ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 126 + "lineNumber": 127 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "dashboard", @@ -2595,11 +2317,9 @@ ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 127 + "lineNumber": 128 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "dashboard", @@ -2620,7 +2340,7 @@ ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 130 + "lineNumber": 131 }, "deprecated": false }, @@ -2642,7 +2362,7 @@ ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 131 + "lineNumber": 132 }, "deprecated": false } @@ -2788,40 +2508,7 @@ "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", @@ -2852,32 +2539,7 @@ "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", @@ -2983,7 +2645,7 @@ ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 91 + "lineNumber": 99 }, "deprecated": false, "children": [ @@ -3009,7 +2671,7 @@ ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 92 + "lineNumber": 100 }, "deprecated": false } @@ -3159,9 +2821,7 @@ "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", @@ -3178,13 +2838,11 @@ "label": "SavedDashboardPanel610", "description": [], "signature": [ - "Pick<", - "RawSavedDashboardPanel610", - ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }" + "Pick & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 64 + "lineNumber": 72 }, "deprecated": false, "initialIsOpen": false @@ -3197,13 +2855,11 @@ "label": "SavedDashboardPanel620", "description": [], "signature": [ - "Pick<", - "RawSavedDashboardPanel620", - ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + "Pick & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 56 + "lineNumber": 64 }, "deprecated": false, "initialIsOpen": false @@ -3216,13 +2872,11 @@ "label": "SavedDashboardPanel630", "description": [], "signature": [ - "Pick<", - "RawSavedDashboardPanel620", - ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + "Pick & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 48 + "lineNumber": 56 }, "deprecated": false, "initialIsOpen": false @@ -3235,13 +2889,11 @@ "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", - "lineNumber": 40 + "lineNumber": 48 }, "deprecated": false, "initialIsOpen": false @@ -3254,19 +2906,11 @@ "label": "SavedDashboardPanel730ToLatest", "description": [], "signature": [ - "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; }" + "Pick & { readonly id?: string | undefined; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 81 + "lineNumber": 89 }, "deprecated": false, "initialIsOpen": false @@ -3279,13 +2923,11 @@ "label": "SavedDashboardPanelTo60", "description": [], "signature": [ - "Pick<", - "RawSavedDashboardPanelTo60", - ", \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }" + "Pick & { readonly id: string; readonly type: string; }" ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 72 + "lineNumber": 80 }, "deprecated": false, "initialIsOpen": false diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json index 30daac1b26395..087fc838bb959 100644 --- a/api_docs/dashboard_enhanced.json +++ b/api_docs/dashboard_enhanced.json @@ -118,9 +118,7 @@ "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 40 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "dashboardEnhanced", @@ -221,7 +219,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "() => string" + "() => any" ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", @@ -255,13 +253,12 @@ "label": "CollectConfig", "description": [], "signature": [ - "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.UiComponentInstance", - "text": "UiComponentInstance" + "section": "def-common.UiComponent", + "text": "UiComponent" }, "<", { @@ -293,9 +290,7 @@ "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "lineNumber": 54 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "dashboardEnhanced", @@ -515,13 +510,12 @@ "description": [], "signature": [ { - "pluginId": "share", + "pluginId": "dashboard", "scope": "public", - "docId": "kibSharePluginApi", - "section": "def-public.UrlGeneratorContract", - "text": "UrlGeneratorContract" - }, - "<\"DASHBOARD_APP_URL_GENERATOR\">" + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardUrlGenerator", + "text": "DashboardUrlGenerator" + } ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", @@ -556,13 +550,12 @@ "label": "start", "description": [], "signature": [ - "() => ", { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.StartServices", - "text": "StartServices" + "section": "def-public.StartServicesGetter", + "text": "StartServicesGetter" }, "<{ uiActionsEnhanced: ", { @@ -595,16 +588,13 @@ "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, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -674,17 +664,13 @@ "label": "share", "description": [], "signature": [ - "{ register: (shareMenuProvider: ", { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", - "section": "def-public.ShareMenuProvider", - "text": "ShareMenuProvider" - }, - ") => void; } & { urlGenerators: ", - "UrlGeneratorsSetup", - "; }" + "section": "def-public.SharePluginSetup", + "text": "SharePluginSetup" + } ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", @@ -782,17 +768,13 @@ "label": "share", "description": [], "signature": [ - "{ toggleShareContextMenu: (options: ", { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", - "section": "def-public.ShowShareMenuOptions", - "text": "ShowShareMenuOptions" - }, - ") => void; } & { urlGenerators: ", - "UrlGeneratorsStart", - "; }" + "section": "def-public.SharePluginStart", + "text": "SharePluginStart" + } ], "source": { "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", diff --git a/api_docs/data.json b/api_docs/data.json index 1ba62ea994654..83e706e9a0f54 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -11,7 +11,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 55 + "lineNumber": 57 }, "deprecated": false, "children": [ @@ -27,11 +27,19 @@ "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" ], "signature": [ - "(list: any[]) => any[]" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ".ensureIds" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 63 + "lineNumber": 65 }, "deprecated": false, "children": [ @@ -49,7 +57,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 63 + "lineNumber": 65 }, "deprecated": false, "isRequired": true @@ -71,7 +79,7 @@ "\nCalculate the next id based on the ids in this list\n" ], "signature": [ - "(list: ", + "typeof ", { "pluginId": "data", "scope": "common", @@ -79,11 +87,11 @@ "section": "def-common.AggConfig", "text": "AggConfig" }, - "[]) => number" + ".nextId" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 83 + "lineNumber": 85 }, "deprecated": false, "children": [ @@ -106,7 +114,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 83 + "lineNumber": 85 }, "deprecated": false, "isRequired": true @@ -134,7 +142,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 92 + "lineNumber": 94 }, "deprecated": false }, @@ -147,7 +155,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 93 + "lineNumber": 95 }, "deprecated": false }, @@ -160,7 +168,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 94 + "lineNumber": 96 }, "deprecated": false }, @@ -176,7 +184,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 95 + "lineNumber": 97 }, "deprecated": false }, @@ -199,7 +207,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 96 + "lineNumber": 98 }, "deprecated": false }, @@ -215,7 +223,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 97 + "lineNumber": 99 }, "deprecated": false }, @@ -231,7 +239,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 98 + "lineNumber": 100 }, "deprecated": false }, @@ -247,7 +255,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 + "lineNumber": 106 }, "deprecated": false, "children": [ @@ -269,7 +277,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 + "lineNumber": 106 }, "deprecated": false, "isRequired": true @@ -304,7 +312,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 + "lineNumber": 106 }, "deprecated": false, "isRequired": true @@ -328,7 +336,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 134 + "lineNumber": 136 }, "deprecated": false, "children": [ @@ -346,7 +354,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 134 + "lineNumber": 136 }, "deprecated": false, "isRequired": true @@ -366,7 +374,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 171 + "lineNumber": 173 }, "deprecated": false, "children": [ @@ -382,7 +390,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 171 + "lineNumber": 173 }, "deprecated": false, "isRequired": true @@ -390,6 +398,42 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-public.AggConfig.hasTimeShift", + "type": "Function", + "tags": [], + "label": "hasTimeShift", + "description": [], + "signature": [ + "() => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 177 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfig.getTimeShift", + "type": "Function", + "tags": [], + "label": "getTimeShift", + "description": [], + "signature": [ + "() => moment.Duration | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 181 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-public.AggConfig.write", @@ -410,7 +454,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 175 + "lineNumber": 202 }, "deprecated": false, "children": [ @@ -433,7 +477,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 175 + "lineNumber": 202 }, "deprecated": false, "isRequired": false @@ -453,7 +497,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 179 + "lineNumber": 206 }, "deprecated": false, "children": [], @@ -471,7 +515,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 + "lineNumber": 210 }, "deprecated": false, "children": [ @@ -487,7 +531,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 + "lineNumber": 210 }, "deprecated": false, "isRequired": true @@ -504,7 +548,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 + "lineNumber": 210 }, "deprecated": false, "isRequired": true @@ -544,7 +588,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 + "lineNumber": 236 }, "deprecated": false, "children": [ @@ -568,7 +612,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 + "lineNumber": 236 }, "deprecated": false, "isRequired": true @@ -592,7 +636,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 + "lineNumber": 236 }, "deprecated": false, "isRequired": false @@ -624,7 +668,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 230 + "lineNumber": 257 }, "deprecated": false, "children": [ @@ -649,7 +693,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 230 + "lineNumber": 257 }, "deprecated": false, "isRequired": false @@ -673,7 +717,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 265 + "lineNumber": 292 }, "deprecated": false, "children": [], @@ -697,7 +741,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 296 + "lineNumber": 323 }, "deprecated": true, "references": [ @@ -726,7 +770,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 307 + "lineNumber": 334 }, "deprecated": false, "children": [], @@ -752,7 +796,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 316 + "lineNumber": 343 }, "deprecated": false, "children": [], @@ -788,7 +832,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 371 + "lineNumber": 398 }, "deprecated": false, "children": [], @@ -814,7 +858,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 375 + "lineNumber": 402 }, "deprecated": false, "children": [], @@ -840,7 +884,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 379 + "lineNumber": 406 }, "deprecated": false, "children": [], @@ -858,7 +902,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 383 + "lineNumber": 410 }, "deprecated": false, "children": [ @@ -874,7 +918,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 383 + "lineNumber": 410 }, "deprecated": false, "isRequired": true @@ -894,7 +938,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 + "lineNumber": 414 }, "deprecated": false, "children": [ @@ -910,7 +954,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 + "lineNumber": 414 }, "deprecated": false, "isRequired": true @@ -927,7 +971,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 + "lineNumber": 414 }, "deprecated": false, "isRequired": false @@ -947,7 +991,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 395 + "lineNumber": 422 }, "deprecated": false, "children": [], @@ -965,7 +1009,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 401 + "lineNumber": 428 }, "deprecated": false, "children": [], @@ -985,7 +1029,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 410 + "lineNumber": 437 }, "deprecated": false, "children": [], @@ -1003,7 +1047,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 414 + "lineNumber": 441 }, "deprecated": false, "children": [ @@ -1019,7 +1063,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 414 + "lineNumber": 441 }, "deprecated": false, "isRequired": true @@ -1046,7 +1090,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 428 + "lineNumber": 455 }, "deprecated": false, "children": [], @@ -1072,7 +1116,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 432 + "lineNumber": 459 }, "deprecated": false, "children": [], @@ -1090,7 +1134,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 436 + "lineNumber": 463 }, "deprecated": false, "children": [], @@ -1108,7 +1152,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 441 + "lineNumber": 468 }, "deprecated": false, "children": [], @@ -1126,38 +1170,13 @@ "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" - }, - ">>" + "section": "def-common.IAggType", + "text": "IAggType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 452 + "lineNumber": 479 }, "deprecated": false }, @@ -1173,38 +1192,13 @@ "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" - }, - ">>" + "section": "def-common.IAggType", + "text": "IAggType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 456 + "lineNumber": 483 }, "deprecated": false }, @@ -1228,7 +1222,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 486 + "lineNumber": 513 }, "deprecated": false, "children": [ @@ -1250,7 +1244,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 486 + "lineNumber": 513 }, "deprecated": false, "isRequired": true @@ -1270,7 +1264,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 + "lineNumber": 76 }, "deprecated": false, "children": [ @@ -1292,7 +1286,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 66 + "lineNumber": 77 }, "deprecated": false }, @@ -1315,7 +1309,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 67 + "lineNumber": 78 }, "deprecated": false }, @@ -1331,7 +1325,23 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 68 + "lineNumber": 79 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.forceNow", + "type": "Object", + "tags": [], + "label": "forceNow", + "description": [], + "signature": [ + "Date | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 80 }, "deprecated": false }, @@ -1347,7 +1357,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 69 + "lineNumber": 81 }, "deprecated": false }, @@ -1370,7 +1380,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 + "lineNumber": 85 }, "deprecated": false }, @@ -1386,7 +1396,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 + "lineNumber": 87 }, "deprecated": false, "children": [ @@ -1408,7 +1418,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 76 + "lineNumber": 88 }, "deprecated": false, "isRequired": true @@ -1443,7 +1453,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 77 + "lineNumber": 89 }, "deprecated": false, "isRequired": true @@ -1466,7 +1476,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 78 + "lineNumber": 90 }, "deprecated": false, "isRequired": true @@ -1486,7 +1496,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 103 }, "deprecated": false, "children": [ @@ -1502,7 +1512,43 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 103 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.setForceNow", + "type": "Function", + "tags": [], + "label": "setForceNow", + "description": [], + "signature": [ + "(now: Date | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 107 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.setForceNow.$1", + "type": "Object", + "tags": [], + "label": "now", + "description": [], + "signature": [ + "Date | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 107 }, "deprecated": false, "isRequired": false @@ -1530,7 +1576,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 95 + "lineNumber": 111 }, "deprecated": false, "children": [ @@ -1552,7 +1598,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 95 + "lineNumber": 111 }, "deprecated": false, "isRequired": true @@ -1579,7 +1625,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 113 + "lineNumber": 129 }, "deprecated": false, "children": [ @@ -1595,7 +1641,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 113 + "lineNumber": 129 }, "deprecated": false, "isRequired": true @@ -1644,12 +1690,11 @@ "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", - "lineNumber": 126 + "lineNumber": 142 }, "deprecated": false, "children": [ @@ -1683,7 +1728,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 127 + "lineNumber": 143 }, "deprecated": false, "isRequired": true @@ -1700,7 +1745,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 128 + "lineNumber": 144 }, "deprecated": false, "isRequired": true @@ -1730,7 +1775,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 169 + "lineNumber": 185 }, "deprecated": false, "children": [ @@ -1755,7 +1800,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 169 + "lineNumber": 185 }, "deprecated": false, "isRequired": true @@ -1775,7 +1820,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 181 + "lineNumber": 197 }, "deprecated": false, "children": [], @@ -1801,7 +1846,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 + "lineNumber": 287 }, "deprecated": false, "children": [], @@ -1826,7 +1871,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 291 }, "deprecated": false, "children": [ @@ -1842,7 +1887,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 291 }, "deprecated": false, "isRequired": true @@ -1870,7 +1915,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 295 }, "deprecated": false, "children": [ @@ -1886,7 +1931,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 295 }, "deprecated": false, "isRequired": true @@ -1914,7 +1959,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 299 }, "deprecated": false, "children": [ @@ -1930,7 +1975,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 299 }, "deprecated": false, "isRequired": true @@ -1958,7 +2003,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 303 }, "deprecated": false, "children": [ @@ -1974,7 +2019,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 303 }, "deprecated": false, "isRequired": true @@ -2002,7 +2047,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 307 }, "deprecated": false, "children": [ @@ -2018,7 +2063,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 307 }, "deprecated": false, "isRequired": true @@ -2046,7 +2091,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 + "lineNumber": 311 }, "deprecated": false, "children": [ @@ -2062,7 +2107,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 + "lineNumber": 311 }, "deprecated": false, "isRequired": true @@ -2090,12 +2135,169 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 278 + "lineNumber": 315 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.getTimeShifts", + "type": "Function", + "tags": [], + "label": "getTimeShifts", + "description": [], + "signature": [ + "() => Record" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 329 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.getTimeShiftInterval", + "type": "Function", + "tags": [], + "label": "getTimeShiftInterval", + "description": [], + "signature": [ + "() => moment.Duration | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 344 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.hasTimeShifts", + "type": "Function", + "tags": [], + "label": "hasTimeShifts", + "description": [], + "signature": [ + "() => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 351 }, "deprecated": false, "children": [], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.getSearchSourceTimeFilter", + "type": "Function", + "tags": [], + "label": "getSearchSourceTimeFilter", + "description": [], + "signature": [ + "(forceNow?: Date | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + "[] | { meta: { index: string | undefined; params: {}; alias: string; disabled: boolean; negate: boolean; }; query: { bool: { should: { bool: { filter: { range: { [x: string]: { gte: string; lte: string; }; }; }[]; }; }[]; minimum_should_match: number; }; }; }[]" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 355 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.getSearchSourceTimeFilter.$1", + "type": "Object", + "tags": [], + "label": "forceNow", + "description": [], + "signature": [ + "Date | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 355 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.postFlightTransform", + "type": "Function", + "tags": [], + "label": "postFlightTransform", + "description": [], + "signature": [ + "(response: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + "" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 408 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.postFlightTransform.$1", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + "" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 408 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-public.AggConfigs.getRequestAggById", @@ -2116,7 +2318,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 292 + "lineNumber": 427 }, "deprecated": false, "children": [ @@ -2132,7 +2334,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 292 + "lineNumber": 427 }, "deprecated": false, "isRequired": true @@ -2164,7 +2366,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 307 + "lineNumber": 442 }, "deprecated": false, "children": [], @@ -2194,7 +2396,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 456 }, "deprecated": false, "children": [ @@ -2212,7 +2414,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 456 }, "deprecated": false, "isRequired": true @@ -2248,7 +2450,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 + "lineNumber": 465 }, "deprecated": false, "children": [ @@ -2272,7 +2474,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 + "lineNumber": 465 }, "deprecated": false, "isRequired": true @@ -2296,7 +2498,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 + "lineNumber": 465 }, "deprecated": false, "isRequired": false @@ -2354,44 +2556,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2488,10 +2653,7 @@ "text": "DataPublicPluginStart" }, ", ", - "DataSetupDependencies", - ", ", - "DataStartDependencies", - ">" + "DataSetupDependencies" ], "source": { "path": "src/plugins/data/public/plugin.ts", @@ -2530,7 +2692,7 @@ "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" + "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; timeout: moment.Duration; terminateAfter: moment.Duration; }>; }>; }>>" ], "source": { "path": "src/plugins/data/public/plugin.ts", @@ -3327,10 +3489,15 @@ "label": "from", "description": [], "signature": [ - "(convertFn: ", - "FieldFormatConvertFunction", - ") => ", - "FieldFormatInstanceType" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ".from" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -3385,14 +3552,15 @@ "label": "isInstanceOfFieldFormat", "description": [], "signature": [ - "(fieldFormat: any) => fieldFormat is ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FieldFormat", "text": "FieldFormat" - } + }, + ".isInstanceOfFieldFormat" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -3490,7 +3658,7 @@ "label": "fieldFormatMap", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", @@ -3621,42 +3789,7 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -3666,45 +3799,13 @@ "label": "formatField", "description": [], "signature": [ - "(hit: Record, fieldName: string) => any" + "FormatFieldFn" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -3720,42 +3821,7 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -4008,7 +4074,9 @@ "parentPluginId": "data", "id": "def-public.IndexPattern.addScriptedField", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "addScriptedField", "description": [ "\nAdd scripted field to field list\n" @@ -4018,9 +4086,10 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, - "deprecated": false, + "deprecated": true, + "references": [], "children": [ { "parentPluginId": "data", @@ -4036,7 +4105,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -4055,7 +4124,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -4072,7 +4141,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -4084,7 +4153,9 @@ "parentPluginId": "data", "id": "def-public.IndexPattern.removeScriptedField", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "removeScriptedField", "description": [ "\nRemove scripted field from field list" @@ -4094,9 +4165,25 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 + "lineNumber": 272 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx", + "lineNumber": 117 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/field_editor/field_editor.tsx", + "lineNumber": 777 + } + } + ], "children": [ { "parentPluginId": "data", @@ -4110,7 +4197,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 + "lineNumber": 272 }, "deprecated": false, "isRequired": true @@ -4122,9 +4209,13 @@ "parentPluginId": "data", "id": "def-public.IndexPattern.getNonScriptedFields", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getNonScriptedFields", - "description": [], + "description": [ + "\n" + ], "signature": [ "() => ", { @@ -4138,9 +4229,74 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 277 + "lineNumber": 283 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx", + "lineNumber": 152 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 66 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 74 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 204 + } + }, + { + "plugin": "visTypeTimeseries", + "link": { + "path": "src/plugins/vis_type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts", + "lineNumber": 65 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts", + "lineNumber": 106 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts", + "lineNumber": 29 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts", + "lineNumber": 122 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts", + "lineNumber": 244 + } + } + ], "children": [], "returnComment": [] }, @@ -4148,9 +4304,13 @@ "parentPluginId": "data", "id": "def-public.IndexPattern.getScriptedFields", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getScriptedFields", - "description": [], + "description": [ + "\n" + ], "signature": [ "() => ", { @@ -4164,9 +4324,18 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 281 + "lineNumber": 291 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx", + "lineNumber": 61 + } + } + ], "children": [], "returnComment": [] }, @@ -4182,7 +4351,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 285 + "lineNumber": 295 }, "deprecated": false, "children": [], @@ -4200,7 +4369,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 289 + "lineNumber": 299 }, "deprecated": false, "children": [], @@ -4226,7 +4395,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 294 + "lineNumber": 304 }, "deprecated": false, "children": [], @@ -4252,7 +4421,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 + "lineNumber": 309 }, "deprecated": false, "children": [ @@ -4268,7 +4437,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 + "lineNumber": 309 }, "deprecated": false, "isRequired": true @@ -4288,7 +4457,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 304 + "lineNumber": 314 }, "deprecated": false, "children": [], @@ -4304,11 +4473,18 @@ "\nReturns index pattern as saved object body for saving" ], "signature": [ - "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + } ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 311 + "lineNumber": 321 }, "deprecated": false, "children": [], @@ -4359,7 +4535,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 339 + "lineNumber": 347 }, "deprecated": false, "children": [ @@ -4397,7 +4573,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 340 + "lineNumber": 348 }, "deprecated": false, "isRequired": true @@ -4427,7 +4603,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "children": [ @@ -4445,7 +4621,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "isRequired": true @@ -4470,7 +4646,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "isRequired": true @@ -4492,7 +4668,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 + "lineNumber": 392 }, "deprecated": false, "children": [ @@ -4510,7 +4686,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 + "lineNumber": 392 }, "deprecated": false, "isRequired": true @@ -4540,7 +4716,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 + "lineNumber": 412 }, "deprecated": false, "children": [ @@ -4556,7 +4732,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 + "lineNumber": 412 }, "deprecated": false, "isRequired": true @@ -4584,7 +4760,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 411 + "lineNumber": 419 }, "deprecated": false, "children": [ @@ -4600,7 +4776,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 412 + "lineNumber": 420 }, "deprecated": false, "isRequired": true @@ -4617,7 +4793,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 413 + "lineNumber": 421 }, "deprecated": false, "isRequired": true @@ -4641,7 +4817,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 414 + "lineNumber": 422 }, "deprecated": false, "isRequired": true @@ -4661,7 +4837,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "children": [ @@ -4677,7 +4853,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "isRequired": true @@ -4694,7 +4870,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "isRequired": false @@ -4714,7 +4890,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "children": [ @@ -4730,7 +4906,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "isRequired": true @@ -4747,7 +4923,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "isRequired": false @@ -4775,7 +4951,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "children": [ @@ -4791,7 +4967,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "isRequired": true @@ -4815,7 +4991,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "isRequired": true @@ -4835,7 +5011,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 + "lineNumber": 458 }, "deprecated": false, "children": [ @@ -4851,7 +5027,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 + "lineNumber": 458 }, "deprecated": false, "isRequired": true @@ -5540,15 +5716,13 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "() => Promise | undefined" + "EnsureDefaultIndexPattern" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -5610,9 +5784,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -5650,9 +5822,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -5755,9 +5925,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -5795,9 +5963,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "optionally clear a single id" - ], + "description": [], "signature": [ "string | undefined" ], @@ -6192,9 +6358,7 @@ "type": "Array", "tags": [], "label": "fields", - "description": [ - ": FieldSpec[]" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -6218,9 +6382,7 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -6331,7 +6493,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "children": [ @@ -6347,7 +6509,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "isRequired": true @@ -6385,7 +6547,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "children": [ @@ -6407,7 +6569,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -6424,7 +6586,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -6464,7 +6626,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "children": [ @@ -6486,7 +6648,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -6505,7 +6667,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -6524,7 +6686,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -6562,7 +6724,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "children": [ @@ -6584,7 +6746,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -6603,7 +6765,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -6633,7 +6795,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 558 + "lineNumber": 570 }, "deprecated": false, "children": [ @@ -6655,7 +6817,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 559 + "lineNumber": 571 }, "deprecated": false, "isRequired": true @@ -6672,7 +6834,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 560 + "lineNumber": 572 }, "deprecated": false, "isRequired": true @@ -6689,7 +6851,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 561 + "lineNumber": 573 }, "deprecated": false, "isRequired": true @@ -6711,7 +6873,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "children": [ @@ -6729,7 +6891,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "isRequired": true @@ -6850,7 +7012,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 121 + "lineNumber": 127 }, "deprecated": false, "children": [ @@ -6866,7 +7028,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 129 + "lineNumber": 135 }, "deprecated": false }, @@ -6882,7 +7044,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 139 }, "deprecated": false, "children": [ @@ -6904,7 +7066,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 139 }, "deprecated": false, "isRequired": true @@ -6927,7 +7089,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 139 }, "deprecated": false, "isRequired": true @@ -6949,7 +7111,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 151 + "lineNumber": 157 }, "deprecated": false, "children": [ @@ -6965,7 +7127,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 151 + "lineNumber": 157 }, "deprecated": false, "isRequired": true @@ -6983,7 +7145,7 @@ "\nsets value to a single search source field" ], "signature": [ - "(field: K, value: ", + "(field: K, value: ", { "pluginId": "data", "scope": "common", @@ -6995,7 +7157,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 + "lineNumber": 166 }, "deprecated": false, "children": [ @@ -7013,7 +7175,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 + "lineNumber": 166 }, "deprecated": false, "isRequired": true @@ -7039,7 +7201,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 + "lineNumber": 166 }, "deprecated": false, "isRequired": true @@ -7057,11 +7219,11 @@ "\nremove field" ], "signature": [ - "(field: K) => this" + "(field: K) => this" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 172 + "lineNumber": 178 }, "deprecated": false, "children": [ @@ -7079,7 +7241,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 172 + "lineNumber": 178 }, "deprecated": false, "isRequired": true @@ -7111,7 +7273,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 183 + "lineNumber": 189 }, "deprecated": false, "children": [ @@ -7135,7 +7297,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 183 + "lineNumber": 189 }, "deprecated": false, "isRequired": true @@ -7157,7 +7319,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 191 + "lineNumber": 197 }, "deprecated": false, "children": [], @@ -7184,7 +7346,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 + "lineNumber": 204 }, "deprecated": false, "children": [], @@ -7200,7 +7362,7 @@ "\nGets a single field from the fields" ], "signature": [ - "(field: K, recurse?: boolean) => ", + "(field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", @@ -7212,7 +7374,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 211 }, "deprecated": false, "children": [ @@ -7228,7 +7390,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 211 }, "deprecated": false, "isRequired": true @@ -7245,7 +7407,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 211 }, "deprecated": false, "isRequired": true @@ -7263,7 +7425,7 @@ "\nGet the field from our own fields, don't traverse up the chain" ], "signature": [ - "(field: K) => ", + "(field: K) => ", { "pluginId": "data", "scope": "common", @@ -7275,7 +7437,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 216 + "lineNumber": 222 }, "deprecated": false, "children": [ @@ -7291,7 +7453,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 216 + "lineNumber": 222 }, "deprecated": false, "isRequired": true @@ -7320,7 +7482,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 223 + "lineNumber": 229 }, "deprecated": true, "references": [ @@ -7328,14 +7490,14 @@ "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 206 + "lineNumber": 207 } }, { "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 212 + "lineNumber": 213 } } ], @@ -7363,7 +7525,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 230 + "lineNumber": 236 }, "deprecated": false, "children": [], @@ -7390,7 +7552,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 244 + "lineNumber": 250 }, "deprecated": false, "children": [ @@ -7406,7 +7568,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 244 + "lineNumber": 250 }, "deprecated": false, "isRequired": true @@ -7446,7 +7608,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 262 }, "deprecated": false, "children": [ @@ -7472,7 +7634,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 262 }, "deprecated": false, "isRequired": false @@ -7497,7 +7659,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 262 }, "deprecated": false, "isRequired": true @@ -7531,7 +7693,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 266 + "lineNumber": 272 }, "deprecated": false, "children": [], @@ -7571,7 +7733,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 274 + "lineNumber": 280 }, "deprecated": false, "children": [ @@ -7593,7 +7755,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 275 + "lineNumber": 281 }, "deprecated": false, "isRequired": true @@ -7627,7 +7789,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 312 + "lineNumber": 318 }, "deprecated": true, "references": [ @@ -7638,13 +7800,6 @@ "lineNumber": 77 } }, - { - "plugin": "discover", - "link": { - "path": "src/plugins/discover/public/application/angular/context/api/anchor.ts", - "lineNumber": 57 - } - }, { "plugin": "maps", "link": { @@ -7686,7 +7841,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 312 + "lineNumber": 318 }, "deprecated": false, "isRequired": true @@ -7726,7 +7881,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 325 + "lineNumber": 331 }, "deprecated": false, "children": [ @@ -7758,7 +7913,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 326 + "lineNumber": 332 }, "deprecated": false, "isRequired": true @@ -7780,7 +7935,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 334 + "lineNumber": 340 }, "deprecated": false, "children": [], @@ -7802,7 +7957,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 342 + "lineNumber": 348 }, "deprecated": false, "children": [], @@ -7829,7 +7984,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 831 + "lineNumber": 848 }, "deprecated": false, "children": [ @@ -7845,7 +8000,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 831 + "lineNumber": 848 }, "deprecated": false, "isRequired": true @@ -7869,7 +8024,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 860 + "lineNumber": 877 }, "deprecated": false, "children": [], @@ -8157,45 +8312,19 @@ "label": "getConfig", "description": [], "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 35 }, - "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 - } - ] + "deprecated": false } ] } @@ -8816,7 +8945,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 195 + "lineNumber": 196 }, "deprecated": false, "children": [ @@ -8828,48 +8957,11 @@ "label": "aggFilter", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilter\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & 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\">, ", - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 196 + "lineNumber": 197 }, "deprecated": false }, @@ -8881,48 +8973,11 @@ "label": "aggFilters", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilters\", any, Pick, \"enabled\" | \"id\" | \"schema\" | \"json\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"schema\" | \"json\">, ", - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 197 + "lineNumber": 198 }, "deprecated": false }, @@ -8934,48 +8989,11 @@ "label": "aggSignificantTerms", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 198 + "lineNumber": 199 }, "deprecated": false }, @@ -8987,48 +9005,11 @@ "label": "aggIpRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggIpRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 199 + "lineNumber": 200 }, "deprecated": false }, @@ -9040,48 +9021,11 @@ "label": "aggDateRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDateRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 200 + "lineNumber": 201 }, "deprecated": false }, @@ -9093,48 +9037,11 @@ "label": "aggRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 201 + "lineNumber": 202 }, "deprecated": false }, @@ -9146,48 +9053,11 @@ "label": "aggGeoTile", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 202 + "lineNumber": 203 }, "deprecated": false }, @@ -9199,48 +9069,11 @@ "label": "aggGeoHash", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggGeoHash\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 203 + "lineNumber": 204 }, "deprecated": false }, @@ -9252,48 +9085,11 @@ "label": "aggHistogram", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 204 + "lineNumber": 205 }, "deprecated": false }, @@ -9305,48 +9101,11 @@ "label": "aggDateHistogram", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDateHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 205 + "lineNumber": 206 }, "deprecated": false }, @@ -9358,52 +9117,11 @@ "label": "aggTerms", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggTerms\", any, Pick, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 206 + "lineNumber": 207 }, "deprecated": false }, @@ -9415,48 +9133,11 @@ "label": "aggAvg", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 207 + "lineNumber": 208 }, "deprecated": false }, @@ -9468,56 +9149,11 @@ "label": "aggBucketAvg", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 + "lineNumber": 209 }, "deprecated": false }, @@ -9529,56 +9165,11 @@ "label": "aggBucketMax", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketMax\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 209 + "lineNumber": 210 }, "deprecated": false }, @@ -9590,56 +9181,11 @@ "label": "aggBucketMin", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketMin\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 210 + "lineNumber": 211 }, "deprecated": false }, @@ -9651,56 +9197,11 @@ "label": "aggBucketSum", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 211 + "lineNumber": 212 }, "deprecated": false }, @@ -9712,56 +9213,11 @@ "label": "aggFilteredMetric", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilteredMetric\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 212 + "lineNumber": 213 }, "deprecated": false }, @@ -9773,48 +9229,11 @@ "label": "aggCardinality", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 + "lineNumber": 214 }, "deprecated": false }, @@ -9826,48 +9245,11 @@ "label": "aggCount", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 214 + "lineNumber": 215 }, "deprecated": false }, @@ -9879,52 +9261,11 @@ "label": "aggCumulativeSum", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggCumulativeSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 215 + "lineNumber": 216 }, "deprecated": false }, @@ -9936,52 +9277,11 @@ "label": "aggDerivative", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDerivative\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 216 + "lineNumber": 217 }, "deprecated": false }, @@ -9993,48 +9293,11 @@ "label": "aggGeoBounds", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 217 + "lineNumber": 218 }, "deprecated": false }, @@ -10046,48 +9309,11 @@ "label": "aggGeoCentroid", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 218 + "lineNumber": 219 }, "deprecated": false }, @@ -10099,48 +9325,11 @@ "label": "aggMax", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 219 + "lineNumber": 220 }, "deprecated": false }, @@ -10152,48 +9341,11 @@ "label": "aggMedian", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 220 + "lineNumber": 221 }, "deprecated": false }, @@ -10205,48 +9357,11 @@ "label": "aggSinglePercentile", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 221 + "lineNumber": 222 }, "deprecated": false }, @@ -10258,48 +9373,11 @@ "label": "aggMin", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 222 + "lineNumber": 223 }, "deprecated": false }, @@ -10311,52 +9389,11 @@ "label": "aggMovingAvg", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggMovingAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 223 + "lineNumber": 224 }, "deprecated": false }, @@ -10368,48 +9405,11 @@ "label": "aggPercentileRanks", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 224 + "lineNumber": 225 }, "deprecated": false }, @@ -10421,48 +9421,11 @@ "label": "aggPercentiles", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 225 + "lineNumber": 226 }, "deprecated": false }, @@ -10474,52 +9437,11 @@ "label": "aggSerialDiff", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggSerialDiff\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 226 + "lineNumber": 227 }, "deprecated": false }, @@ -10531,48 +9453,11 @@ "label": "aggStdDeviation", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 227 + "lineNumber": 228 }, "deprecated": false }, @@ -10584,48 +9469,11 @@ "label": "aggSum", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 228 + "lineNumber": 229 }, "deprecated": false }, @@ -10637,48 +9485,11 @@ "label": "aggTopHit", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 229 + "lineNumber": 230 }, "deprecated": false } @@ -10903,26 +9714,7 @@ "path": "src/plugins/data/public/types.ts", "lineNumber": 60 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -10932,42 +9724,14 @@ "label": "createFiltersFromRangeSelectAction", "description": [], "signature": [ - "(event: ", - "RangeSelectDataContext", - ") => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]>" + "typeof ", + "createFiltersFromRangeSelectAction" ], "source": { "path": "src/plugins/data/public/types.ts", "lineNumber": 61 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -10995,15 +9759,7 @@ "label": "IndexPatternSelect", "description": [], "signature": [ - "React.ComponentClass<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.IndexPatternSelectProps", - "text": "IndexPatternSelectProps" - }, - ", any> | React.FunctionComponent<", + "React.ComponentType<", { "pluginId": "data", "scope": "public", @@ -11027,15 +9783,7 @@ "label": "SearchBar", "description": [], "signature": [ - "React.ComponentClass<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.StatefulSearchBarProps", - "text": "StatefulSearchBarProps" - }, - ", any> | React.FunctionComponent<", + "React.ComponentType<", { "pluginId": "data", "scope": "public", @@ -11088,7 +9836,7 @@ "label": "queryStringOptions", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -11162,7 +9910,7 @@ "label": "params", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -11531,7 +10279,7 @@ "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 58 + "lineNumber": 59 } }, { @@ -12588,14 +11336,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 5 + "lineNumber": 6 } }, { @@ -12616,14 +11364,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 17 + "lineNumber": 18 } }, { @@ -12700,28 +11448,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 6 + "lineNumber": 7 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 8 + "lineNumber": 9 } }, { @@ -12784,14 +11532,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 9 + "lineNumber": 10 } }, { @@ -12882,28 +11630,28 @@ "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 248 + "lineNumber": 249 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 287 + "lineNumber": 289 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 329 + "lineNumber": 331 } }, { @@ -13571,20 +12319,6 @@ "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": { @@ -14082,8 +12816,7 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - }, - ") | undefined" + } ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", @@ -14340,6 +13073,20 @@ "lineNumber": 85 } }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx", + "lineNumber": 25 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx", + "lineNumber": 102 + } + }, { "plugin": "lens", "link": { @@ -14445,20 +13192,6 @@ "lineNumber": 30 } }, - { - "plugin": "apm", - "link": { - "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", - "lineNumber": 14 - } - }, - { - "plugin": "apm", - "link": { - "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", - "lineNumber": 31 - } - }, { "plugin": "infra", "link": { @@ -14627,6 +13360,20 @@ "lineNumber": 23 } }, + { + "plugin": "apm", + "link": { + "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", + "lineNumber": 14 + } + }, + { + "plugin": "apm", + "link": { + "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", + "lineNumber": 31 + } + }, { "plugin": "lists", "link": { @@ -14659,21 +13406,21 @@ "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts", - "lineNumber": 21 + "lineNumber": 22 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts", - "lineNumber": 66 + "lineNumber": 72 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts", - "lineNumber": 19 + "lineNumber": 20 } }, { @@ -14932,21 +13679,21 @@ "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", - "lineNumber": 44 + "lineNumber": 48 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", - "lineNumber": 60 + "lineNumber": 64 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", - "lineNumber": 65 + "lineNumber": 69 } }, { @@ -15075,20 +13822,6 @@ "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": { @@ -15131,27 +13864,6 @@ "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": { @@ -15184,126 +13896,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "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 + "lineNumber": 6 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 11 + "lineNumber": 12 } }, { @@ -15733,6 +14347,20 @@ "lineNumber": 30 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts", + "lineNumber": 13 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts", + "lineNumber": 52 + } + }, { "plugin": "stackAlerts", "link": { @@ -15936,20 +14564,6 @@ "lineNumber": 1352 } }, - { - "plugin": "discover", - "link": { - "path": "src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx", - "lineNumber": 17 - } - }, - { - "plugin": "discover", - "link": { - "path": "src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx", - "lineNumber": 26 - } - }, { "plugin": "maps", "link": { @@ -16066,14 +14680,14 @@ "plugin": "observability", "link": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", - "lineNumber": 18 + "lineNumber": 19 } }, { "plugin": "observability", "link": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", - "lineNumber": 95 + "lineNumber": 104 } }, { @@ -16115,7 +14729,7 @@ "plugin": "observability", "link": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts", - "lineNumber": 24 + "lineNumber": 25 } }, { @@ -16958,8 +15572,7 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - }, - ">" + } ], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", @@ -17913,33 +16526,7 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 31 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -17965,9 +16552,7 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 35 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -18097,32 +16682,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -18545,16 +17105,7 @@ "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", @@ -19014,21 +17565,11 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ 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; }" + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 43 + "lineNumber": 45 }, "deprecated": false, "initialIsOpen": false @@ -19041,7 +17582,7 @@ "label": "AggGroupName", "description": [], "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" + "\"none\" | \"buckets\" | \"metrics\"" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -19058,22 +17599,7 @@ "label": "AggParam", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ">" + "BaseParamType" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", @@ -19113,59 +17639,11 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "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 string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", { @@ -19183,17 +17661,7 @@ "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>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -19227,14 +17695,7 @@ "label": "CustomFilter", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - " & { query: any; }" + "Filter & { query: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", @@ -19268,14 +17729,7 @@ "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"esaggs\", Input, Arguments, Output, ", + "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -19310,14 +17764,23 @@ "label": "EsdslExpressionFunctionDefinition", "description": [], "signature": [ + "ExpressionFunctionDefinition<\"esdsl\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - "<\"esdsl\", Input, Arguments, Output, ", + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + "> | null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -19334,8 +17797,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/esdsl.ts", @@ -19352,31 +17814,7 @@ "label": "EsQuerySortValue", "description": [], "signature": [ - "{ [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" - }, - "; }" + "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -19393,30 +17831,7 @@ "label": "EsRawResponseExpressionTypeDefinition", "description": [], "signature": [ - { - "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" - }, - ">" + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", @@ -19433,39 +17848,7 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ 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; }" + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -19482,30 +17865,7 @@ "label": "ExistsFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", @@ -19522,14 +17882,7 @@ "label": "ExpressionFunctionKibana", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana\", Input, object, ", + "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", @@ -19537,39 +17890,15 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - ">, ", + "<\"kibana_context\", ExecutionContextSearch> | null, object, ", { "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" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ">>" + "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -19586,14 +17915,7 @@ "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana_context\", Input, Arguments, Promise<", + "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", @@ -19601,39 +17923,15 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - ">>, ", + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", { "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" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ">>" + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", @@ -19650,14 +17948,7 @@ "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -19710,7 +18001,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", @@ -19727,23 +18018,7 @@ "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; }" + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -19763,17 +18038,11 @@ "label": "IAggConfig", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } + "AggConfig" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 53 + "lineNumber": 55 }, "deprecated": false, "initialIsOpen": false @@ -19786,38 +18055,7 @@ "label": "IAggType", "description": [], "signature": [ - { - "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" - }, - ">>" + "AggType>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -19834,16 +18072,7 @@ "label": "IEsSearchResponse", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "<", - "SearchResponse", - ">" + "IKibanaSearchResponse>" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -19860,13 +18089,7 @@ "label": "IFieldFormat", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } + "FieldFormat" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -19904,176 +18127,7 @@ "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", @@ -20090,13 +18144,7 @@ "label": "IFieldParamType", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldParamType", - "text": "FieldParamType" - } + "FieldParamType" ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -20113,26 +18161,11 @@ "label": "IMetricAggType", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" - }, - ">" + "MetricAggType" ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 35 + "lineNumber": 36 }, "deprecated": false, "initialIsOpen": false @@ -20145,14 +18178,7 @@ "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"indexPatternLoad\", null, Arguments, Output, ", + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -20187,179 +18213,11 @@ "label": "IndexPatternsContract", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 650 + "lineNumber": 662 }, "deprecated": false, "initialIsOpen": false @@ -20372,39 +18230,7 @@ "label": "ISearchGeneric", "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?: ", + "(request: SearchStrategyRequest, options: ", { "pluginId": "data", "scope": "common", @@ -20433,132 +18259,12 @@ "\nsearch source interface" ], "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?: ", + "{ 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?: ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.ISearchOptions", "text": "ISearchOptions" }, ") => ", @@ -20566,9 +18272,9 @@ "<", { "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", @@ -20576,40 +18282,11 @@ ">>; 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", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.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", @@ -20626,14 +18303,7 @@ "label": "KibanaContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -20650,22 +18320,7 @@ "label": "MatchAllFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", @@ -20682,9 +18337,7 @@ "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", @@ -20701,22 +18354,7 @@ "label": "PhraseFilter", "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; }" + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", @@ -20733,22 +18371,7 @@ "label": "PhrasesFilter", "description": [], "signature": [ - { - "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" - }, - "; }" + "Filter & { meta: PhrasesFilterMeta; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", @@ -20782,30 +18405,7 @@ "label": "RangeFilter", "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; }" + "Filter & EsRangeFilter & { meta: 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", @@ -20822,22 +18422,7 @@ "label": "RangeFilterMeta", "description": [], "signature": [ - { - "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; }" + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", @@ -20881,10 +18466,13 @@ { "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 @@ -20894,10 +18482,13 @@ { "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 @@ -20907,10 +18498,13 @@ { "parentPluginId": "data", "id": "def-public.AggGroupLabels.AggGroupNames.None", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.None]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 @@ -20928,7 +18522,7 @@ "label": "AggGroupNames", "description": [], "signature": [ - "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -20966,26 +18560,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 57 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21003,26 +18578,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 58 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21091,39 +18647,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21162,70 +18686,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 64 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21264,54 +18725,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 65 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21350,70 +18764,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 66 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21436,52 +18787,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 67 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21528,92 +18834,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21636,26 +18857,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 70 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21678,26 +18880,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21720,26 +18903,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 72 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21762,26 +18926,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 73 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21804,26 +18949,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 74 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21846,26 +18972,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 75 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21888,26 +18995,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 76 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21931,52 +19019,17 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 77 }, - "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: ", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.toggleFilterNegated", + "type": "Function", + "tags": [], + "label": "toggleFilterNegated", + "description": [], + "signature": [ + "(filter: ", { "pluginId": "data", "scope": "common", @@ -21998,42 +19051,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 79 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22064,42 +19082,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 80 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22123,41 +19106,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 81 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22181,41 +19130,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 82 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22225,87 +19140,20 @@ "label": "getDisplayValueFromFilter", "description": [], "signature": [ - "(filter: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - ", indexPatterns: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - "[]) => string" + "section": "def-common.getDisplayValueFromFilter", + "text": "getDisplayValueFromFilter" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 83 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22354,101 +19202,13 @@ "docId": "kibDataQueryPluginApi", "section": "def-common.FilterCompareOptions", "text": "FilterCompareOptions" - }, - ") => boolean" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 85 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22480,127 +19240,14 @@ "label": "generateFilters", "description": [], "signature": [ - "(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" - }, - "[]" + "typeof ", + "generateFilters" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 87 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22632,56 +19279,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 88 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22691,211 +19289,14 @@ "label": "changeTimeFilter", "description": [], "signature": [ - "(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" + "typeof ", + "changeTimeFilter" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 90 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22905,70 +19306,14 @@ "label": "convertRangeFilterToTimeRangeString", "description": [], "signature": [ - "(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" - } + "typeof ", + "convertRangeFilterToTimeRangeString" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 91 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -23000,112 +19345,24 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 92 }, - "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", - "id": "def-public.esFilters.extractTimeFilter", - "type": "Function", - "tags": [], - "label": "extractTimeFilter", - "description": [], - "signature": [ - "(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, - "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 - } - ] + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.extractTimeFilter", + "type": "Function", + "tags": [], + "label": "extractTimeFilter", + "description": [], + "signature": [ + "typeof ", + "extractTimeFilter" + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 93 + }, + "deprecated": false }, { "parentPluginId": "data", @@ -23115,79 +19372,14 @@ "label": "extractTimeRange", "description": [], "signature": [ - "(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; }" + "typeof ", + "extractTimeRange" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 94 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -23250,42 +19442,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 125 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -23324,87 +19481,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 126 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -23430,195 +19507,20 @@ "label": "buildEsQuery", "description": [], "signature": [ - "(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.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: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]; }; }" + "section": "def-common.buildEsQuery", + "text": "buildEsQuery" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 130 }, - "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": 33 - }, - "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": 34 - }, - "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": 35 - }, - "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": 36 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -23628,39 +19530,20 @@ "label": "getEsQueryConfig", "description": [], "signature": [ - "(config: KibanaConfig) => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.EsQueryConfig", - "text": "EsQueryConfig" + "section": "def-common.getEsQueryConfig", + "text": "getEsQueryConfig" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 131 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -23708,69 +19591,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 132 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -23780,39 +19601,20 @@ "label": "luceneStringToDsl", "description": [], "signature": [ - "(query: any) => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.DslQuery", - "text": "DslQuery" + "section": "def-common.luceneStringToDsl", + "text": "luceneStringToDsl" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 133 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -23822,87 +19624,20 @@ "label": "decorateQuery", "description": [], "signature": [ - "(query: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.DslQuery", - "text": "DslQuery" - }, - ", queryStringOptions: string | Record, dateFormatTZ?: string | undefined) => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.DslQuery", - "text": "DslQuery" + "section": "def-common.decorateQuery", + "text": "decorateQuery" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 134 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -23928,62 +19663,20 @@ "label": "datatableToCSV", "description": [], "signature": [ - "({ columns, rows }: ", + "typeof ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string" + "docId": "kibDataPluginApi", + "section": "def-common.datatableToCSV", + "text": "datatableToCSV" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 214 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24084,7 +19777,13 @@ "label": "HTML_CONTEXT_TYPE", "description": [], "signature": [ - "\"html\" | \"text\"" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } ], "source": { "path": "src/plugins/data/public/index.ts", @@ -24100,7 +19799,13 @@ "label": "TEXT_CONTEXT_TYPE", "description": [], "signature": [ - "\"html\" | \"text\"" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } ], "source": { "path": "src/plugins/data/public/index.ts", @@ -24583,32 +20288,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 243 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24618,46 +20298,20 @@ "label": "isFilterable", "description": [], "signature": [ - "(field: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => boolean" + "section": "def-common.isFilterable", + "text": "isFilterable" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 244 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24667,46 +20321,20 @@ "label": "isNestedField", "description": [], "signature": [ - "(field: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => boolean" + "section": "def-common.isNestedField", + "text": "isNestedField" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 245 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24716,29 +20344,14 @@ "label": "validate", "description": [], "signature": [ - "(indexPattern: string) => Record" + "typeof ", + "validateIndexPattern" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 246 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24748,78 +20361,14 @@ "label": "flattenHitWrapper", "description": [], "signature": [ - "(indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", metaFields?: {}, cache?: WeakMap) => (hit: Record, deep?: boolean) => Record" + "typeof ", + "flattenHitWrapper" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 247 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24829,62 +20378,14 @@ "label": "formatHitProvider", "description": [], "signature": [ - "(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; }" + "typeof ", + "formatHitProvider" ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 248 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -24946,29 +20447,20 @@ "label": "dateHistogramInterval", "description": [], "signature": [ - "(interval: string) => Interval" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.dateHistogramInterval", + "text": "dateHistogramInterval" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 410 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -24978,7 +20470,7 @@ "label": "intervalOptions", "description": [], "signature": [ - "({ display: string; val: string; enabled(agg: ", + "({ display: any; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", @@ -24986,7 +20478,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean; } | { display: string; val: string; })[]" + "): boolean; } | { display: any; val: string; })[]" ], "source": { "path": "src/plugins/data/public/index.ts", @@ -25071,39 +20563,20 @@ "label": "isDateHistogramBucketAggConfig", "description": [], "signature": [ - "(agg: any) => agg is ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketDateHistogramAggConfig", - "text": "IBucketDateHistogramAggConfig" + "section": "def-common.isDateHistogramBucketAggConfig", + "text": "isDateHistogramBucketAggConfig" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 415 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25127,32 +20600,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 416 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25176,32 +20624,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 417 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25225,26 +20648,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 418 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25254,29 +20658,20 @@ "label": "isValidEsInterval", "description": [], "signature": [ - "(interval: string) => boolean" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidEsInterval", + "text": "isValidEsInterval" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 419 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25286,53 +20681,31 @@ "label": "isValidInterval", "description": [], "signature": [ - "(value: string, baseInterval?: string | undefined) => boolean" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidInterval", + "text": "isValidInterval" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 420 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", "id": "def-public.search.aggs.parentPipelineType", - "type": "string", + "type": "Any", "tags": [], "label": "parentPipelineType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 421 @@ -25347,31 +20720,20 @@ "label": "parseEsInterval", "description": [], "signature": [ - "(interval: string) => { value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseEsInterval", + "text": "parseEsInterval" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 422 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25381,29 +20743,20 @@ "label": "parseInterval", "description": [], "signature": [ - "(interval: string) => moment.Duration | null" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseInterval", + "text": "parseInterval" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 423 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25413,40 +20766,31 @@ "label": "propFilter", "description": [], "signature": [ - "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.propFilter", + "text": "propFilter" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 424 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", "id": "def-public.search.aggs.siblingPipelineType", - "type": "string", + "type": "Any", "tags": [], "label": "siblingPipelineType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 425 @@ -25477,40 +20821,20 @@ "label": "toAbsoluteDates", "description": [], "signature": [ - "(range: ", + "typeof ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ") => { from: Date; to: Date; } | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.toAbsoluteDates", + "text": "toAbsoluteDates" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 427 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25520,7 +20844,7 @@ "label": "boundsDescendingRaw", "description": [], "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" + "({ bound: number; interval: moment.Duration; boundLabel: any; intervalLabel: any; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: any; intervalLabel: any; })[]" ], "source": { "path": "src/plugins/data/public/index.ts", @@ -25550,32 +20874,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 429 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25607,32 +20906,7 @@ "path": "src/plugins/data/public/index.ts", "lineNumber": 430 }, - "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 - } - ] + "deprecated": false } ] }, @@ -25644,74 +20918,20 @@ "label": "getResponseInspectorStats", "description": [], "signature": [ - "(resp?: ", - "SearchResponse", - " | undefined, searchSource?: Pick<", + "typeof ", { "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) => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestStatistics", - "text": "RequestStatistics" + "section": "def-common.getResponseInspectorStats", + "text": "getResponseInspectorStats" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 432 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25721,89 +20941,20 @@ "label": "tabifyAggResponse", "description": [], "signature": [ - "(aggConfigs: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", esResponse: Record, respOpts?: Partial<", - "TabbedResponseWriterOptions", - "> | undefined) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "section": "def-common.tabifyAggResponse", + "text": "tabifyAggResponse" } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 433 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -25813,62 +20964,20 @@ "label": "tabifyGetColumns", "description": [], "signature": [ - "(aggs: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[], minimalColumns: boolean) => ", - "TabbedAggColumn", - "[]" + "section": "def-common.tabifyGetColumns", + "text": "tabifyGetColumns" + } ], "source": { "path": "src/plugins/data/public/index.ts", "lineNumber": 434 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -25922,7 +21031,7 @@ "section": "def-public.QuerySuggestionGetFn", "text": "QuerySuggestionGetFn" }, - "; }" + "; getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -25960,9 +21069,15 @@ "label": "fieldFormats", "description": [], "signature": [ - "{ register: (fieldFormats: ", - "FieldFormatInstanceType", - "[]) => void; }" + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"register\">" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -25999,16 +21114,7 @@ "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", @@ -26097,175 +21203,15 @@ "\nindex patterns service\n{@link IndexPatternsContract}" ], "signature": [ - "{ 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: ", + "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -26307,17 +21253,13 @@ "\nfield formats service\n{@link FieldFormatsStart}" ], "signature": [ - "Pick<", { "pluginId": "data", - "scope": "common", + "scope": "public", "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", - "; }" + "section": "def-public.FieldFormatsStart", + "text": "FieldFormatsStart" + } ], "source": { "path": "src/plugins/data/public/types.ts", @@ -26362,66 +21304,7 @@ "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" - }, - "[]; }; }; }" + "Observable" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -26461,7 +21344,9 @@ "label": "nowProvider", "description": [], "signature": [ - "{ get: () => Date; }" + "Pick, \"get\">" ], "source": { "path": "src/plugins/data/public/types.ts", @@ -26523,44 +21408,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -26657,10 +21505,7 @@ "text": "DataPluginStart" }, ", ", - "DataPluginSetupDependencies", - ", ", - "DataPluginStartDependencies", - ">" + "DataPluginSetupDependencies" ], "source": { "path": "src/plugins/data/server/plugin.ts", @@ -26699,7 +21544,7 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" + "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; timeout: moment.Duration; terminateAfter: moment.Duration; }>; }>; }>>" ], "source": { "path": "src/plugins/data/server/plugin.ts", @@ -26740,18 +21585,7 @@ ">, { bfetch, expressions, usageCollection }: ", "DataPluginSetupDependencies", ") => { __enhance: (enhancements: ", - "DataEnhancements", - ") => void; search: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.ISearchSetup", - "text": "ISearchSetup" - }, - "; fieldFormats: { register: (customFieldFormat: ", - "FieldFormatInstanceType", - ") => number; }; }" + "DataEnhancements" ], "source": { "path": "src/plugins/data/server/plugin.ts", @@ -26860,40 +21694,7 @@ "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", @@ -27015,7 +21816,7 @@ "label": "fieldFormatMap", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", @@ -27146,42 +21947,7 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -27191,45 +21957,13 @@ "label": "formatField", "description": [], "signature": [ - "(hit: Record, fieldName: string) => any" + "FormatFieldFn" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -27245,42 +21979,7 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -27533,7 +22232,9 @@ "parentPluginId": "data", "id": "def-server.IndexPattern.addScriptedField", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "addScriptedField", "description": [ "\nAdd scripted field to field list\n" @@ -27543,9 +22244,10 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, - "deprecated": false, + "deprecated": true, + "references": [], "children": [ { "parentPluginId": "data", @@ -27561,7 +22263,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -27580,7 +22282,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -27597,7 +22299,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -27609,7 +22311,9 @@ "parentPluginId": "data", "id": "def-server.IndexPattern.removeScriptedField", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "removeScriptedField", "description": [ "\nRemove scripted field from field list" @@ -27619,9 +22323,25 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 + "lineNumber": 272 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx", + "lineNumber": 117 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/field_editor/field_editor.tsx", + "lineNumber": 777 + } + } + ], "children": [ { "parentPluginId": "data", @@ -27635,7 +22355,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 + "lineNumber": 272 }, "deprecated": false, "isRequired": true @@ -27647,9 +22367,13 @@ "parentPluginId": "data", "id": "def-server.IndexPattern.getNonScriptedFields", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getNonScriptedFields", - "description": [], + "description": [ + "\n" + ], "signature": [ "() => ", { @@ -27663,9 +22387,74 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 277 + "lineNumber": 283 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx", + "lineNumber": 152 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 66 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 74 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 204 + } + }, + { + "plugin": "visTypeTimeseries", + "link": { + "path": "src/plugins/vis_type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts", + "lineNumber": 65 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts", + "lineNumber": 106 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts", + "lineNumber": 29 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts", + "lineNumber": 122 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts", + "lineNumber": 244 + } + } + ], "children": [], "returnComment": [] }, @@ -27673,9 +22462,13 @@ "parentPluginId": "data", "id": "def-server.IndexPattern.getScriptedFields", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getScriptedFields", - "description": [], + "description": [ + "\n" + ], "signature": [ "() => ", { @@ -27689,9 +22482,18 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 281 + "lineNumber": 291 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx", + "lineNumber": 61 + } + } + ], "children": [], "returnComment": [] }, @@ -27707,7 +22509,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 285 + "lineNumber": 295 }, "deprecated": false, "children": [], @@ -27725,7 +22527,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 289 + "lineNumber": 299 }, "deprecated": false, "children": [], @@ -27751,7 +22553,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 294 + "lineNumber": 304 }, "deprecated": false, "children": [], @@ -27777,7 +22579,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 + "lineNumber": 309 }, "deprecated": false, "children": [ @@ -27793,7 +22595,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 + "lineNumber": 309 }, "deprecated": false, "isRequired": true @@ -27813,7 +22615,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 304 + "lineNumber": 314 }, "deprecated": false, "children": [], @@ -27829,11 +22631,18 @@ "\nReturns index pattern as saved object body for saving" ], "signature": [ - "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + } ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 311 + "lineNumber": 321 }, "deprecated": false, "children": [], @@ -27884,7 +22693,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 339 + "lineNumber": 347 }, "deprecated": false, "children": [ @@ -27922,7 +22731,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 340 + "lineNumber": 348 }, "deprecated": false, "isRequired": true @@ -27952,7 +22761,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "children": [ @@ -27970,7 +22779,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "isRequired": true @@ -27995,7 +22804,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "isRequired": true @@ -28017,7 +22826,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 + "lineNumber": 392 }, "deprecated": false, "children": [ @@ -28035,7 +22844,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 + "lineNumber": 392 }, "deprecated": false, "isRequired": true @@ -28065,7 +22874,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 + "lineNumber": 412 }, "deprecated": false, "children": [ @@ -28081,7 +22890,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 + "lineNumber": 412 }, "deprecated": false, "isRequired": true @@ -28109,7 +22918,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 411 + "lineNumber": 419 }, "deprecated": false, "children": [ @@ -28125,7 +22934,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 412 + "lineNumber": 420 }, "deprecated": false, "isRequired": true @@ -28142,7 +22951,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 413 + "lineNumber": 421 }, "deprecated": false, "isRequired": true @@ -28166,7 +22975,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 414 + "lineNumber": 422 }, "deprecated": false, "isRequired": true @@ -28186,7 +22995,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "children": [ @@ -28202,7 +23011,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "isRequired": true @@ -28219,7 +23028,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "isRequired": false @@ -28239,7 +23048,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "children": [ @@ -28255,7 +23064,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "isRequired": true @@ -28272,7 +23081,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "isRequired": false @@ -28300,7 +23109,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "children": [ @@ -28316,7 +23125,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "isRequired": true @@ -28340,7 +23149,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "isRequired": true @@ -28360,7 +23169,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 + "lineNumber": 458 }, "deprecated": false, "children": [ @@ -28376,7 +23185,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 + "lineNumber": 458 }, "deprecated": false, "isRequired": true @@ -28408,15 +23217,13 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "() => Promise | undefined" + "EnsureDefaultIndexPattern" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -28478,9 +23285,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -28518,9 +23323,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -28623,9 +23426,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -28663,9 +23464,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "optionally clear a single id" - ], + "description": [], "signature": [ "string | undefined" ], @@ -29060,9 +23859,7 @@ "type": "Array", "tags": [], "label": "fields", - "description": [ - ": FieldSpec[]" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -29086,9 +23883,7 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -29199,7 +23994,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "children": [ @@ -29215,7 +24010,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "isRequired": true @@ -29253,7 +24048,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "children": [ @@ -29275,7 +24070,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -29292,7 +24087,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -29332,7 +24127,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "children": [ @@ -29354,7 +24149,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -29373,7 +24168,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -29392,7 +24187,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -29430,7 +24225,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "children": [ @@ -29452,7 +24247,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -29471,7 +24266,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -29501,7 +24296,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 558 + "lineNumber": 570 }, "deprecated": false, "children": [ @@ -29523,7 +24318,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 559 + "lineNumber": 571 }, "deprecated": false, "isRequired": true @@ -29540,7 +24335,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 560 + "lineNumber": 572 }, "deprecated": false, "isRequired": true @@ -29557,7 +24352,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 561 + "lineNumber": 573 }, "deprecated": false, "isRequired": true @@ -29579,7 +24374,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "children": [ @@ -29597,7 +24392,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "isRequired": true @@ -29629,15 +24424,13 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "() => Promise | undefined" + "EnsureDefaultIndexPattern" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -29699,9 +24492,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -29739,9 +24530,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -29844,9 +24633,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -29884,9 +24671,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "optionally clear a single id" - ], + "description": [], "signature": [ "string | undefined" ], @@ -30281,9 +25066,7 @@ "type": "Array", "tags": [], "label": "fields", - "description": [ - ": FieldSpec[]" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -30307,9 +25090,7 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -30420,7 +25201,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "children": [ @@ -30436,7 +25217,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "isRequired": true @@ -30474,7 +25255,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "children": [ @@ -30496,7 +25277,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -30513,7 +25294,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -30553,7 +25334,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "children": [ @@ -30575,7 +25356,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -30594,7 +25375,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -30613,7 +25394,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -30651,7 +25432,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "children": [ @@ -30673,7 +25454,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -30692,7 +25473,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -30722,7 +25503,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 558 + "lineNumber": 570 }, "deprecated": false, "children": [ @@ -30744,7 +25525,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 559 + "lineNumber": 571 }, "deprecated": false, "isRequired": true @@ -30761,7 +25542,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 560 + "lineNumber": 572 }, "deprecated": false, "isRequired": true @@ -30778,7 +25559,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 561 + "lineNumber": 573 }, "deprecated": false, "isRequired": true @@ -30800,7 +25581,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "children": [ @@ -30818,7 +25599,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "isRequired": true @@ -31168,7 +25949,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 195 + "lineNumber": 196 }, "deprecated": false, "children": [ @@ -31180,48 +25961,11 @@ "label": "aggFilter", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilter\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & 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\">, ", - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 196 + "lineNumber": 197 }, "deprecated": false }, @@ -31233,48 +25977,11 @@ "label": "aggFilters", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilters\", any, Pick, \"enabled\" | \"id\" | \"schema\" | \"json\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"schema\" | \"json\">, ", - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 197 + "lineNumber": 198 }, "deprecated": false }, @@ -31286,48 +25993,11 @@ "label": "aggSignificantTerms", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 198 + "lineNumber": 199 }, "deprecated": false }, @@ -31339,48 +26009,11 @@ "label": "aggIpRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggIpRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 199 + "lineNumber": 200 }, "deprecated": false }, @@ -31392,48 +26025,11 @@ "label": "aggDateRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDateRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 200 + "lineNumber": 201 }, "deprecated": false }, @@ -31445,48 +26041,11 @@ "label": "aggRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 201 + "lineNumber": 202 }, "deprecated": false }, @@ -31498,48 +26057,11 @@ "label": "aggGeoTile", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 202 + "lineNumber": 203 }, "deprecated": false }, @@ -31551,48 +26073,11 @@ "label": "aggGeoHash", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggGeoHash\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 203 + "lineNumber": 204 }, "deprecated": false }, @@ -31604,48 +26089,11 @@ "label": "aggHistogram", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 204 + "lineNumber": 205 }, "deprecated": false }, @@ -31657,48 +26105,11 @@ "label": "aggDateHistogram", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDateHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 205 + "lineNumber": 206 }, "deprecated": false }, @@ -31710,52 +26121,11 @@ "label": "aggTerms", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggTerms\", any, Pick, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 206 + "lineNumber": 207 }, "deprecated": false }, @@ -31767,48 +26137,11 @@ "label": "aggAvg", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 207 + "lineNumber": 208 }, "deprecated": false }, @@ -31820,56 +26153,11 @@ "label": "aggBucketAvg", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 + "lineNumber": 209 }, "deprecated": false }, @@ -31881,56 +26169,11 @@ "label": "aggBucketMax", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketMax\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 209 + "lineNumber": 210 }, "deprecated": false }, @@ -31942,56 +26185,11 @@ "label": "aggBucketMin", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketMin\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 210 + "lineNumber": 211 }, "deprecated": false }, @@ -32003,56 +26201,11 @@ "label": "aggBucketSum", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 211 + "lineNumber": 212 }, "deprecated": false }, @@ -32064,109 +26217,27 @@ "label": "aggFilteredMetric", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilteredMetric\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 212 + "lineNumber": 213 }, "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.AggFunctionsMapping.aggCardinality", - "type": "Object", - "tags": [], - "label": "aggCardinality", - "description": [], - "signature": [ - { - "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", - ">>" + }, + { + "parentPluginId": "data", + "id": "def-server.AggFunctionsMapping.aggCardinality", + "type": "Object", + "tags": [], + "label": "aggCardinality", + "description": [], + "signature": [ + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 + "lineNumber": 214 }, "deprecated": false }, @@ -32178,48 +26249,11 @@ "label": "aggCount", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 214 + "lineNumber": 215 }, "deprecated": false }, @@ -32231,52 +26265,11 @@ "label": "aggCumulativeSum", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggCumulativeSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 215 + "lineNumber": 216 }, "deprecated": false }, @@ -32288,52 +26281,11 @@ "label": "aggDerivative", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDerivative\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 216 + "lineNumber": 217 }, "deprecated": false }, @@ -32345,48 +26297,11 @@ "label": "aggGeoBounds", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 217 + "lineNumber": 218 }, "deprecated": false }, @@ -32398,48 +26313,11 @@ "label": "aggGeoCentroid", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 218 + "lineNumber": 219 }, "deprecated": false }, @@ -32451,48 +26329,11 @@ "label": "aggMax", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 219 + "lineNumber": 220 }, "deprecated": false }, @@ -32504,48 +26345,11 @@ "label": "aggMedian", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 220 + "lineNumber": 221 }, "deprecated": false }, @@ -32557,48 +26361,11 @@ "label": "aggSinglePercentile", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 221 + "lineNumber": 222 }, "deprecated": false }, @@ -32610,48 +26377,11 @@ "label": "aggMin", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 222 + "lineNumber": 223 }, "deprecated": false }, @@ -32663,52 +26393,11 @@ "label": "aggMovingAvg", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggMovingAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 223 + "lineNumber": 224 }, "deprecated": false }, @@ -32720,48 +26409,11 @@ "label": "aggPercentileRanks", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 224 + "lineNumber": 225 }, "deprecated": false }, @@ -32773,48 +26425,11 @@ "label": "aggPercentiles", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 225 + "lineNumber": 226 }, "deprecated": false }, @@ -32826,52 +26441,11 @@ "label": "aggSerialDiff", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggSerialDiff\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 226 + "lineNumber": 227 }, "deprecated": false }, @@ -32883,48 +26457,11 @@ "label": "aggStdDeviation", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 227 + "lineNumber": 228 }, "deprecated": false }, @@ -32936,48 +26473,11 @@ "label": "aggSum", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 228 + "lineNumber": 229 }, "deprecated": false }, @@ -32989,48 +26489,11 @@ "label": "aggTopHit", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 229 + "lineNumber": 230 }, "deprecated": false } @@ -33163,7 +26626,7 @@ "label": "queryStringOptions", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -33237,7 +26700,7 @@ "label": "params", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -33403,7 +26866,7 @@ "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 58 + "lineNumber": 59 } }, { @@ -34460,14 +27923,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 5 + "lineNumber": 6 } }, { @@ -34488,14 +27951,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 17 + "lineNumber": 18 } }, { @@ -34572,28 +28035,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 6 + "lineNumber": 7 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 8 + "lineNumber": 9 } }, { @@ -34656,14 +28119,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 9 + "lineNumber": 10 } }, { @@ -34754,28 +28217,28 @@ "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 248 + "lineNumber": 249 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 287 + "lineNumber": 289 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 329 + "lineNumber": 331 } }, { @@ -35443,20 +28906,6 @@ "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": { @@ -35954,8 +29403,7 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - }, - ") | undefined" + } ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", @@ -36449,32 +29897,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -36589,21 +30012,11 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ 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; }" + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 43 + "lineNumber": 45 }, "deprecated": false, "initialIsOpen": false @@ -36616,39 +30029,24 @@ "label": "AggGroupName", "description": [], "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" + "\"none\" | \"buckets\" | \"metrics\"" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 18 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.AggParam", - "type": "Type", - "tags": [], - "label": "AggParam", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ">" + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.AggParam", + "type": "Type", + "tags": [], + "label": "AggParam", + "description": [], + "signature": [ + "BaseParamType" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", @@ -36682,14 +30080,7 @@ "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"esaggs\", Input, Arguments, Output, ", + "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -36724,39 +30115,7 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ 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; }" + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -36773,14 +30132,7 @@ "label": "ExpressionFunctionKibana", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana\", Input, object, ", + "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", @@ -36788,39 +30140,15 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - ">, ", + "<\"kibana_context\", ExecutionContextSearch> | null, object, ", { "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" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ">>" + "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -36837,14 +30165,7 @@ "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana_context\", Input, Arguments, Promise<", + "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", @@ -36852,39 +30173,15 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - ">>, ", + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", { "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" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ">>" + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", @@ -36901,14 +30198,7 @@ "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -36925,7 +30215,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", @@ -36942,23 +30232,7 @@ "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; }" + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -36978,17 +30252,11 @@ "label": "IAggConfig", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } + "AggConfig" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 53 + "lineNumber": 55 }, "deprecated": false, "initialIsOpen": false @@ -37001,38 +30269,7 @@ "label": "IAggType", "description": [], "signature": [ - { - "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" - }, - ">>" + "AggType>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -37049,16 +30286,7 @@ "label": "IEsSearchResponse", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "<", - "SearchResponse", - ">" + "IKibanaSearchResponse>" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -37096,176 +30324,7 @@ "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", @@ -37282,13 +30341,7 @@ "label": "IFieldParamType", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldParamType", - "text": "FieldParamType" - } + "FieldParamType" ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -37305,26 +30358,11 @@ "label": "IMetricAggType", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" - }, - ">" + "MetricAggType" ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 35 + "lineNumber": 36 }, "deprecated": false, "initialIsOpen": false @@ -37337,14 +30375,7 @@ "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"indexPatternLoad\", null, Arguments, Output, ", + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -37379,14 +30410,7 @@ "label": "KibanaContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -37403,9 +30427,7 @@ "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", @@ -37466,10 +30488,13 @@ { "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.Buckets", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 @@ -37479,10 +30504,13 @@ { "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.Metrics", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 @@ -37492,10 +30520,13 @@ { "parentPluginId": "data", "id": "def-server.AggGroupLabels.AggGroupNames.None", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.None]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 @@ -37513,7 +30544,7 @@ "label": "AggGroupNames", "description": [], "signature": [ - "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -37556,52 +30587,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 30 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -37611,179 +30597,43 @@ "label": "buildCustomFilter", "description": [], "signature": [ - "(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterStateStore", - "text": "FilterStateStore" - }, - ") => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.buildCustomFilter", + "text": "buildCustomFilter" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 31 }, - "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 - } - ] + "deprecated": false }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter", - "type": "Function", - "tags": [], - "label": "buildEmptyFilter", - "description": [], - "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } - ], - "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", + "id": "def-server.esFilters.buildEmptyFilter", + "type": "Function", + "tags": [], + "label": "buildEmptyFilter", + "description": [], + "signature": [ + "(isPinned: boolean, index?: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 32 + }, + "deprecated": false }, { "parentPluginId": "data", @@ -37822,54 +30672,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 33 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -37879,202 +30682,20 @@ "label": "buildFilter", "description": [], "signature": [ - "(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.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) => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.buildFilter", + "text": "buildFilter" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 34 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38113,70 +30734,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 35 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38215,70 +30773,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 36 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38325,92 +30820,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 37 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38434,42 +30844,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 38 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -38532,42 +30907,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 66 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38606,87 +30946,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 67 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -38750,69 +31010,7 @@ "path": "src/plugins/data/server/index.ts", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38822,39 +31020,20 @@ "label": "getEsQueryConfig", "description": [], "signature": [ - "(config: KibanaConfig) => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.EsQueryConfig", - "text": "EsQueryConfig" + "section": "def-common.getEsQueryConfig", + "text": "getEsQueryConfig" } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 72 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -38864,195 +31043,20 @@ "label": "buildEsQuery", "description": [], "signature": [ - "(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.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: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]; }; }" + "section": "def-common.buildEsQuery", + "text": "buildEsQuery" + } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 73 }, - "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": 33 - }, - "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": 34 - }, - "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": 35 - }, - "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": 36 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -39078,62 +31082,20 @@ "label": "datatableToCSV", "description": [], "signature": [ - "({ columns, rows }: ", + "typeof ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string" + "docId": "kibDataPluginApi", + "section": "def-common.datatableToCSV", + "text": "datatableToCSV" + } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 47 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -39556,46 +31518,20 @@ "label": "isFilterable", "description": [], "signature": [ - "(field: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => boolean" + "section": "def-common.isFilterable", + "text": "isFilterable" + } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 129 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -39605,46 +31541,20 @@ "label": "isNestedField", "description": [], "signature": [ - "(field: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => boolean" + "section": "def-common.isNestedField", + "text": "isNestedField" + } ], "source": { "path": "src/plugins/data/server/index.ts", "lineNumber": 130 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -39658,7 +31568,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 243 + "lineNumber": 244 }, "deprecated": false, "children": [ @@ -39671,7 +31581,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "children": [ @@ -39694,7 +31604,7 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 245 + "lineNumber": 246 }, "deprecated": false }, @@ -39706,29 +31616,20 @@ "label": "dateHistogramInterval", "description": [], "signature": [ - "(interval: string) => Interval" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.dateHistogramInterval", + "text": "dateHistogramInterval" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 246 + "lineNumber": 247 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -39738,7 +31639,7 @@ "label": "intervalOptions", "description": [], "signature": [ - "({ display: string; val: string; enabled(agg: ", + "({ display: any; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", @@ -39746,11 +31647,11 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean; } | { display: string; val: string; })[]" + "): boolean; } | { display: any; val: string; })[]" ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 247 + "lineNumber": 248 }, "deprecated": false }, @@ -39773,7 +31674,7 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 248 + "lineNumber": 249 }, "deprecated": false }, @@ -39796,7 +31697,7 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 249 + "lineNumber": 250 }, "deprecated": false }, @@ -39819,7 +31720,7 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 250 + "lineNumber": 251 }, "deprecated": false }, @@ -39843,34 +31744,9 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 251 + "lineNumber": 252 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -39892,34 +31768,9 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 252 + "lineNumber": 253 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -39941,28 +31792,9 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 253 + "lineNumber": 254 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -39972,29 +31804,20 @@ "label": "isValidEsInterval", "description": [], "signature": [ - "(interval: string) => boolean" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidEsInterval", + "text": "isValidEsInterval" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 254 + "lineNumber": 255 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -40004,56 +31827,34 @@ "label": "isValidInterval", "description": [], "signature": [ - "(value: string, baseInterval?: string | undefined) => boolean" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidInterval", + "text": "isValidInterval" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 255 + "lineNumber": 256 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", "id": "def-server.search.aggs.parentPipelineType", - "type": "string", + "type": "Any", "tags": [], "label": "parentPipelineType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 256 + "lineNumber": 257 }, "deprecated": false }, @@ -40065,31 +31866,20 @@ "label": "parseEsInterval", "description": [], "signature": [ - "(interval: string) => { value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseEsInterval", + "text": "parseEsInterval" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 257 + "lineNumber": 258 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -40099,29 +31889,20 @@ "label": "parseInterval", "description": [], "signature": [ - "(interval: string) => moment.Duration | null" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseInterval", + "text": "parseInterval" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 258 + "lineNumber": 259 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -40131,43 +31912,34 @@ "label": "propFilter", "description": [], "signature": [ - "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.propFilter", + "text": "propFilter" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 259 + "lineNumber": 260 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", "id": "def-server.search.aggs.siblingPipelineType", - "type": "string", + "type": "Any", "tags": [], "label": "siblingPipelineType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 260 + "lineNumber": 261 }, "deprecated": false }, @@ -40183,7 +31955,7 @@ ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 261 + "lineNumber": 262 }, "deprecated": false }, @@ -40195,40 +31967,20 @@ "label": "toAbsoluteDates", "description": [], "signature": [ - "(range: ", + "typeof ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ") => { from: Date; to: Date; } | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.toAbsoluteDates", + "text": "toAbsoluteDates" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 262 + "lineNumber": 263 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -40238,42 +31990,20 @@ "label": "calcAutoIntervalLessThan", "description": [], "signature": [ - "(maxBucketCount: number, duration: number) => moment.Duration" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.calcAutoIntervalLessThan", + "text": "calcAutoIntervalLessThan" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 263 + "lineNumber": 264 }, - "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 - } - ] + "deprecated": false } ] }, @@ -40285,89 +32015,20 @@ "label": "tabifyAggResponse", "description": [], "signature": [ - "(aggConfigs: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", esResponse: Record, respOpts?: Partial<", - "TabbedResponseWriterOptions", - "> | undefined) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "section": "def-common.tabifyAggResponse", + "text": "tabifyAggResponse" } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 265 + "lineNumber": 266 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -40377,62 +32038,20 @@ "label": "tabifyGetColumns", "description": [], "signature": [ - "(aggs: ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[], minimalColumns: boolean) => ", - "TabbedAggColumn", - "[]" + "section": "def-common.tabifyGetColumns", + "text": "tabifyGetColumns" + } ], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 266 + "lineNumber": 267 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -41087,44 +32706,11 @@ "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", - "lineNumber": 32 + "lineNumber": 38 }, "deprecated": false, "children": [ @@ -41147,7 +32733,7 @@ ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 33 + "lineNumber": 39 }, "deprecated": false, "isRequired": false @@ -41181,7 +32767,7 @@ ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 34 + "lineNumber": 40 }, "deprecated": false, "isRequired": true @@ -41215,7 +32801,7 @@ ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 35 + "lineNumber": 41 }, "deprecated": false, "isRequired": true @@ -41240,7 +32826,7 @@ ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", - "lineNumber": 36 + "lineNumber": 42 }, "deprecated": false, "isRequired": true @@ -42189,9 +33775,7 @@ "type": "Object", "tags": [], "label": "filter", - "description": [ - "The filter to clean" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -44846,7 +36430,7 @@ "label": "queryStringOptions", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", @@ -44979,32 +36563,13 @@ "label": "convert", "description": [], "signature": [ - "(value: any) => string" + "FilterFormatterFunction" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 21 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -45020,23 +36585,7 @@ "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 22 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -45787,14 +37336,7 @@ "label": "CustomFilter", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - " & { query: any; }" + "Filter & { query: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", @@ -45845,30 +37387,7 @@ "label": "ExistsFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", @@ -45940,30 +37459,6 @@ "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": { @@ -45981,23 +37476,7 @@ "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; }" + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -46031,15 +37510,7 @@ "label": "FilterState", "description": [], "signature": [ - "{ store: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterStateStore", - "text": "FilterStateStore" - }, - "; }" + "{ store: FilterStateStore; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", @@ -46056,22 +37527,7 @@ "label": "GeoBoundingBoxFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", @@ -46088,30 +37544,7 @@ "label": "GeoBoundingBoxFilterMeta", "description": [], "signature": [ - { - "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" - }, - "; }; }" + "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", @@ -46128,22 +37561,7 @@ "label": "GeoPolygonFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", @@ -46160,22 +37578,7 @@ "label": "GeoPolygonFilterMeta", "description": [], "signature": [ - { - "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" - }, - "[]; }; }" + "FilterMeta & { params: { points: LatLon[];}; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", @@ -46194,7 +37597,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", @@ -46228,22 +37631,7 @@ "label": "MatchAllFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", @@ -46260,22 +37648,7 @@ "label": "MissingFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: MissingFilterMeta; missing: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", @@ -46309,22 +37682,7 @@ "label": "PhraseFilter", "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; }" + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", @@ -46341,14 +37699,7 @@ "label": "PhraseFilterMeta", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterMeta", - "text": "FilterMeta" - }, - " & { params?: { query: string; } | undefined; field?: any; index?: any; }" + "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", @@ -46365,22 +37716,7 @@ "label": "PhrasesFilter", "description": [], "signature": [ - { - "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" - }, - "; }" + "Filter & { meta: PhrasesFilterMeta; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", @@ -46397,14 +37733,7 @@ "label": "PhrasesFilterMeta", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterMeta", - "text": "FilterMeta" - }, - " & { params: string[]; field?: string | undefined; }" + "FilterMeta & { params: string[]; field?: string | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", @@ -46421,22 +37750,7 @@ "label": "QueryStringFilter", "description": [], "signature": [ - { - "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; }" + "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" ], "source": { "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", @@ -46470,30 +37784,7 @@ "label": "RangeFilter", "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; }" + "Filter & EsRangeFilter & { meta: 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", @@ -46510,22 +37801,7 @@ "label": "RangeFilterMeta", "description": [], "signature": [ - { - "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; }" + "FilterMeta & { params: 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 38e27d4df6e2d..d74fb2eee1677 100644 --- a/api_docs/data_autocomplete.json +++ b/api_docs/data_autocomplete.json @@ -356,21 +356,11 @@ "label": "AutocompleteStart", "description": [], "signature": [ - "{ getQuerySuggestions: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionGetFn", - "text": "QuerySuggestionGetFn" - }, - "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", - "ValueSuggestionsGetFn", - "; }" + "{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }" ], "source": { "path": "src/plugins/data/public/autocomplete/autocomplete_service.ts", - "lineNumber": 96 + "lineNumber": 103 }, "deprecated": false, "initialIsOpen": false diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json index 1807c32a18389..ddbccef9e7d70 100644 --- a/api_docs/data_field_formats.json +++ b/api_docs/data_field_formats.json @@ -37,17 +37,7 @@ "label": "FieldFormatsStart", "description": [], "signature": [ - "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", - "; }" + "Pick & { deserialize: FormatFactory; }" ], "source": { "path": "src/plugins/data/public/field_formats/field_formats_service.ts", @@ -124,10 +114,13 @@ { "parentPluginId": "data", "id": "def-common.BoolFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/boolean.ts", "lineNumber": 17 @@ -245,10 +238,13 @@ { "parentPluginId": "data", "id": "def-common.BytesFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 15 @@ -280,10 +276,13 @@ { "parentPluginId": "data", "id": "def-common.BytesFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/bytes.ts", "lineNumber": 20 @@ -361,10 +360,13 @@ { "parentPluginId": "data", "id": "def-common.ColorFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/color.tsx", "lineNumber": 21 @@ -513,7 +515,7 @@ ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 157 + "lineNumber": 211 }, "deprecated": false, "children": [ @@ -535,20 +537,23 @@ ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 158 + "lineNumber": 212 }, "deprecated": false }, { "parentPluginId": "data", "id": "def-common.DurationFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 159 + "lineNumber": 213 }, "deprecated": false }, @@ -570,7 +575,7 @@ ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 162 + "lineNumber": 216 }, "deprecated": false }, @@ -582,11 +587,11 @@ "label": "inputFormats", "description": [], "signature": [ - "{ text: string; kind: string; }[]" + "{ text: any; kind: string; }[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 163 + "lineNumber": 217 }, "deprecated": false }, @@ -598,11 +603,11 @@ "label": "outputFormats", "description": [], "signature": [ - "{ text: string; method: string; }[]" + "({ text: any; method: string; shortText?: undefined; } | { text: any; shortText: any; method: string; })[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 164 + "lineNumber": 218 }, "deprecated": false }, @@ -615,7 +620,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 165 + "lineNumber": 219 }, "deprecated": false }, @@ -631,7 +636,25 @@ ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 167 + "lineNumber": 221 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DurationFormat.isHumanPrecise", + "type": "Function", + "tags": [], + "label": "isHumanPrecise", + "description": [], + "signature": [ + "() => boolean" + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 225 }, "deprecated": false, "children": [], @@ -645,11 +668,11 @@ "label": "getParamDefaults", "description": [], "signature": [ - "() => { inputFormat: string; outputFormat: string; outputPrecision: number; }" + "() => { inputFormat: string; outputFormat: string; outputPrecision: number; includeSpaceWithSuffix: boolean; }" ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 170 + "lineNumber": 229 }, "deprecated": false, "children": [], @@ -663,11 +686,11 @@ "label": "textConvert", "description": [], "signature": [ - "(val: any) => string" + "(val: any) => any" ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 178 + "lineNumber": 238 }, "deprecated": false, "children": [ @@ -683,7 +706,7 @@ ], "source": { "path": "src/plugins/data/common/field_formats/converters/duration.ts", - "lineNumber": 178 + "lineNumber": 238 }, "deprecated": false, "isRequired": true @@ -1223,10 +1246,15 @@ "label": "from", "description": [], "signature": [ - "(convertFn: ", - "FieldFormatConvertFunction", - ") => ", - "FieldFormatInstanceType" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ".from" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -1281,14 +1309,15 @@ "label": "isInstanceOfFieldFormat", "description": [], "signature": [ - "(fieldFormat: any) => fieldFormat is ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FieldFormat", "text": "FieldFormat" - } + }, + ".isInstanceOfFieldFormat" ], "source": { "path": "src/plugins/data/common/field_formats/field_format.ts", @@ -1687,9 +1716,7 @@ "type": "Enum", "tags": [], "label": "fieldType", - "description": [ - "- the field type" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -1712,9 +1739,7 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [ - "- Array of ES data types" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -1763,9 +1788,7 @@ "type": "string", "tags": [], "label": "formatId", - "description": [ - "- the format id" - ], + "description": [], "signature": [ "string" ], @@ -1884,9 +1907,7 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [ - "- Array of ES data types" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -1949,9 +1970,7 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [ - "- Array of ES data types" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -2099,39 +2118,7 @@ "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 162 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2427,71 +2414,7 @@ "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", "lineNumber": 242 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2648,10 +2571,13 @@ { "parentPluginId": "data", "id": "def-common.HistogramFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 20 @@ -2683,10 +2609,13 @@ { "parentPluginId": "data", "id": "def-common.HistogramFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/histogram.ts", "lineNumber": 25 @@ -2818,10 +2747,13 @@ { "parentPluginId": "data", "id": "def-common.IpFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/ip.ts", "lineNumber": 16 @@ -2938,10 +2870,13 @@ { "parentPluginId": "data", "id": "def-common.NumberFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 15 @@ -2973,10 +2908,13 @@ { "parentPluginId": "data", "id": "def-common.NumberFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/number.ts", "lineNumber": 20 @@ -3048,10 +2986,13 @@ { "parentPluginId": "data", "id": "def-common.PercentFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 16 @@ -3083,10 +3024,13 @@ { "parentPluginId": "data", "id": "def-common.PercentFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/percent.ts", "lineNumber": 21 @@ -3218,10 +3162,13 @@ { "parentPluginId": "data", "id": "def-common.RelativeDateFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", "lineNumber": 17 @@ -3526,10 +3473,13 @@ { "parentPluginId": "data", "id": "def-common.StaticLookupFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", "lineNumber": 26 @@ -3671,10 +3621,13 @@ { "parentPluginId": "data", "id": "def-common.StringFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", "lineNumber": 64 @@ -3712,7 +3665,7 @@ "label": "transformOptions", "description": [], "signature": [ - "({ kind: boolean; text: string; } | { kind: string; text: string; })[]" + "({ kind: boolean; text: any; } | { kind: string; text: any; })[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", @@ -3832,10 +3785,13 @@ { "parentPluginId": "data", "id": "def-common.TruncateFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/truncate.ts", "lineNumber": 19 @@ -3958,10 +3914,13 @@ { "parentPluginId": "data", "id": "def-common.UrlFormat.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", "lineNumber": 48 @@ -3999,7 +3958,7 @@ "label": "urlTypes", "description": [], "signature": [ - "{ kind: string; text: string; }[]" + "{ kind: string; text: any; }[]" ], "source": { "path": "src/plugins/data/common/field_formats/converters/url.ts", @@ -4248,7 +4207,7 @@ "label": "params", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -4355,7 +4314,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", @@ -4372,19 +4331,7 @@ "label": "FieldFormatsStartCommon", "description": [], "signature": [ - "{ init: (getConfig: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - }, - ", metaParamsOptions?: Record, defaultFieldConverters?: ", - "FieldFormatInstanceType", - "[]) => void; register: (fieldFormats: ", - "FieldFormatInstanceType", - "[]) => void; deserialize: ", + "{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ", "FormatFactory", "; getDefaultConfig: (fieldType: ", { @@ -4402,19 +4349,7 @@ "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: ", + "[] | undefined) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (fieldType: ", { "pluginId": "data", "scope": "common", @@ -4429,140 +4364,7 @@ "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", @@ -4579,7 +4381,13 @@ "label": "HTML_CONTEXT_TYPE", "description": [], "signature": [ - "\"html\" | \"text\"" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } ], "source": { "path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts", @@ -4596,13 +4404,7 @@ "label": "IFieldFormat", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } + "FieldFormat" ], "source": { "path": "src/plugins/data/common/field_formats/types.ts", @@ -4640,176 +4442,7 @@ "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", @@ -4826,7 +4459,13 @@ "label": "TEXT_CONTEXT_TYPE", "description": [], "signature": [ - "\"html\" | \"text\"" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } ], "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 676ded76cb331..cc8c83dc935da 100644 --- a/api_docs/data_index_patterns.json +++ b/api_docs/data_index_patterns.json @@ -523,8 +523,7 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" - }, - ">; }" + } ], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", @@ -1171,7 +1170,7 @@ "label": "fieldFormatMap", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", @@ -1302,42 +1301,7 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -1347,45 +1311,13 @@ "label": "formatField", "description": [], "signature": [ - "(hit: Record, fieldName: string) => any" + "FormatFieldFn" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 67 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -1401,42 +1333,7 @@ "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -1689,7 +1586,9 @@ "parentPluginId": "data", "id": "def-common.IndexPattern.addScriptedField", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "addScriptedField", "description": [ "\nAdd scripted field to field list\n" @@ -1699,9 +1598,10 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, - "deprecated": false, + "deprecated": true, + "references": [], "children": [ { "parentPluginId": "data", @@ -1717,7 +1617,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -1736,7 +1636,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -1753,7 +1653,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 244 + "lineNumber": 245 }, "deprecated": false, "isRequired": true @@ -1765,7 +1665,9 @@ "parentPluginId": "data", "id": "def-common.IndexPattern.removeScriptedField", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "removeScriptedField", "description": [ "\nRemove scripted field from field list" @@ -1775,9 +1677,25 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 + "lineNumber": 272 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx", + "lineNumber": 117 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/field_editor/field_editor.tsx", + "lineNumber": 777 + } + } + ], "children": [ { "parentPluginId": "data", @@ -1791,7 +1709,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 270 + "lineNumber": 272 }, "deprecated": false, "isRequired": true @@ -1803,9 +1721,13 @@ "parentPluginId": "data", "id": "def-common.IndexPattern.getNonScriptedFields", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getNonScriptedFields", - "description": [], + "description": [ + "\n" + ], "signature": [ "() => ", { @@ -1819,9 +1741,74 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 277 + "lineNumber": 283 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx", + "lineNumber": 152 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 66 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 74 + } + }, + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx", + "lineNumber": 204 + } + }, + { + "plugin": "visTypeTimeseries", + "link": { + "path": "src/plugins/vis_type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts", + "lineNumber": 65 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts", + "lineNumber": 106 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts", + "lineNumber": 29 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts", + "lineNumber": 122 + } + }, + { + "plugin": "graph", + "link": { + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts", + "lineNumber": 244 + } + } + ], "children": [], "returnComment": [] }, @@ -1829,9 +1816,13 @@ "parentPluginId": "data", "id": "def-common.IndexPattern.getScriptedFields", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getScriptedFields", - "description": [], + "description": [ + "\n" + ], "signature": [ "() => ", { @@ -1845,9 +1836,18 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 281 + "lineNumber": 291 }, - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "indexPatternManagement", + "link": { + "path": "src/plugins/index_pattern_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx", + "lineNumber": 61 + } + } + ], "children": [], "returnComment": [] }, @@ -1863,7 +1863,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 285 + "lineNumber": 295 }, "deprecated": false, "children": [], @@ -1881,7 +1881,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 289 + "lineNumber": 299 }, "deprecated": false, "children": [], @@ -1907,7 +1907,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 294 + "lineNumber": 304 }, "deprecated": false, "children": [], @@ -1933,7 +1933,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 + "lineNumber": 309 }, "deprecated": false, "children": [ @@ -1949,7 +1949,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 299 + "lineNumber": 309 }, "deprecated": false, "isRequired": true @@ -1969,7 +1969,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 304 + "lineNumber": 314 }, "deprecated": false, "children": [], @@ -1985,11 +1985,18 @@ "\nReturns index pattern as saved object body for saving" ], "signature": [ - "() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + } ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 311 + "lineNumber": 321 }, "deprecated": false, "children": [], @@ -2040,7 +2047,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 339 + "lineNumber": 347 }, "deprecated": false, "children": [ @@ -2078,7 +2085,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 340 + "lineNumber": 348 }, "deprecated": false, "isRequired": true @@ -2108,7 +2115,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "children": [ @@ -2126,7 +2133,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "isRequired": true @@ -2151,7 +2158,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 360 + "lineNumber": 368 }, "deprecated": false, "isRequired": true @@ -2173,7 +2180,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 + "lineNumber": 392 }, "deprecated": false, "children": [ @@ -2191,7 +2198,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 384 + "lineNumber": 392 }, "deprecated": false, "isRequired": true @@ -2221,7 +2228,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 + "lineNumber": 412 }, "deprecated": false, "children": [ @@ -2237,7 +2244,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 404 + "lineNumber": 412 }, "deprecated": false, "isRequired": true @@ -2265,7 +2272,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 411 + "lineNumber": 419 }, "deprecated": false, "children": [ @@ -2281,7 +2288,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 412 + "lineNumber": 420 }, "deprecated": false, "isRequired": true @@ -2298,7 +2305,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 413 + "lineNumber": 421 }, "deprecated": false, "isRequired": true @@ -2322,7 +2329,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 414 + "lineNumber": 422 }, "deprecated": false, "isRequired": true @@ -2342,7 +2349,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "children": [ @@ -2358,7 +2365,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "isRequired": true @@ -2375,7 +2382,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 422 + "lineNumber": 430 }, "deprecated": false, "isRequired": false @@ -2395,7 +2402,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "children": [ @@ -2411,7 +2418,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "isRequired": true @@ -2428,7 +2435,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 433 + "lineNumber": 441 }, "deprecated": false, "isRequired": false @@ -2456,7 +2463,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "children": [ @@ -2472,7 +2479,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "isRequired": true @@ -2496,7 +2503,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 446 + "lineNumber": 454 }, "deprecated": false, "isRequired": true @@ -2516,7 +2523,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 + "lineNumber": 458 }, "deprecated": false, "children": [ @@ -2532,7 +2539,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", - "lineNumber": 450 + "lineNumber": 458 }, "deprecated": false, "isRequired": true @@ -3221,15 +3228,13 @@ "label": "ensureDefaultIndexPattern", "description": [], "signature": [ - "() => Promise | undefined" + "EnsureDefaultIndexPattern" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -3291,9 +3296,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -3331,9 +3334,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -3436,9 +3437,7 @@ "type": "boolean", "tags": [], "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "description": [], "signature": [ "boolean" ], @@ -3476,9 +3475,7 @@ "type": "string", "tags": [], "label": "id", - "description": [ - "optionally clear a single id" - ], + "description": [], "signature": [ "string | undefined" ], @@ -3873,9 +3870,7 @@ "type": "Array", "tags": [], "label": "fields", - "description": [ - ": FieldSpec[]" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -3899,9 +3894,7 @@ "type": "Object", "tags": [], "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -4012,7 +4005,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "children": [ @@ -4028,7 +4021,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 473 + "lineNumber": 480 }, "deprecated": false, "isRequired": true @@ -4066,7 +4059,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "children": [ @@ -4088,7 +4081,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -4105,7 +4098,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 492 + "lineNumber": 499 }, "deprecated": false, "isRequired": true @@ -4145,7 +4138,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "children": [ @@ -4167,7 +4160,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -4186,7 +4179,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -4205,7 +4198,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 517 + "lineNumber": 524 }, "deprecated": false, "isRequired": true @@ -4243,7 +4236,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "children": [ @@ -4265,7 +4258,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -4284,7 +4277,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 530 + "lineNumber": 537 }, "deprecated": false, "isRequired": true @@ -4314,7 +4307,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 558 + "lineNumber": 570 }, "deprecated": false, "children": [ @@ -4336,7 +4329,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 559 + "lineNumber": 571 }, "deprecated": false, "isRequired": true @@ -4353,7 +4346,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 560 + "lineNumber": 572 }, "deprecated": false, "isRequired": true @@ -4370,7 +4363,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 561 + "lineNumber": 573 }, "deprecated": false, "isRequired": true @@ -4392,7 +4385,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "children": [ @@ -4410,7 +4403,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 644 + "lineNumber": 656 }, "deprecated": false, "isRequired": true @@ -4515,7 +4508,7 @@ "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", "text": "IndexPatternLoadExpressionFunctionDefinition" }, - ", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"help\" | \"disabled\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">" + ", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"disabled\" | \"help\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">" ], "source": { "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", @@ -5542,7 +5535,7 @@ "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 58 + "lineNumber": 59 } }, { @@ -6599,14 +6592,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts", - "lineNumber": 5 + "lineNumber": 6 } }, { @@ -6627,14 +6620,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts", - "lineNumber": 17 + "lineNumber": 18 } }, { @@ -6711,28 +6704,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts", - "lineNumber": 6 + "lineNumber": 7 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts", - "lineNumber": 8 + "lineNumber": 9 } }, { @@ -6795,14 +6788,14 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts", - "lineNumber": 9 + "lineNumber": 10 } }, { @@ -6893,28 +6886,28 @@ "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 248 + "lineNumber": 249 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 287 + "lineNumber": 289 } }, { "plugin": "lens", "link": { "path": "x-pack/plugins/lens/server/routes/field_stats.ts", - "lineNumber": 329 + "lineNumber": 331 } }, { @@ -7582,20 +7575,6 @@ "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": { @@ -8093,8 +8072,7 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - }, - ") | undefined" + } ], "source": { "path": "src/plugins/data/common/index_patterns/fields/types.ts", @@ -8351,6 +8329,20 @@ "lineNumber": 85 } }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx", + "lineNumber": 25 + } + }, + { + "plugin": "lens", + "link": { + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx", + "lineNumber": 102 + } + }, { "plugin": "lens", "link": { @@ -8457,21 +8449,7 @@ } }, { - "plugin": "apm", - "link": { - "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", - "lineNumber": 14 - } - }, - { - "plugin": "apm", - "link": { - "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", - "lineNumber": 31 - } - }, - { - "plugin": "infra", + "plugin": "infra", "link": { "path": "x-pack/plugins/infra/public/containers/with_kuery_autocompletion.tsx", "lineNumber": 9 @@ -8638,6 +8616,20 @@ "lineNumber": 23 } }, + { + "plugin": "apm", + "link": { + "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", + "lineNumber": 14 + } + }, + { + "plugin": "apm", + "link": { + "path": "x-pack/plugins/apm/public/components/shared/KueryBar/index.tsx", + "lineNumber": 31 + } + }, { "plugin": "lists", "link": { @@ -8670,21 +8662,21 @@ "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts", - "lineNumber": 21 + "lineNumber": 22 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts", - "lineNumber": 66 + "lineNumber": 72 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts", - "lineNumber": 19 + "lineNumber": 20 } }, { @@ -8943,21 +8935,21 @@ "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", - "lineNumber": 44 + "lineNumber": 48 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", - "lineNumber": 60 + "lineNumber": 64 } }, { "plugin": "securitySolution", "link": { "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", - "lineNumber": 65 + "lineNumber": 69 } }, { @@ -9086,20 +9078,6 @@ "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": { @@ -9142,27 +9120,6 @@ "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": { @@ -9195,126 +9152,28 @@ "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts", - "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 + "lineNumber": 6 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 1 + "lineNumber": 2 } }, { "plugin": "infra", "link": { "path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts", - "lineNumber": 11 + "lineNumber": 12 } }, { @@ -9744,6 +9603,20 @@ "lineNumber": 30 } }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts", + "lineNumber": 13 + } + }, + { + "plugin": "securitySolution", + "link": { + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts", + "lineNumber": 52 + } + }, { "plugin": "stackAlerts", "link": { @@ -9947,20 +9820,6 @@ "lineNumber": 1352 } }, - { - "plugin": "discover", - "link": { - "path": "src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx", - "lineNumber": 17 - } - }, - { - "plugin": "discover", - "link": { - "path": "src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx", - "lineNumber": 26 - } - }, { "plugin": "maps", "link": { @@ -10077,14 +9936,14 @@ "plugin": "observability", "link": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", - "lineNumber": 18 + "lineNumber": 19 } }, { "plugin": "observability", "link": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", - "lineNumber": 95 + "lineNumber": 104 } }, { @@ -10126,7 +9985,7 @@ "plugin": "observability", "link": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts", - "lineNumber": 24 + "lineNumber": 25 } }, { @@ -10969,8 +10828,7 @@ "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - }, - ">" + } ], "source": { "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", @@ -11082,32 +10940,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 136 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -11131,32 +10964,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 137 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -11698,7 +11506,7 @@ "label": "type", "description": [], "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\"" + "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"ip\" | \"double\"" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", @@ -11762,32 +11570,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 103 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -11805,36 +11588,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 104 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -11852,68 +11606,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 105 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -11931,55 +11624,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 111 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -11995,36 +11640,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 116 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -12229,23 +11845,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 88 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -12261,9 +11861,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 89 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -12279,39 +11877,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 90 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -12327,23 +11893,7 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "lineNumber": 91 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -12376,15 +11926,7 @@ "label": "FieldFormatMap", "description": [], "signature": [ - "{ [x: string]: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - ">; }" + "{ [x: string]: SerializedFieldFormat>; }" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", @@ -12418,15 +11960,7 @@ "label": "IndexPatternFieldMap", "description": [], "signature": [ - "{ [x: string]: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "; }" + "{ [x: string]: FieldSpec; }" ], "source": { "path": "src/plugins/data/common/index_patterns/types.ts", @@ -12443,14 +11977,7 @@ "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"indexPatternLoad\", null, Arguments, Output, ", + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -12485,179 +12012,11 @@ "label": "IndexPatternsContract", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 650 + "lineNumber": 662 }, "deprecated": false, "initialIsOpen": false @@ -12720,7 +12079,7 @@ "label": "RuntimeType", "description": [], "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\"" + "\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"ip\" | \"double\"" ], "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 a9c1711136951..c8fff2616931e 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -528,23 +528,15 @@ "label": "setFiltersStore", "description": [], "signature": [ - "(filters: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[], store: ", + "typeof ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterStateStore", - "text": "FilterStateStore" + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" }, - ", shouldOverrideStore?: boolean) => void" + ".setFiltersStore" ], "source": { "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", @@ -802,114 +794,7 @@ "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", @@ -952,96 +837,7 @@ "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\">" + "Observable" ], "source": { "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", @@ -1056,9 +852,7 @@ "type": "Object", "tags": [], "label": "stateContainer", - "description": [ - "to use for syncing" - ], + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -1305,104 +1099,7 @@ "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\">, kbnUrlStateStorage: ", - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IKbnUrlStateStorage", - "text": "IKbnUrlStateStorage" - }, - ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" + "Observable" ], "source": { "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", @@ -1445,96 +1142,7 @@ "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\">" + "Observable" ], "source": { "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", @@ -1549,9 +1157,7 @@ "type": "Object", "tags": [], "label": "kbnUrlStateStorage", - "description": [ - "to use for syncing" - ], + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -1824,42 +1430,7 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -1883,9 +1454,7 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 33 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -1895,72 +1464,21 @@ "label": "findSavedQueries", "description": [], "signature": [ - "(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]; }>" - ], - "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 - }, + "(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ", { - "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 - } - ] + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + "[]; }>" + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 34 + }, + "deprecated": false }, { "parentPluginId": "data", @@ -1984,23 +1502,7 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 39 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2016,23 +1518,7 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 40 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2048,9 +1534,7 @@ "path": "src/plugins/data/public/query/saved_query/types.ts", "lineNumber": 41 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -2111,25 +1595,15 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "section": "def-common.Query", "text": "Query" }, - ") => void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: Pick<", - "QueryStringManager", - ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + ") => void; filterManager: FilterManager; queryString: Pick; savedQueries: ", { "pluginId": "data", "scope": "public", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "section": "def-public.SavedQueryService", "text": "SavedQueryService" }, @@ -2139,7 +1613,7 @@ { "pluginId": "data", "scope": "public", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "section": "def-public.QueryStateChange", "text": "QueryStateChange" }, @@ -2147,53 +1621,10 @@ { "pluginId": "data", "scope": "public", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "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", @@ -2210,22 +1641,7 @@ "label": "SavedQueryTimeFilter", "description": [], "signature": [ - { - "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" - }, - "; }" + "TimeRange & { refreshInterval: RefreshInterval; }" ], "source": { "path": "src/plugins/data/public/query/saved_query/types.ts", @@ -2250,129 +1666,8 @@ "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" - }, - "; }" + "; getFetch$: () => ", + "Observable" ], "source": { "path": "src/plugins/data/public/query/timefilter/timefilter.ts", @@ -2389,23 +1684,7 @@ "label": "TimeHistoryContract", "description": [], "signature": [ - "{ 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" - }, - "[]; }" + "{ add: (time: TimeRange) => void; get: () => TimeRange[]; }" ], "source": { "path": "src/plugins/data/public/query/timefilter/time_history.ts", @@ -2552,8 +1831,7 @@ "docId": "kibDataQueryPluginApi", "section": "def-common.FilterCompareOptions", "text": "FilterCompareOptions" - }, - ") => boolean" + } ], "source": { "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", @@ -2567,9 +1845,7 @@ "type": "CompoundType", "tags": [], "label": "first", - "description": [ - "The first filter or filter array to compare" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -2601,9 +1877,7 @@ "type": "CompoundType", "tags": [], "label": "second", - "description": [ - "The second filter or filter array to compare" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -2635,9 +1909,7 @@ "type": "Object", "tags": [], "label": "comparatorOptions", - "description": [ - "Parameters to use for comparison" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -2716,9 +1988,7 @@ "type": "Array", "tags": [], "label": "existingFilters", - "description": [ - "- The filters to compare to" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -2742,9 +2012,7 @@ "type": "Array", "tags": [], "label": "filters", - "description": [ - "- The filters being added" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -2768,9 +2036,7 @@ "type": "Object", "tags": [], "label": "comparatorOptions", - "description": [ - "- Parameters to use for comparison" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -3148,9 +2414,7 @@ "type": "Array", "tags": [], "label": "filters", - "description": [ - "The filters to remove duplicates from" - ], + "description": [], "signature": [ { "pluginId": "data", @@ -3174,9 +2438,7 @@ "type": "Any", "tags": [], "label": "comparatorOptions", - "description": [ - "- Parameters to use for comparison" - ], + "description": [], "signature": [ "any" ], diff --git a/api_docs/data_search.json b/api_docs/data_search.json index d72ae79e79bd8..ba115706cb063 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -815,45 +815,9 @@ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ - "{ 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", - "; }" + "Pick<", + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -871,75 +835,9 @@ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "signature": [ - "{ 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>>; }" + "Pick<", + "SessionsClient", + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -975,91 +873,13 @@ "\nagg config sub service\n{@link AggsStart}\n" ], "signature": [ - "{ 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: ", + "Pick & Pick<{ types: ", + "AggTypesRegistryStart", + "; }, \"types\"> & Pick<{ types: ", "AggTypesRegistryStart", - "; }" + "; }, never>, \"calculateAutoTimeExpression\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -1077,97 +897,19 @@ "\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", - "" + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 53 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -1183,26 +925,7 @@ "path": "src/plugins/data/public/search/types.ts", "lineNumber": 55 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -1238,45 +961,9 @@ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ - "{ 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", - "; }" + "Pick<", + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -1294,75 +981,9 @@ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "signature": [ - "{ 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>>; }" + "Pick<", + "SessionsClient", + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" ], "source": { "path": "src/plugins/data/public/search/types.ts", @@ -1606,153 +1227,15 @@ "label": "toasts", "description": [], "signature": [ - "{ 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) => ", + "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastsApi", + "text": "ToastsApi" }, - "; }" + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], "source": { "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", @@ -1785,45 +1268,9 @@ "label": "session", "description": [], "signature": [ - "{ 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", - "; }" + "Pick<", + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ], "source": { "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", @@ -1875,9 +1322,7 @@ "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 46 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -1927,9 +1372,7 @@ "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 54 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -2012,16 +1455,7 @@ "label": "IEsError", "description": [], "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.KibanaServerError", - "text": "KibanaServerError" - }, - "<", - "IEsErrorAttributes", - ">" + "KibanaServerError" ], "source": { "path": "src/plugins/data/public/search/errors/types.ts", @@ -2038,75 +1472,7 @@ "label": "ISessionsClient", "description": [], "signature": [ - "{ 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>>; }" + "{ 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>; }" ], "source": { "path": "src/plugins/data/public/search/session/sessions_client.ts", @@ -2123,45 +1489,7 @@ "label": "ISessionService", "description": [], "signature": [ - "{ 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", - "; }" + "{ 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; }" ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", @@ -2173,12 +1501,15 @@ { "parentPluginId": "data", "id": "def-public.noSearchSessionStorageCapabilityMessage", - "type": "string", + "type": "Any", "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 @@ -2272,7 +1603,7 @@ "label": "getShardTimeout", "description": [], "signature": [ - "(config: Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: 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 autocompleteTimeout: 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; }>; }>; 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: ", + "(config: 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", ") => boolean; isLessThan: (other: ", "ByteSizeValue", @@ -2281,8 +1612,7 @@ ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>) => Pick<", "Search", "<", - "RequestBody", - ">>, \"timeout\">" + "RequestBody" ], "source": { "path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts", @@ -2298,7 +1628,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: 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 autocompleteTimeout: 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; }>; }>; 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: ", + "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", ") => boolean; isLessThan: (other: ", "ByteSizeValue", @@ -2710,39 +2040,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 91 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2760,23 +2058,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 92 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2794,7 +2076,7 @@ "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<", + ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", @@ -2808,52 +2090,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 93 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2877,39 +2114,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 94 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2925,23 +2130,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 95 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2957,23 +2146,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 96 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -2997,39 +2170,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 97 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -3089,32 +2230,7 @@ "path": "src/plugins/data/server/search/session/types.ts", "lineNumber": 39 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -3197,53 +2313,13 @@ "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStrategy", "text": "ISearchStrategy" - }, - ") => void" + } ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 49 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -3336,26 +2412,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 110 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -3386,33 +2443,7 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 113 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -3506,80 +2537,17 @@ "path": "src/plugins/data/server/search/types.ts", "lineNumber": 76 }, - "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", - "id": "def-server.ISearchStrategy.cancel", - "type": "Function", - "tags": [], - "label": "cancel", - "description": [], - "signature": [ - "((id: string, options: ", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.cancel", + "type": "Function", + "tags": [], + "label": "cancel", + "description": [], + "signature": [ + "((id: string, options: ", { "pluginId": "data", "scope": "common", @@ -3659,307 +2627,15 @@ "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 ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" + "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/plugins/data/server/search/types.ts", @@ -4135,13 +2811,7 @@ "label": "SearchRequestHandlerContext", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.IScopedSearchClient", - "text": "IScopedSearchClient" - } + "IScopedSearchClient" ], "source": { "path": "src/plugins/data/server/search/types.ts", @@ -4164,7 +2834,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 55 + "lineNumber": 57 }, "deprecated": false, "children": [ @@ -4180,11 +2850,19 @@ "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" ], "signature": [ - "(list: any[]) => any[]" + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ".ensureIds" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 63 + "lineNumber": 65 }, "deprecated": false, "children": [ @@ -4202,7 +2880,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 63 + "lineNumber": 65 }, "deprecated": false, "isRequired": true @@ -4224,7 +2902,7 @@ "\nCalculate the next id based on the ids in this list\n" ], "signature": [ - "(list: ", + "typeof ", { "pluginId": "data", "scope": "common", @@ -4232,11 +2910,11 @@ "section": "def-common.AggConfig", "text": "AggConfig" }, - "[]) => number" + ".nextId" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 83 + "lineNumber": 85 }, "deprecated": false, "children": [ @@ -4259,7 +2937,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 83 + "lineNumber": 85 }, "deprecated": false, "isRequired": true @@ -4287,7 +2965,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 92 + "lineNumber": 94 }, "deprecated": false }, @@ -4300,7 +2978,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 93 + "lineNumber": 95 }, "deprecated": false }, @@ -4313,7 +2991,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 94 + "lineNumber": 96 }, "deprecated": false }, @@ -4329,7 +3007,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 95 + "lineNumber": 97 }, "deprecated": false }, @@ -4352,7 +3030,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 96 + "lineNumber": 98 }, "deprecated": false }, @@ -4368,7 +3046,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 97 + "lineNumber": 99 }, "deprecated": false }, @@ -4384,7 +3062,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 98 + "lineNumber": 100 }, "deprecated": false }, @@ -4400,7 +3078,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 + "lineNumber": 106 }, "deprecated": false, "children": [ @@ -4422,7 +3100,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 + "lineNumber": 106 }, "deprecated": false, "isRequired": true @@ -4457,7 +3135,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 104 + "lineNumber": 106 }, "deprecated": false, "isRequired": true @@ -4481,7 +3159,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 134 + "lineNumber": 136 }, "deprecated": false, "children": [ @@ -4499,7 +3177,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 134 + "lineNumber": 136 }, "deprecated": false, "isRequired": true @@ -4519,7 +3197,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 171 + "lineNumber": 173 }, "deprecated": false, "children": [ @@ -4535,7 +3213,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 171 + "lineNumber": 173 }, "deprecated": false, "isRequired": true @@ -4543,6 +3221,42 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-common.AggConfig.hasTimeShift", + "type": "Function", + "tags": [], + "label": "hasTimeShift", + "description": [], + "signature": [ + "() => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 177 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfig.getTimeShift", + "type": "Function", + "tags": [], + "label": "getTimeShift", + "description": [], + "signature": [ + "() => moment.Duration | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 181 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-common.AggConfig.write", @@ -4563,7 +3277,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 175 + "lineNumber": 202 }, "deprecated": false, "children": [ @@ -4586,7 +3300,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 175 + "lineNumber": 202 }, "deprecated": false, "isRequired": false @@ -4606,7 +3320,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 179 + "lineNumber": 206 }, "deprecated": false, "children": [], @@ -4624,7 +3338,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 + "lineNumber": 210 }, "deprecated": false, "children": [ @@ -4640,7 +3354,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 + "lineNumber": 210 }, "deprecated": false, "isRequired": true @@ -4657,7 +3371,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 183 + "lineNumber": 210 }, "deprecated": false, "isRequired": true @@ -4697,7 +3411,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 + "lineNumber": 236 }, "deprecated": false, "children": [ @@ -4721,7 +3435,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 + "lineNumber": 236 }, "deprecated": false, "isRequired": true @@ -4745,7 +3459,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 209 + "lineNumber": 236 }, "deprecated": false, "isRequired": false @@ -4777,7 +3491,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 230 + "lineNumber": 257 }, "deprecated": false, "children": [ @@ -4802,7 +3516,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 230 + "lineNumber": 257 }, "deprecated": false, "isRequired": false @@ -4826,7 +3540,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 265 + "lineNumber": 292 }, "deprecated": false, "children": [], @@ -4850,7 +3564,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 296 + "lineNumber": 323 }, "deprecated": true, "references": [ @@ -4879,7 +3593,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 307 + "lineNumber": 334 }, "deprecated": false, "children": [], @@ -4905,7 +3619,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 316 + "lineNumber": 343 }, "deprecated": false, "children": [], @@ -4941,7 +3655,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 371 + "lineNumber": 398 }, "deprecated": false, "children": [], @@ -4967,7 +3681,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 375 + "lineNumber": 402 }, "deprecated": false, "children": [], @@ -4993,7 +3707,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 379 + "lineNumber": 406 }, "deprecated": false, "children": [], @@ -5011,7 +3725,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 383 + "lineNumber": 410 }, "deprecated": false, "children": [ @@ -5027,7 +3741,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 383 + "lineNumber": 410 }, "deprecated": false, "isRequired": true @@ -5047,7 +3761,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 + "lineNumber": 414 }, "deprecated": false, "children": [ @@ -5063,7 +3777,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 + "lineNumber": 414 }, "deprecated": false, "isRequired": true @@ -5080,7 +3794,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 387 + "lineNumber": 414 }, "deprecated": false, "isRequired": false @@ -5100,7 +3814,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 395 + "lineNumber": 422 }, "deprecated": false, "children": [], @@ -5118,7 +3832,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 401 + "lineNumber": 428 }, "deprecated": false, "children": [], @@ -5138,7 +3852,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 410 + "lineNumber": 437 }, "deprecated": false, "children": [], @@ -5156,7 +3870,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 414 + "lineNumber": 441 }, "deprecated": false, "children": [ @@ -5172,7 +3886,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 414 + "lineNumber": 441 }, "deprecated": false, "isRequired": true @@ -5199,7 +3913,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 428 + "lineNumber": 455 }, "deprecated": false, "children": [], @@ -5225,7 +3939,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 432 + "lineNumber": 459 }, "deprecated": false, "children": [], @@ -5243,7 +3957,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 436 + "lineNumber": 463 }, "deprecated": false, "children": [], @@ -5261,7 +3975,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 441 + "lineNumber": 468 }, "deprecated": false, "children": [], @@ -5279,38 +3993,13 @@ "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" - }, - ">>" + "section": "def-common.IAggType", + "text": "IAggType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 452 + "lineNumber": 479 }, "deprecated": false }, @@ -5326,38 +4015,13 @@ "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" - }, - ">>" + "section": "def-common.IAggType", + "text": "IAggType" + } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 456 + "lineNumber": 483 }, "deprecated": false }, @@ -5381,7 +4045,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 486 + "lineNumber": 513 }, "deprecated": false, "children": [ @@ -5403,7 +4067,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 486 + "lineNumber": 513 }, "deprecated": false, "isRequired": true @@ -5423,7 +4087,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 + "lineNumber": 76 }, "deprecated": false, "children": [ @@ -5445,7 +4109,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 66 + "lineNumber": 77 }, "deprecated": false }, @@ -5468,7 +4132,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 67 + "lineNumber": 78 }, "deprecated": false }, @@ -5484,7 +4148,23 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 68 + "lineNumber": 79 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.forceNow", + "type": "Object", + "tags": [], + "label": "forceNow", + "description": [], + "signature": [ + "Date | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 80 }, "deprecated": false }, @@ -5500,7 +4180,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 69 + "lineNumber": 81 }, "deprecated": false }, @@ -5523,7 +4203,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 + "lineNumber": 85 }, "deprecated": false }, @@ -5539,7 +4219,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 + "lineNumber": 87 }, "deprecated": false, "children": [ @@ -5561,7 +4241,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 76 + "lineNumber": 88 }, "deprecated": false, "isRequired": true @@ -5596,7 +4276,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 77 + "lineNumber": 89 }, "deprecated": false, "isRequired": true @@ -5619,7 +4299,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 78 + "lineNumber": 90 }, "deprecated": false, "isRequired": true @@ -5639,7 +4319,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 103 }, "deprecated": false, "children": [ @@ -5655,7 +4335,43 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 103 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.setForceNow", + "type": "Function", + "tags": [], + "label": "setForceNow", + "description": [], + "signature": [ + "(now: Date | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 107 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.setForceNow.$1", + "type": "Object", + "tags": [], + "label": "now", + "description": [], + "signature": [ + "Date | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 107 }, "deprecated": false, "isRequired": false @@ -5683,7 +4399,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 95 + "lineNumber": 111 }, "deprecated": false, "children": [ @@ -5705,7 +4421,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 95 + "lineNumber": 111 }, "deprecated": false, "isRequired": true @@ -5732,7 +4448,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 113 + "lineNumber": 129 }, "deprecated": false, "children": [ @@ -5748,7 +4464,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 113 + "lineNumber": 129 }, "deprecated": false, "isRequired": true @@ -5797,12 +4513,11 @@ "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", - "lineNumber": 126 + "lineNumber": 142 }, "deprecated": false, "children": [ @@ -5836,7 +4551,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 127 + "lineNumber": 143 }, "deprecated": false, "isRequired": true @@ -5853,7 +4568,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 128 + "lineNumber": 144 }, "deprecated": false, "isRequired": true @@ -5883,7 +4598,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 169 + "lineNumber": 185 }, "deprecated": false, "children": [ @@ -5908,7 +4623,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 169 + "lineNumber": 185 }, "deprecated": false, "isRequired": true @@ -5928,7 +4643,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 181 + "lineNumber": 197 }, "deprecated": false, "children": [], @@ -5954,7 +4669,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 + "lineNumber": 287 }, "deprecated": false, "children": [], @@ -5979,7 +4694,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 291 }, "deprecated": false, "children": [ @@ -5995,7 +4710,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 291 }, "deprecated": false, "isRequired": true @@ -6023,7 +4738,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 295 }, "deprecated": false, "children": [ @@ -6039,7 +4754,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 295 }, "deprecated": false, "isRequired": true @@ -6067,7 +4782,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 299 }, "deprecated": false, "children": [ @@ -6083,7 +4798,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 299 }, "deprecated": false, "isRequired": true @@ -6111,7 +4826,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 303 }, "deprecated": false, "children": [ @@ -6127,7 +4842,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 303 }, "deprecated": false, "isRequired": true @@ -6155,7 +4870,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 307 }, "deprecated": false, "children": [ @@ -6171,7 +4886,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 307 }, "deprecated": false, "isRequired": true @@ -6199,7 +4914,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 + "lineNumber": 311 }, "deprecated": false, "children": [ @@ -6215,7 +4930,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 + "lineNumber": 311 }, "deprecated": false, "isRequired": true @@ -6243,7 +4958,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 278 + "lineNumber": 315 }, "deprecated": false, "children": [], @@ -6251,59 +4966,216 @@ }, { "parentPluginId": "data", - "id": "def-common.AggConfigs.getRequestAggById", + "id": "def-common.AggConfigs.getTimeShifts", "type": "Function", "tags": [], - "label": "getRequestAggById", + "label": "getTimeShifts", "description": [], "signature": [ - "(id: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - " | undefined" + "() => Record" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 292 + "lineNumber": 329 }, "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.AggConfigs.getRequestAggById.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 292 - }, - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.AggConfigs.getResponseAggs", + "id": "def-common.AggConfigs.getTimeShiftInterval", "type": "Function", - "tags": [ - "return" - ], - "label": "getResponseAggs", - "description": [ - "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" - ], + "tags": [], + "label": "getTimeShiftInterval", + "description": [], + "signature": [ + "() => moment.Duration | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 344 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.hasTimeShifts", + "type": "Function", + "tags": [], + "label": "hasTimeShifts", + "description": [], + "signature": [ + "() => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 351 + }, + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.getSearchSourceTimeFilter", + "type": "Function", + "tags": [], + "label": "getSearchSourceTimeFilter", + "description": [], + "signature": [ + "(forceNow?: Date | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + "[] | { meta: { index: string | undefined; params: {}; alias: string; disabled: boolean; negate: boolean; }; query: { bool: { should: { bool: { filter: { range: { [x: string]: { gte: string; lte: string; }; }; }[]; }; }[]; minimum_should_match: number; }; }; }[]" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 355 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.getSearchSourceTimeFilter.$1", + "type": "Object", + "tags": [], + "label": "forceNow", + "description": [], + "signature": [ + "Date | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 355 + }, + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.postFlightTransform", + "type": "Function", + "tags": [], + "label": "postFlightTransform", + "description": [], + "signature": [ + "(response: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + "" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 408 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.postFlightTransform.$1", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + "" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 408 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.getRequestAggById", + "type": "Function", + "tags": [], + "label": "getRequestAggById", + "description": [], + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 427 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.getRequestAggById.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 427 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.getResponseAggs", + "type": "Function", + "tags": [ + "return" + ], + "label": "getResponseAggs", + "description": [ + "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" + ], "signature": [ "() => ", { @@ -6317,7 +5189,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 307 + "lineNumber": 442 }, "deprecated": false, "children": [], @@ -6347,7 +5219,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 456 }, "deprecated": false, "children": [ @@ -6365,7 +5237,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 456 }, "deprecated": false, "isRequired": true @@ -6401,7 +5273,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 + "lineNumber": 465 }, "deprecated": false, "children": [ @@ -6425,7 +5297,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 + "lineNumber": 465 }, "deprecated": false, "isRequired": true @@ -6449,7 +5321,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 + "lineNumber": 465 }, "deprecated": false, "isRequired": false @@ -6507,44 +5379,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -6831,7 +5666,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\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -6857,30 +5692,7 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 112 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -6994,28 +5806,7 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 165 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -7035,37 +5826,16 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 176 }, - "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", - "id": "def-common.AggType.decorateAggConfig", - "type": "Function", - "tags": [], - "label": "decorateAggConfig", - "description": [ - "\nA function that will be called each time an aggConfig of this type\nis created, giving the agg type a chance to modify the agg config" + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggType.decorateAggConfig", + "type": "Function", + "tags": [], + "label": "decorateAggConfig", + "description": [ + "\nA function that will be called each time an aggConfig of this type\nis created, giving the agg type a chance to modify the agg config" ], "signature": [ "() => any" @@ -7074,9 +5844,7 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 181 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -7090,356 +5858,13 @@ "\nA function that needs to be called after the main request has been made\nand should return an updated response" ], "signature": [ - "(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", - ">" + "PostFlightRequestFn" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 194 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -7467,28 +5892,7 @@ "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 204 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -7500,46 +5904,11 @@ "signature": [ "(agg: TAggConfig, bucket: any) => any" ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 206 - }, - "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 - } - ] + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 206 + }, + "deprecated": false }, { "parentPluginId": "data", @@ -7629,6 +5998,73 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-common.AggType.splitForTimeShift", + "type": "Function", + "tags": [], + "label": "splitForTimeShift", + "description": [], + "signature": [ + "(agg: TAggConfig, aggs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ") => boolean" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 218 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggType.splitForTimeShift.$1", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 218 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggType.splitForTimeShift.$2", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [], + "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": 218 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-common.AggType.Unnamed", @@ -7646,7 +6082,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 227 + "lineNumber": 231 }, "deprecated": false, "children": [ @@ -7679,7 +6115,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 227 + "lineNumber": 231 }, "deprecated": false, "isRequired": true @@ -7888,81 +6324,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 21 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -7978,42 +6340,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 27 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -8029,42 +6356,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 28 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -8129,98 +6421,32 @@ "tags": [], "label": "modifyAggConfigOnSearchRequestStart", "description": [ - "\n A function that will be called before an aggConfig is serialized and sent to ES.\n Allows aggConfig to retrieve values needed for serialization\n Example usage: an aggregation needs to know the min/max of a field to determine an appropriate interval\n" - ], - "signature": [ - "(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\"> | undefined, options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => void" - ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/base.ts", - "lineNumber": 45 - }, - "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 + "\n A function that will be called before an aggConfig is serialized and sent to ES.\n Allows aggConfig to retrieve values needed for serialization\n Example usage: an aggregation needs to know the min/max of a field to determine an appropriate interval\n" + ], + "signature": [ + "(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\"> | undefined, options?: ", { - "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 - } - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => void" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 45 + }, + "deprecated": false }, { "parentPluginId": "data", @@ -8296,7 +6522,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 31 + "lineNumber": 40 }, "deprecated": false, "children": [ @@ -8312,46 +6538,112 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 35 + "lineNumber": 44 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 45 + }, + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.getShiftedKey", + "type": "Function", + "tags": [], + "label": "getShiftedKey", + "description": [], + "signature": [ + "(agg: TBucketAggConfig, key: React.ReactText, timeShift: moment.Duration) => React.ReactText" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 47 }, "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.bucket", - "type": "Any", + "id": "def-common.BucketAggType.getShiftedKey.$1", + "type": "Uncategorized", "tags": [], - "label": "bucket", + "label": "agg", "description": [], "signature": [ - "any" + "TBucketAggConfig" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 35 + "lineNumber": 48 }, - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.key", - "type": "Any", + "id": "def-common.BucketAggType.getShiftedKey.$2", + "type": "CompoundType", "tags": [], "label": "key", "description": [], "signature": [ - "any" + "React.ReactText" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 35 + "lineNumber": 49 }, - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.agg", + "id": "def-common.BucketAggType.getShiftedKey.$3", + "type": "Object", + "tags": [], + "label": "timeShift", + "description": [], + "signature": [ + "moment.Duration" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 50 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.getTimeShiftInterval", + "type": "Function", + "tags": [], + "label": "getTimeShiftInterval", + "description": [], + "signature": [ + "(agg: TBucketAggConfig) => moment.Duration | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 55 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.getTimeShiftInterval.$1", "type": "Uncategorized", "tags": [], "label": "agg", @@ -8361,24 +6653,111 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 35 + "lineNumber": 55 }, - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.BucketAggType.type", - "type": "string", + "id": "def-common.BucketAggType.orderBuckets", + "type": "Function", "tags": [], - "label": "type", + "label": "orderBuckets", "description": [], + "signature": [ + "(agg: TBucketAggConfig, a: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.GenericBucket", + "text": "GenericBucket" + }, + ", b: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.GenericBucket", + "text": "GenericBucket" + }, + ") => number" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 36 + "lineNumber": 59 }, - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.orderBuckets.$1", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TBucketAggConfig" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 59 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.orderBuckets.$2", + "type": "CompoundType", + "tags": [], + "label": "a", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.GenericBucket", + "text": "GenericBucket" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 59 + }, + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.BucketAggType.orderBuckets.$3", + "type": "CompoundType", + "tags": [], + "label": "b", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.GenericBucket", + "text": "GenericBucket" + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 59 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -8392,7 +6771,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 38 + "lineNumber": 63 }, "deprecated": false, "children": [ @@ -8408,7 +6787,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 38 + "lineNumber": 63 }, "deprecated": false, "isRequired": true @@ -8583,19 +6962,10 @@ { "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" - }, - "[]" + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldTypes", + "text": "FieldTypes" + } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -9091,7 +7461,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 37 + "lineNumber": 38 }, "deprecated": false, "children": [ @@ -9104,7 +7474,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 41 + "lineNumber": 42 }, "deprecated": false }, @@ -9120,11 +7490,9 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 42 + "lineNumber": 43 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -9135,7 +7503,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 43 + "lineNumber": 44 }, "deprecated": false }, @@ -9151,7 +7519,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 45 + "lineNumber": 46 }, "deprecated": false, "children": [], @@ -9169,7 +7537,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 47 + "lineNumber": 48 }, "deprecated": false, "children": [ @@ -9185,7 +7553,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 47 + "lineNumber": 48 }, "deprecated": false, "isRequired": true @@ -9431,7 +7799,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 121 + "lineNumber": 127 }, "deprecated": false, "children": [ @@ -9447,7 +7815,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 129 + "lineNumber": 135 }, "deprecated": false }, @@ -9463,7 +7831,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 139 }, "deprecated": false, "children": [ @@ -9485,7 +7853,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 139 }, "deprecated": false, "isRequired": true @@ -9508,7 +7876,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 139 }, "deprecated": false, "isRequired": true @@ -9530,7 +7898,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 151 + "lineNumber": 157 }, "deprecated": false, "children": [ @@ -9546,7 +7914,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 151 + "lineNumber": 157 }, "deprecated": false, "isRequired": true @@ -9564,7 +7932,7 @@ "\nsets value to a single search source field" ], "signature": [ - "(field: K, value: ", + "(field: K, value: ", { "pluginId": "data", "scope": "common", @@ -9576,7 +7944,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 + "lineNumber": 166 }, "deprecated": false, "children": [ @@ -9594,7 +7962,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 + "lineNumber": 166 }, "deprecated": false, "isRequired": true @@ -9620,7 +7988,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 + "lineNumber": 166 }, "deprecated": false, "isRequired": true @@ -9638,11 +8006,11 @@ "\nremove field" ], "signature": [ - "(field: K) => this" + "(field: K) => this" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 172 + "lineNumber": 178 }, "deprecated": false, "children": [ @@ -9660,7 +8028,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 172 + "lineNumber": 178 }, "deprecated": false, "isRequired": true @@ -9692,7 +8060,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 183 + "lineNumber": 189 }, "deprecated": false, "children": [ @@ -9716,7 +8084,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 183 + "lineNumber": 189 }, "deprecated": false, "isRequired": true @@ -9738,7 +8106,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 191 + "lineNumber": 197 }, "deprecated": false, "children": [], @@ -9765,7 +8133,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 + "lineNumber": 204 }, "deprecated": false, "children": [], @@ -9781,7 +8149,7 @@ "\nGets a single field from the fields" ], "signature": [ - "(field: K, recurse?: boolean) => ", + "(field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", @@ -9793,7 +8161,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 211 }, "deprecated": false, "children": [ @@ -9809,7 +8177,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 211 }, "deprecated": false, "isRequired": true @@ -9826,7 +8194,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 211 }, "deprecated": false, "isRequired": true @@ -9844,7 +8212,7 @@ "\nGet the field from our own fields, don't traverse up the chain" ], "signature": [ - "(field: K) => ", + "(field: K) => ", { "pluginId": "data", "scope": "common", @@ -9856,7 +8224,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 216 + "lineNumber": 222 }, "deprecated": false, "children": [ @@ -9872,7 +8240,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 216 + "lineNumber": 222 }, "deprecated": false, "isRequired": true @@ -9901,7 +8269,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 223 + "lineNumber": 229 }, "deprecated": true, "references": [ @@ -9909,14 +8277,14 @@ "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 206 + "lineNumber": 207 } }, { "plugin": "discover", "link": { "path": "src/plugins/discover/public/application/embeddable/search_embeddable.ts", - "lineNumber": 212 + "lineNumber": 213 } } ], @@ -9944,7 +8312,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 230 + "lineNumber": 236 }, "deprecated": false, "children": [], @@ -9971,7 +8339,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 244 + "lineNumber": 250 }, "deprecated": false, "children": [ @@ -9987,7 +8355,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 244 + "lineNumber": 250 }, "deprecated": false, "isRequired": true @@ -10027,7 +8395,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 262 }, "deprecated": false, "children": [ @@ -10053,7 +8421,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 262 }, "deprecated": false, "isRequired": false @@ -10078,7 +8446,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 262 }, "deprecated": false, "isRequired": true @@ -10112,7 +8480,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 266 + "lineNumber": 272 }, "deprecated": false, "children": [], @@ -10152,7 +8520,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 274 + "lineNumber": 280 }, "deprecated": false, "children": [ @@ -10174,7 +8542,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 275 + "lineNumber": 281 }, "deprecated": false, "isRequired": true @@ -10208,7 +8576,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 312 + "lineNumber": 318 }, "deprecated": true, "references": [ @@ -10219,13 +8587,6 @@ "lineNumber": 77 } }, - { - "plugin": "discover", - "link": { - "path": "src/plugins/discover/public/application/angular/context/api/anchor.ts", - "lineNumber": 57 - } - }, { "plugin": "maps", "link": { @@ -10267,7 +8628,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 312 + "lineNumber": 318 }, "deprecated": false, "isRequired": true @@ -10307,7 +8668,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 325 + "lineNumber": 331 }, "deprecated": false, "children": [ @@ -10339,7 +8700,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 326 + "lineNumber": 332 }, "deprecated": false, "isRequired": true @@ -10361,7 +8722,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 334 + "lineNumber": 340 }, "deprecated": false, "children": [], @@ -10383,7 +8744,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 342 + "lineNumber": 348 }, "deprecated": false, "children": [], @@ -10410,7 +8771,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 831 + "lineNumber": 848 }, "deprecated": false, "children": [ @@ -10426,7 +8787,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 831 + "lineNumber": 848 }, "deprecated": false, "isRequired": true @@ -10450,7 +8811,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 860 + "lineNumber": 877 }, "deprecated": false, "children": [], @@ -10537,8 +8898,7 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" - }, - "; }" + } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", @@ -11658,9 +10018,7 @@ "type": "Object", "tags": [], "label": "indexPatterns", - "description": [ - "The index patterns contract of the data plugin" - ], + "description": [], "signature": [ "Pick<", { @@ -12566,26 +10924,7 @@ "path": "src/plugins/data/common/search/expressions/esdsl.ts", "lineNumber": 45 }, - "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 - } - ] + "deprecated": false } ] } @@ -12652,23 +10991,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 27 }, - "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 - } - ] + "deprecated": false } ] } @@ -13677,45 +12000,19 @@ "label": "getConfig", "description": [], "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 35 }, - "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 - } - ] + "deprecated": false } ] } @@ -13926,7 +12223,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 63 + "lineNumber": 64 }, "deprecated": false, "children": [], @@ -13982,7 +12279,7 @@ ], "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", - "lineNumber": 43 + "lineNumber": 35 }, "deprecated": false, "children": [ @@ -13998,7 +12295,7 @@ ], "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", - "lineNumber": 43 + "lineNumber": 35 }, "deprecated": false, "isRequired": true @@ -14251,7 +12548,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 49 + "lineNumber": 90 }, "deprecated": false, "children": [ @@ -14267,7 +12564,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 49 + "lineNumber": 90 }, "deprecated": false, "isRequired": true @@ -14433,7 +12730,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 75 + "lineNumber": 92 }, "deprecated": false, "children": [ @@ -14449,7 +12746,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 75 + "lineNumber": 92 }, "deprecated": false, "isRequired": true @@ -14481,31 +12778,6 @@ "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 }, { @@ -14585,31 +12857,6 @@ "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 }, { @@ -14635,31 +12882,6 @@ "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 }, { @@ -14926,6 +13148,45 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.parseTimeShift", + "type": "Function", + "tags": [], + "label": "parseTimeShift", + "description": [ + "\nThis method parses a string into a time shift duration.\nIf parsing fails, 'invalid' is returned.\nAllowed values are the string 'previous' and an integer followed by the units s,m,h,d,w,M,y" + ], + "signature": [ + "(val: string) => moment.Duration | \"previous\" | \"invalid\"" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts", + "lineNumber": 18 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.parseTimeShift.$1", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "signature": [ + "string" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts", + "lineNumber": 18 + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.pollSearch", @@ -15561,7 +13822,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 44 + "lineNumber": 53 }, "deprecated": false, "children": [ @@ -15577,7 +13838,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 45 + "lineNumber": 54 }, "deprecated": false }, @@ -15593,7 +13854,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 46 + "lineNumber": 55 }, "deprecated": false } @@ -15611,7 +13872,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 195 + "lineNumber": 196 }, "deprecated": false, "children": [ @@ -15623,101 +13884,27 @@ "label": "aggFilter", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilter\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & 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\">, ", - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 196 + "lineNumber": 197 }, "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.AggFunctionsMapping.aggFilters", - "type": "Object", - "tags": [], - "label": "aggFilters", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilters\", any, Pick, \"enabled\" | \"id\" | \"schema\" | \"json\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"schema\" | \"json\">, ", - "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", - ">>" + "id": "def-common.AggFunctionsMapping.aggFilters", + "type": "Object", + "tags": [], + "label": "aggFilters", + "description": [], + "signature": [ + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 197 + "lineNumber": 198 }, "deprecated": false }, @@ -15729,48 +13916,11 @@ "label": "aggSignificantTerms", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 198 + "lineNumber": 199 }, "deprecated": false }, @@ -15782,48 +13932,11 @@ "label": "aggIpRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggIpRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 199 + "lineNumber": 200 }, "deprecated": false }, @@ -15835,48 +13948,11 @@ "label": "aggDateRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDateRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 200 + "lineNumber": 201 }, "deprecated": false }, @@ -15888,48 +13964,11 @@ "label": "aggRange", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggRange\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 201 + "lineNumber": 202 }, "deprecated": false }, @@ -15941,48 +13980,11 @@ "label": "aggGeoTile", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 202 + "lineNumber": 203 }, "deprecated": false }, @@ -15994,48 +13996,11 @@ "label": "aggGeoHash", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggGeoHash\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 203 + "lineNumber": 204 }, "deprecated": false }, @@ -16047,48 +14012,11 @@ "label": "aggHistogram", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 204 + "lineNumber": 205 }, "deprecated": false }, @@ -16098,50 +14026,13 @@ "type": "Object", "tags": [], "label": "aggDateHistogram", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDateHistogram\", any, Pick, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "description": [], + "signature": [ + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 205 + "lineNumber": 206 }, "deprecated": false }, @@ -16153,52 +14044,11 @@ "label": "aggTerms", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggTerms\", any, Pick, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"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\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 206 + "lineNumber": 207 }, "deprecated": false }, @@ -16210,48 +14060,11 @@ "label": "aggAvg", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 207 + "lineNumber": 208 }, "deprecated": false }, @@ -16263,56 +14076,11 @@ "label": "aggBucketAvg", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 + "lineNumber": 209 }, "deprecated": false }, @@ -16324,56 +14092,11 @@ "label": "aggBucketMax", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketMax\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 209 + "lineNumber": 210 }, "deprecated": false }, @@ -16385,56 +14108,11 @@ "label": "aggBucketMin", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketMin\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 210 + "lineNumber": 211 }, "deprecated": false }, @@ -16446,56 +14124,11 @@ "label": "aggBucketSum", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggBucketSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 211 + "lineNumber": 212 }, "deprecated": false }, @@ -16507,109 +14140,27 @@ "label": "aggFilteredMetric", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilteredMetric\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", - "AggExpressionType", - " | undefined; customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 212 + "lineNumber": 213 }, "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.AggFunctionsMapping.aggCardinality", - "type": "Object", - "tags": [], - "label": "aggCardinality", - "description": [], - "signature": [ - { - "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", - ">>" + "id": "def-common.AggFunctionsMapping.aggCardinality", + "type": "Object", + "tags": [], + "label": "aggCardinality", + "description": [], + "signature": [ + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 + "lineNumber": 214 }, "deprecated": false }, @@ -16621,48 +14172,11 @@ "label": "aggCount", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 214 + "lineNumber": 215 }, "deprecated": false }, @@ -16674,52 +14188,11 @@ "label": "aggCumulativeSum", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggCumulativeSum\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 215 + "lineNumber": 216 }, "deprecated": false }, @@ -16731,52 +14204,11 @@ "label": "aggDerivative", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggDerivative\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 216 + "lineNumber": 217 }, "deprecated": false }, @@ -16788,48 +14220,11 @@ "label": "aggGeoBounds", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 217 + "lineNumber": 218 }, "deprecated": false }, @@ -16841,48 +14236,11 @@ "label": "aggGeoCentroid", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 218 + "lineNumber": 219 }, "deprecated": false }, @@ -16894,48 +14252,11 @@ "label": "aggMax", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 219 + "lineNumber": 220 }, "deprecated": false }, @@ -16947,48 +14268,11 @@ "label": "aggMedian", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 220 + "lineNumber": 221 }, "deprecated": false }, @@ -17000,48 +14284,11 @@ "label": "aggSinglePercentile", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 221 + "lineNumber": 222 }, "deprecated": false }, @@ -17053,48 +14300,11 @@ "label": "aggMin", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 222 + "lineNumber": 223 }, "deprecated": false }, @@ -17106,52 +14316,11 @@ "label": "aggMovingAvg", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggMovingAvg\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 223 + "lineNumber": 224 }, "deprecated": false }, @@ -17163,48 +14332,11 @@ "label": "aggPercentileRanks", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 224 + "lineNumber": 225 }, "deprecated": false }, @@ -17216,48 +14348,11 @@ "label": "aggPercentiles", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 225 + "lineNumber": 226 }, "deprecated": false }, @@ -17269,52 +14364,11 @@ "label": "aggSerialDiff", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggSerialDiff\", any, Pick, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", - "AggExpressionType", - " | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 226 + "lineNumber": 227 }, "deprecated": false }, @@ -17326,48 +14380,11 @@ "label": "aggStdDeviation", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 227 + "lineNumber": 228 }, "deprecated": false }, @@ -17379,48 +14396,11 @@ "label": "aggSum", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 228 + "lineNumber": 229 }, "deprecated": false }, @@ -17432,48 +14412,11 @@ "label": "aggTopHit", "description": [], "signature": [ - { - "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", - ">>" + "FunctionDefinition" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 229 + "lineNumber": 230 }, "deprecated": false } @@ -18498,7 +15441,7 @@ }, " extends Pick<", "BaseAggParams", - ", \"json\">" + ", \"json\" | \"timeShift\">" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", @@ -18850,7 +15793,7 @@ "label": "interval", "description": [], "signature": [ - "string | number" + "React.ReactText" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", @@ -19768,7 +16711,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 48 + "lineNumber": 49 }, "deprecated": false, "children": [ @@ -19781,7 +16724,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 49 + "lineNumber": 50 }, "deprecated": false }, @@ -19794,7 +16737,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 50 + "lineNumber": 51 }, "deprecated": false }, @@ -19812,7 +16755,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 51 + "lineNumber": 52 }, "deprecated": false }, @@ -19828,7 +16771,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 52 + "lineNumber": 53 }, "deprecated": false }, @@ -19844,7 +16787,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 53 + "lineNumber": 54 }, "deprecated": false }, @@ -19860,7 +16803,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 54 + "lineNumber": 55 }, "deprecated": false }, @@ -19876,7 +16819,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 55 + "lineNumber": 56 }, "deprecated": false }, @@ -19892,7 +16835,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 56 + "lineNumber": 57 }, "deprecated": false }, @@ -19908,7 +16851,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 57 + "lineNumber": 58 }, "deprecated": false }, @@ -19924,7 +16867,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 59 + "lineNumber": 60 }, "deprecated": false }, @@ -19940,7 +16883,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 60 + "lineNumber": 61 }, "deprecated": false } @@ -20249,7 +17192,7 @@ "label": "valueType", "description": [], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -20497,7 +17440,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 18 + "lineNumber": 19 }, "deprecated": false, "children": [ @@ -20513,7 +17456,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 20 + "lineNumber": 21 }, "deprecated": false }, @@ -20544,7 +17487,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 21 + "lineNumber": 22 }, "deprecated": false } @@ -20617,47 +17560,13 @@ "label": "calculateBounds", "description": [], "signature": [ - "(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" - } + "CalculateBoundsFn" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 48 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -20673,9 +17582,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 49 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -20691,23 +17598,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 50 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -20739,9 +17630,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 27 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "data", @@ -20757,23 +17646,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 28 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -20799,7 +17672,7 @@ "label": "from", "description": [], "signature": [ - "string | number" + "React.ReactText" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", @@ -20815,7 +17688,7 @@ "label": "to", "description": [], "signature": [ - "string | number" + "React.ReactText" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", @@ -20965,45 +17838,19 @@ "label": "getConfig", "description": [], "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 22 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21037,49 +17884,7 @@ "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 27 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -21111,23 +17916,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 33 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -21159,23 +17948,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 31 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21199,9 +17972,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 32 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -21283,7 +18054,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 14 + "lineNumber": 15 }, "deprecated": false, "children": [ @@ -21314,7 +18085,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", - "lineNumber": 15 + "lineNumber": 16 }, "deprecated": false } @@ -21422,32 +18193,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 36 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -21470,9 +18216,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 37 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -21839,7 +18583,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 16 + "lineNumber": 17 }, "deprecated": false, "children": [ @@ -21870,7 +18614,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 17 + "lineNumber": 18 }, "deprecated": false } @@ -21898,97 +18642,19 @@ "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.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => ", - "Observable", - "" + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22000,60 +18666,19 @@ "\nUsed to cancel an in-progress search request." ], "signature": [ - "(id: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => Promise" + "section": "def-common.ISearchCancelGeneric", + "text": "ISearchCancelGeneric" + } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 33 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22065,73 +18690,19 @@ "\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.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => Promise" + "section": "def-common.ISearchExtendGeneric", + "text": "ISearchExtendGeneric" + } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 37 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -22357,33 +18928,7 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 31 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22409,9 +18954,7 @@ "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 35 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -22454,39 +18997,7 @@ "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 28 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "data", @@ -22502,9 +19013,7 @@ "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 29 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -22536,7 +19045,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 20 + "lineNumber": 21 }, "deprecated": false, "children": [ @@ -22567,7 +19076,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 22 + "lineNumber": 23 }, "deprecated": false }, @@ -22583,7 +19092,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 23 + "lineNumber": 24 }, "deprecated": false } @@ -22734,32 +19243,7 @@ "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -22799,9 +19283,7 @@ "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 30 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -22841,9 +19323,7 @@ "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 26 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -23540,7 +20020,7 @@ "\nMapping of search request hashes to their corresponsing info (async search id, etc.)" ], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/data/common/search/session/types.ts", @@ -23650,7 +20130,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 116 + "lineNumber": 122 }, "deprecated": false, "children": [ @@ -23662,97 +20142,19 @@ "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.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => ", - "Observable", - "" + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 117 + "lineNumber": 123 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -23911,16 +20313,7 @@ "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", @@ -24772,21 +21165,11 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ 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; }" + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 43 + "lineNumber": 45 }, "deprecated": false, "initialIsOpen": false @@ -25003,7 +21386,7 @@ "label": "AggGroupName", "description": [], "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" + "\"none\" | \"buckets\" | \"metrics\"" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -25122,22 +21505,7 @@ "label": "AggParam", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ">" + "BaseParamType" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", @@ -25262,59 +21630,11 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "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 string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", { @@ -25332,17 +21652,7 @@ "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>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", @@ -25427,27 +21737,7 @@ "label": "AggTypesRegistrySetup", "description": [], "signature": [ - "{ 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; }" + "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", @@ -25481,7 +21771,7 @@ "label": "boundsDescendingRaw", "description": [], "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" + "({ bound: number; interval: moment.Duration; boundLabel: any; intervalLabel: any; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: any; intervalLabel: any; })[]" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", @@ -25498,21 +21788,13 @@ "label": "CreateAggConfigParams", "description": [], "signature": [ - "{ type: string | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - }, - "; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", "SerializableState", " | undefined; }" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 49 + "lineNumber": 58 }, "deprecated": false, "initialIsOpen": false @@ -25559,8 +21841,7 @@ "label": "EqlRequestParams", "description": [], "signature": [ - "EqlSearch", - ">" + "EqlSearch>" ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", @@ -25577,16 +21858,7 @@ "label": "EqlSearchStrategyResponse", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "<", - "ApiResponse", - ">" + "IKibanaSearchResponse>" ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", @@ -25620,14 +21892,7 @@ "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"esaggs\", Input, Arguments, Output, ", + "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -25662,14 +21927,23 @@ "label": "EsdslExpressionFunctionDefinition", "description": [], "signature": [ + "ExpressionFunctionDefinition<\"esdsl\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" }, - "<\"esdsl\", Input, Arguments, Output, ", + "> | null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -25686,8 +21960,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/esdsl.ts", @@ -25704,7 +21977,11 @@ "label": "EsQuerySearchAfter", "description": [], "signature": [ - "[React.ReactText, React.ReactText]" + "[", + "ReactText", + ", ", + "ReactText", + "]" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -25721,31 +21998,7 @@ "label": "EsQuerySortValue", "description": [], "signature": [ - "{ [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" - }, - "; }" + "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", @@ -25762,30 +22015,7 @@ "label": "EsRawResponseExpressionTypeDefinition", "description": [], "signature": [ - { - "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" - }, - ">" + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", @@ -25802,39 +22032,7 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ 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; }" + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -25847,18 +22045,11 @@ "parentPluginId": "data", "id": "def-common.ExpressionFunctionExistsFilter", "type": "Type", - "tags": [], - "label": "ExpressionFunctionExistsFilter", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"existsFilter\", null, Arguments, ", + "tags": [], + "label": "ExpressionFunctionExistsFilter", + "description": [], + "signature": [ + "ExpressionFunctionDefinition<\"existsFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -25891,8 +22082,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", @@ -25909,14 +22099,7 @@ "label": "ExpressionFunctionField", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"field\", null, Arguments, ", + "ExpressionFunctionDefinition<\"field\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -25927,9 +22110,9 @@ "<\"kibana_field\", ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IndexPatternField", "text": "IndexPatternField" }, ">, ", @@ -25949,8 +22132,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", @@ -25967,14 +22149,7 @@ "label": "ExpressionFunctionKibana", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana\", Input, object, ", + "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", @@ -25982,39 +22157,15 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - ">, ", + "<\"kibana_context\", ExecutionContextSearch> | null, object, ", { "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" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ">>" + "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -26031,14 +22182,7 @@ "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana_context\", Input, Arguments, Promise<", + "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", @@ -26046,39 +22190,15 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - ">>, ", + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", { "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" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ">>" + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", @@ -26095,14 +22215,7 @@ "label": "ExpressionFunctionKibanaFilter", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibanaFilter\", null, Arguments, ", + "ExpressionFunctionDefinition<\"kibanaFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -26113,9 +22226,9 @@ "<\"kibana_filter\", ", { "pluginId": "data", - "scope": "common", + "scope": "public", "docId": "kibDataPluginApi", - "section": "def-common.Filter", + "section": "def-public.Filter", "text": "Filter" }, ">, ", @@ -26135,8 +22248,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", @@ -26153,38 +22265,7 @@ "label": "ExpressionFunctionKibanaTimerange", "description": [], "signature": [ - { - "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" - }, - ">, ", + "ExpressionFunctionDefinition<\"timerange\", null, TimeRange, ExpressionValueBoxed<\"timerange\", TimeRange>, ", { "pluginId": "expressions", "scope": "common", @@ -26219,14 +22300,7 @@ "label": "ExpressionFunctionKql", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kql\", null, Arguments, ", + "ExpressionFunctionDefinition<\"kql\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -26238,7 +22312,7 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "section": "def-common.Query", "text": "Query" }, @@ -26259,8 +22333,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", @@ -26277,14 +22350,7 @@ "label": "ExpressionFunctionLucene", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"lucene\", null, Arguments, ", + "ExpressionFunctionDefinition<\"lucene\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -26296,7 +22362,7 @@ { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", + "docId": "kibDataPluginApi", "section": "def-common.Query", "text": "Query" }, @@ -26317,8 +22383,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", @@ -26335,14 +22400,7 @@ "label": "ExpressionFunctionPhraseFilter", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"rangeFilter\", null, Arguments, ", + "ExpressionFunctionDefinition<\"rangeFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -26375,8 +22433,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", @@ -26393,22 +22450,7 @@ "label": "ExpressionFunctionRange", "description": [], "signature": [ - { - "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>, ", + "ExpressionFunctionDefinition<\"range\", null, Arguments, ExpressionValueBoxed<\"kibana_range\", Arguments>, ", { "pluginId": "expressions", "scope": "common", @@ -26443,14 +22485,7 @@ "label": "ExpressionFunctionRangeFilter", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"rangeFilter\", null, Arguments, ", + "ExpressionFunctionDefinition<\"rangeFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -26483,8 +22518,7 @@ "text": "Adapters" }, ", ", - "SerializableState", - ">>" + "SerializableState" ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", @@ -26501,14 +22535,7 @@ "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -26532,7 +22559,7 @@ "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, - " | \"*\" | ", + "._SOURCE | ", { "pluginId": "data", "scope": "common", @@ -26540,7 +22567,30 @@ "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", + "docId": "kibDataPluginApi", + "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", @@ -26549,6 +22599,31 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.GenericBucket", + "type": "Type", + "tags": [], + "label": "GenericBucket", + "description": [], + "signature": [ + "CompositeBucketKeys", + " & { [property: string]: ", + "Aggregate", + "; } | { [property: string]: ", + "Aggregate", + "; } & { [property: string]: ", + "Aggregate", + "; } | ", + "DateHistogramBucketKeys" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 60 + }, + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.IAggConfig", @@ -26560,17 +22635,11 @@ "label": "IAggConfig", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } + "AggConfig" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 53 + "lineNumber": 55 }, "deprecated": false, "initialIsOpen": false @@ -26578,43 +22647,12 @@ { "parentPluginId": "data", "id": "def-common.IAggType", - "type": "Type", - "tags": [], - "label": "IAggType", - "description": [], - "signature": [ - { - "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" - }, - ">>" + "type": "Type", + "tags": [], + "label": "IAggType", + "description": [], + "signature": [ + "AggType>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", @@ -26631,16 +22669,7 @@ "label": "IEsSearchResponse", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "<", - "SearchResponse", - ">" + "IKibanaSearchResponse>" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -26657,13 +22686,7 @@ "label": "IFieldParamType", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldParamType", - "text": "FieldParamType" - } + "FieldParamType" ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", @@ -26680,26 +22703,11 @@ "label": "IMetricAggType", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" - }, - ">" + "MetricAggType" ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "lineNumber": 35 + "lineNumber": 36 }, "deprecated": false, "initialIsOpen": false @@ -26712,7 +22720,7 @@ "label": "intervalOptions", "description": [], "signature": [ - "({ display: string; val: string; enabled(agg: ", + "({ display: any; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", @@ -26720,7 +22728,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean; } | { display: string; val: string; })[]" + "): boolean; } | { display: any; val: string; })[]" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", @@ -26802,7 +22810,7 @@ "label": "ISearchCancelGeneric", "description": [], "signature": [ - "(id: string, options?: ", + "(id: string, options: ", { "pluginId": "data", "scope": "common", @@ -26827,7 +22835,7 @@ "label": "ISearchExtendGeneric", "description": [], "signature": [ - "(id: string, keepAlive: string, options?: ", + "(id: string, keepAlive: string, options: ", { "pluginId": "data", "scope": "common", @@ -26852,39 +22860,7 @@ "label": "ISearchGeneric", "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?: ", + "(request: SearchStrategyRequest, options: ", { "pluginId": "data", "scope": "common", @@ -26930,8 +22906,7 @@ "label": "ISearchRequestParams", "description": [], "signature": [ - "{ trackTotalHits?: boolean | undefined; } & ", - "SearchRequest" + "{ trackTotalHits?: boolean | undefined; } & estypes.SearchRequest" ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", @@ -26950,132 +22925,12 @@ "\nsearch source interface" ], "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?: ", + "{ 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?: ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.ISearchOptions", "text": "ISearchOptions" }, ") => ", @@ -27083,9 +22938,9 @@ "<", { "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", @@ -27093,40 +22948,11 @@ ">>; 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", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.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", @@ -27160,14 +22986,7 @@ "label": "KibanaContext", "description": [], "signature": [ - "{ type: \"kibana_context\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -27184,14 +23003,7 @@ "label": "KibanaField", "description": [], "signature": [ - "{ type: \"kibana_field\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - } + "{ type: \"kibana_field\"; } & IndexPatternField" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -27208,14 +23020,7 @@ "label": "KibanaFilter", "description": [], "signature": [ - "{ type: \"kibana_filter\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } + "{ type: \"kibana_filter\"; } & Filter" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -27232,14 +23037,7 @@ "label": "KibanaQueryOutput", "description": [], "signature": [ - "{ type: \"kibana_query\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - } + "{ type: \"kibana_query\"; } & Query" ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -27273,14 +23071,7 @@ "label": "KibanaTimerangeOutput", "description": [], "signature": [ - "{ type: \"timerange\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "{ type: \"timerange\"; } & TimeRange" ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", @@ -27292,10 +23083,13 @@ { "parentPluginId": "data", "id": "def-common.parentPipelineType", - "type": "string", + "type": "Any", "tags": [], "label": "parentPipelineType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 28 @@ -27311,9 +23105,7 @@ "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", @@ -27376,10 +23168,13 @@ { "parentPluginId": "data", "id": "def-common.siblingPipelineType", - "type": "string", + "type": "Any", "tags": [], "label": "siblingPipelineType", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 35 @@ -27399,7 +23194,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 30 + "lineNumber": 31 }, "deprecated": false, "initialIsOpen": false @@ -27422,10 +23217,13 @@ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Buckets", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21 @@ -27435,10 +23233,13 @@ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Metrics", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24 @@ -27448,10 +23249,13 @@ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.None", - "type": "string", + "type": "Any", "tags": [], "label": "[AggGroupNames.None]", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27 @@ -27469,7 +23273,7 @@ "label": "AggGroupNames", "description": [], "signature": [ - "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", @@ -27640,10 +23444,13 @@ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 31 @@ -27711,10 +23518,13 @@ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 38 @@ -27771,10 +23581,13 @@ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "lineNumber": 45 @@ -27921,10 +23734,13 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 30 @@ -27992,10 +23808,13 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 37 @@ -28052,10 +23871,13 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 44 @@ -28096,10 +23918,13 @@ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.script.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/field.ts", "lineNumber": 50 @@ -28246,10 +24071,13 @@ { "parentPluginId": "data", "id": "def-common.kibana.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 32 @@ -28317,8 +24145,7 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" - }, - ">" + } ], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", @@ -28565,10 +24392,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 29 @@ -28652,10 +24482,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 37 @@ -28712,10 +24545,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "lineNumber": 44 @@ -28846,10 +24682,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 26 @@ -28917,10 +24756,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 33 @@ -28977,10 +24819,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 40 @@ -29037,10 +24882,13 @@ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/timerange.ts", "lineNumber": 47 @@ -29185,10 +25033,13 @@ { "parentPluginId": "data", "id": "def-common.kqlFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 28 @@ -29272,10 +25123,13 @@ { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/kql.ts", "lineNumber": 36 @@ -29406,10 +25260,13 @@ { "parentPluginId": "data", "id": "def-common.luceneFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 28 @@ -29493,10 +25350,13 @@ { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/lucene.ts", "lineNumber": 36 @@ -29571,97 +25431,15 @@ "label": "migrateIncludeExcludeFormat", "description": [], "signature": [ - "{ 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.IBucketAggConfig", - "text": "IBucketAggConfig" - }, - ", state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - "SerializableState", - " | undefined; schema?: string | undefined; } | undefined) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "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: ", + "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketAggConfig", - "text": "IBucketAggConfig" + "section": "def-common.BucketAggParam", + "text": "BucketAggParam" }, - ") => boolean) | undefined; modifyAggConfigOnSearchRequestStart?: ((aggConfig: ", + "<", { "pluginId": "data", "scope": "common", @@ -29669,23 +25447,7 @@ "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", @@ -29710,10 +25472,13 @@ { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.subtype", - "type": "string", + "type": "Any", "tags": [], "label": "subtype", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 36 @@ -29871,10 +25636,13 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 32 @@ -29942,10 +25710,13 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 39 @@ -30018,10 +25789,13 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 47 @@ -30078,10 +25852,13 @@ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "lineNumber": 54 @@ -30228,10 +26005,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 33 @@ -30299,10 +26079,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 40 @@ -30359,10 +26142,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 47 @@ -30419,10 +26205,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range_filter.ts", "lineNumber": 54 @@ -30569,10 +26358,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 32 @@ -30613,7 +26405,7 @@ "label": "types", "description": [], "signature": [ - "(\"string\" | \"number\")[]" + "(\"number\" | \"string\")[]" ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", @@ -30624,10 +26416,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 38 @@ -30657,7 +26452,7 @@ "label": "types", "description": [], "signature": [ - "(\"string\" | \"number\")[]" + "(\"number\" | \"string\")[]" ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", @@ -30668,10 +26463,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 44 @@ -30701,7 +26499,7 @@ "label": "types", "description": [], "signature": [ - "(\"string\" | \"number\")[]" + "(\"number\" | \"string\")[]" ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", @@ -30712,10 +26510,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 50 @@ -30745,7 +26546,7 @@ "label": "types", "description": [], "signature": [ - "(\"string\" | \"number\")[]" + "(\"number\" | \"string\")[]" ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", @@ -30756,10 +26557,13 @@ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/data/common/search/expressions/range.ts", "lineNumber": 56 @@ -30842,10 +26646,13 @@ { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.subtype", - "type": "string", + "type": "Any", "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 5b4f11ee0cd9f..f7a679350fa3b 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -101,7 +101,13 @@ "label": "query", "description": [], "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", @@ -508,11 +514,7 @@ "label": "IndexPatternSelectProps", "description": [], "signature": [ - "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\" | \"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\" | \"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\" | \"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\" | \"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; }" ], "source": { "path": "src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx", @@ -524,28 +526,12 @@ { "parentPluginId": "data", "id": "def-public.SearchBar", - "type": "CompoundType", + "type": "Any", "tags": [], "label": "SearchBar", "description": [], "signature": [ - "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>; }" + "any" ], "source": { "path": "src/plugins/data/public/ui/search_bar/index.tsx", @@ -562,8 +548,7 @@ "label": "SearchBarProps", "description": [], "signature": [ - "SearchBarOwnProps", - " & SearchBarInjectedDeps" + "SearchBarOwnProps & SearchBarInjectedDeps" ], "source": { "path": "src/plugins/data/public/ui/search_bar/search_bar.tsx", @@ -580,8 +565,7 @@ "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 99edad62075bc..d1f7f56bfb9c1 100644 --- a/api_docs/deprecations.mdx +++ b/api_docs/deprecations.mdx @@ -82,14 +82,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L13) | 7.16 | -| | [plugin.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L69) | 7.16 | -| | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/types.ts#L8) | 7.16 | -| | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/types.ts#L41) | 7.16 | | | [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#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L17) | 7.16 | -| | [plugin.ts#L36](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#L36) | 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 | @@ -106,7 +102,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [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) | - | | | [plugin.tsx#L42](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#L42) | - | -| | [plugin.tsx#L126](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#L126) | - | +| | [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) | - | @@ -129,24 +125,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [create_doc_table_react.tsx#L25](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/angular/doc_table/create_doc_table_react.tsx#L25) | - | | | [types.ts#L16](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/types.ts#L16) | - | | | [types.ts#L30](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/types.ts#L30) | - | -| | [context_app_legacy.tsx#L17](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx#L17) | - | -| | [context_app_legacy.tsx#L26](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx#L26) | - | | | [kibana_services.ts#L104](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/kibana_services.ts#L104) | - | | | [search_embeddable.ts#L23](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L23) | - | -| | [search_embeddable.ts#L58](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L58) | - | +| | [search_embeddable.ts#L59](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L59) | - | | | [kibana_services.ts#L104](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/kibana_services.ts#L104) | - | | | [search_embeddable.ts#L23](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L23) | - | -| | [search_embeddable.ts#L58](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L58) | - | +| | [search_embeddable.ts#L59](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L59) | - | | | [kibana_services.ts#L101](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/kibana_services.ts#L101) | - | | | [create_doc_table_react.tsx#L15](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/angular/doc_table/create_doc_table_react.tsx#L15) | - | | | [create_doc_table_react.tsx#L25](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/angular/doc_table/create_doc_table_react.tsx#L25) | - | | | [types.ts#L16](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/types.ts#L16) | - | | | [types.ts#L30](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/types.ts#L30) | - | -| | [context_app_legacy.tsx#L17](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx#L17) | - | -| | [context_app_legacy.tsx#L26](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/context_app/context_app_legacy.tsx#L26) | - | | | [kibana_services.ts#L104](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/kibana_services.ts#L104) | - | | | [search_embeddable.ts#L23](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L23) | - | -| | [search_embeddable.ts#L58](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L58) | - | +| | [search_embeddable.ts#L59](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/embeddable/search_embeddable.ts#L59) | - | | | [on_save_search.tsx#L11](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/top_nav/on_save_search.tsx#L11) | - | | | [on_save_search.tsx#L133](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/components/top_nav/on_save_search.tsx#L133) | - | | | [saved_searches.ts#L10](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/saved_searches/saved_searches.ts#L10) | - | @@ -199,7 +191,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [query_bar.tsx#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#L30) | - | | | [query_bar.tsx#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#L38) | - | | | [plugin.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#L14) | - | -| | [plugin.ts#L189](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#L189) | - | +| | [plugin.ts#L190](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#L190) | - | | | [plugin.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#L2) | - | | | [plugin.d.ts#L84](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#L84) | - | @@ -238,15 +230,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#L14) | 7.16 | -| | [plugin.ts#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#L42) | 7.16 | +| | [plugin.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#L12) | 7.16 | +| | [plugin.ts#L38](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#L38) | 7.16 | | | [types.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L9) | 7.16 | -| | [types.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L40) | 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.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L10) | 7.16 | -| | [types.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L43) | 7.16 | -| | [types.ts#L50](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#L50) | 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 | @@ -364,10 +356,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#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) | - | +| | [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) | - | | | [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) | - | @@ -408,30 +400,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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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) | - | @@ -464,30 +456,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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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) | - | @@ -520,10 +512,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#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) | - | +| | [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) | - | | | [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) | - | @@ -564,33 +556,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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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#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) | - | +| | [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) | - | | | [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#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) | - | -| | [log_entry_categories_analysis.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L9) | 7.16 | -| | [log_entry_categories_analysis.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L139) | 7.16 | -| | [log_entry_categories_analysis.ts#L405](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L405) | 7.16 | +| | [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 | @@ -602,6 +591,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | ---------------|-----------|-----------| | | [embeddable.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx#L14) | - | | | [embeddable.tsx#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx#L85) | - | +| | [index.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L25) | - | +| | [index.tsx#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L102) | - | | | [field_item.tsx#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx#L47) | - | | | [field_item.tsx#L172](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx#L172) | - | | | [datapanel.tsx#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx#L42) | - | @@ -616,10 +607,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/types.ts#L8) | - | | | [types.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/types.ts#L57) | - | | | [field_stats.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L11) | - | -| | [field_stats.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L139) | - | -| | [field_stats.ts#L248](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L248) | - | -| | [field_stats.ts#L287](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L287) | - | -| | [field_stats.ts#L329](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L329) | - | +| | [field_stats.ts#L140](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L140) | - | +| | [field_stats.ts#L249](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L249) | - | +| | [field_stats.ts#L289](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L289) | - | +| | [field_stats.ts#L331](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L331) | - | | | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts#L1) | - | | | [types.d.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts#L22) | - | | | [field_stats.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#L3) | - | @@ -631,10 +622,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/types.ts#L8) | - | | | [types.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/types.ts#L57) | - | | | [field_stats.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L11) | - | -| | [field_stats.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L139) | - | -| | [field_stats.ts#L248](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L248) | - | -| | [field_stats.ts#L287](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L287) | - | -| | [field_stats.ts#L329](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L329) | - | +| | [field_stats.ts#L140](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L140) | - | +| | [field_stats.ts#L249](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L249) | - | +| | [field_stats.ts#L289](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L289) | - | +| | [field_stats.ts#L331](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L331) | - | | | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts#L1) | - | | | [types.d.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts#L22) | - | | | [field_stats.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#L3) | - | @@ -643,6 +634,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [field_stats.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#L9) | - | | | [embeddable.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx#L14) | - | | | [embeddable.tsx#L85](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx#L85) | - | +| | [index.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L25) | - | +| | [index.tsx#L102](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L102) | - | | | [field_item.tsx#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx#L47) | - | | | [field_item.tsx#L172](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx#L172) | - | | | [datapanel.tsx#L42](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx#L42) | - | @@ -657,10 +650,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/types.ts#L8) | - | | | [types.ts#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/types.ts#L57) | - | | | [field_stats.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L11) | - | -| | [field_stats.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L139) | - | -| | [field_stats.ts#L248](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L248) | - | -| | [field_stats.ts#L287](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L287) | - | -| | [field_stats.ts#L329](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L329) | - | +| | [field_stats.ts#L140](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L140) | - | +| | [field_stats.ts#L249](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L249) | - | +| | [field_stats.ts#L289](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L289) | - | +| | [field_stats.ts#L331](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#L331) | - | | | [types.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts#L1) | - | | | [types.d.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts#L22) | - | | | [field_stats.d.ts#L3](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#L3) | - | @@ -935,9 +928,6 @@ 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 | @@ -1393,7 +1383,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [static_globals.ts#L43](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/static_globals.ts#L43) | 7.16 | | | [plugin.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L18) | 7.16 | | | [plugin.ts#L74](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L74) | 7.16 | -| | [plugin.ts#L279](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L279) | 7.16 | +| | [plugin.ts#L284](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/plugin.ts#L284) | 7.16 | | | [types.d.ts#L2](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/types.d.ts#L2) | 7.16 | | | [types.d.ts#L47](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/types.d.ts#L47) | 7.16 | | | [plugin.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/server/plugin.d.ts#L1) | 7.16 | @@ -1482,22 +1472,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| -| | [types.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L18) | - | -| | [types.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L95) | - | +| | [types.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L19) | - | +| | [types.ts#L104](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L104) | - | | | [utils.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L10) | - | | | [utils.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L53) | - | | | [utils.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L61) | - | | | [utils.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L69) | - | | | [default_configs.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#L19) | - | -| | [default_configs.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#L24) | - | -| | [types.ts#L18](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L18) | - | -| | [types.ts#L95](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L95) | - | +| | [default_configs.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#L25) | - | +| | [types.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L19) | - | +| | [types.ts#L104](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts#L104) | - | | | [utils.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L10) | - | | | [utils.ts#L53](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L53) | - | | | [utils.ts#L61](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L61) | - | | | [utils.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#L69) | - | | | [default_configs.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#L19) | - | -| | [default_configs.ts#L24](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#L24) | - | +| | [default_configs.ts#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#L25) | - | @@ -1573,9 +1563,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location | Remove By | | ---------------|-----------|-----------| -| | [types.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L21) | - | -| | [types.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L66) | - | -| | [action.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#L19) | - | +| | [types.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L22) | - | +| | [types.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L72) | - | +| | [action.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#L20) | - | | | [action.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#L100) | - | | | [index.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#L8) | - | | | [index.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#L86) | - | @@ -1612,9 +1602,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/details/types.ts#L41) | - | | | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L12) | - | | | [index.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L34) | - | -| | [middleware.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L44) | - | -| | [middleware.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L60) | - | -| | [middleware.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L65) | - | +| | [middleware.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L48) | - | +| | [middleware.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L64) | - | +| | [middleware.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L69) | - | | | [types.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L12) | - | | | [types.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L28) | - | | | [index.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx#L15) | - | @@ -1627,25 +1617,6 @@ 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) | - | @@ -1669,6 +1640,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [use_field_value_autocomplete.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.ts#L31) | - | | | [field_value_match.tsx#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match.tsx#L19) | - | | | [field_value_match.tsx#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match.tsx#L30) | - | +| | [query.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts#L13) | - | +| | [query.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts#L52) | - | | | [model.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts#L8) | - | | | [model.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts#L30) | - | | | [index.tsx#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L33) | - | @@ -1723,8 +1696,6 @@ 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) | - | @@ -1775,8 +1746,6 @@ 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) | - | @@ -1785,9 +1754,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.tsx#L242](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/risk_score_mapping/index.tsx#L242) | - | | | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/autocomplete_field/index.tsx#L12) | - | | | [index.tsx#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/autocomplete_field/index.tsx#L35) | - | -| | [types.ts#L21](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L21) | - | -| | [types.ts#L66](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L66) | - | -| | [action.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#L19) | - | +| | [types.ts#L22](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L22) | - | +| | [types.ts#L72](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#L72) | - | +| | [action.ts#L20](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#L20) | - | | | [action.ts#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#L100) | - | | | [index.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#L8) | - | | | [index.ts#L86](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#L86) | - | @@ -1824,9 +1793,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/details/types.ts#L41) | - | | | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L12) | - | | | [index.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L34) | - | -| | [middleware.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L44) | - | -| | [middleware.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L60) | - | -| | [middleware.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L65) | - | +| | [middleware.ts#L48](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L48) | - | +| | [middleware.ts#L64](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L64) | - | +| | [middleware.ts#L69](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L69) | - | | | [types.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L12) | - | | | [types.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L28) | - | | | [index.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx#L15) | - | @@ -1839,25 +1808,6 @@ 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) | - | @@ -1881,6 +1831,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [use_field_value_autocomplete.ts#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/hooks/use_field_value_autocomplete.ts#L31) | - | | | [field_value_match.tsx#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match.tsx#L19) | - | | | [field_value_match.tsx#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/autocomplete/field_value_match.tsx#L30) | - | +| | [query.ts#L13](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts#L13) | - | +| | [query.ts#L52](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts#L52) | - | | | [model.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts#L8) | - | | | [model.ts#L30](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts#L30) | - | | | [index.tsx#L33](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/severity_mapping/index.tsx#L33) | - | @@ -1935,8 +1887,6 @@ 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 e06a7b3861371..5f9212c1bfca9 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -204,30 +204,7 @@ "path": "src/plugins/dev_tools/public/plugin.ts", "lineNumber": 32 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "setup", diff --git a/api_docs/discover.json b/api_docs/discover.json index 1824b5a3e3d5d..e7ba58f16fb9f 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -79,7 +79,7 @@ "description": [], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 22 + "lineNumber": 16 }, "deprecated": false, "children": [ @@ -97,7 +97,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 26 + "lineNumber": 20 }, "deprecated": false }, @@ -115,7 +115,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 31 + "lineNumber": 25 }, "deprecated": false }, @@ -140,7 +140,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 36 + "lineNumber": 30 }, "deprecated": false }, @@ -165,7 +165,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 41 + "lineNumber": 35 }, "deprecated": false }, @@ -190,7 +190,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 46 + "lineNumber": 40 }, "deprecated": false }, @@ -215,7 +215,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 52 + "lineNumber": 46 }, "deprecated": false }, @@ -233,7 +233,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 58 + "lineNumber": 52 }, "deprecated": false }, @@ -251,7 +251,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 63 + "lineNumber": 57 }, "deprecated": false }, @@ -269,7 +269,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 68 + "lineNumber": 62 }, "deprecated": false }, @@ -287,7 +287,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 73 + "lineNumber": 67 }, "deprecated": false }, @@ -305,7 +305,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 77 + "lineNumber": 72 }, "deprecated": false }, @@ -323,7 +323,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 81 + "lineNumber": 77 }, "deprecated": false } @@ -539,9 +539,7 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 22 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "discover", @@ -565,32 +563,7 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 23 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "discover", @@ -678,23 +651,7 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "discover", @@ -710,23 +667,7 @@ "path": "src/plugins/discover/public/saved_searches/types.ts", "lineNumber": 30 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -769,7 +710,13 @@ "label": "timeRange", "description": [], "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "source": { "path": "src/plugins/discover/public/application/embeddable/types.ts", @@ -890,7 +837,7 @@ ], "source": { "path": "src/plugins/discover/public/url_generator.ts", - "lineNumber": 20 + "lineNumber": 14 }, "deprecated": false, "initialIsOpen": false diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json index e575671b5ef22..7c7d8b78607eb 100644 --- a/api_docs/discover_enhanced.json +++ b/api_docs/discover_enhanced.json @@ -344,8 +344,7 @@ "text": "Action" }, "<", - "ExploreDataChartActionContext", - ">" + "ExploreDataChartActionContext" ], "source": { "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", @@ -725,41 +724,15 @@ "label": "uiActions", "description": [], "signature": [ - "{ 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.Trigger", - "text": "Trigger" + "section": "def-public.UiActionsService", + "text": "UiActionsService" }, - ") => void; readonly unregisterAction: (actionId: string) => void; }" + ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" ], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", @@ -876,7 +849,7 @@ "label": "uiActions", "description": [], "signature": [ - "{ readonly clear: () => void; readonly fork: () => ", + "Pick<", { "pluginId": "uiActions", "scope": "public", @@ -884,77 +857,17 @@ "section": "def-public.UiActionsService", "text": "UiActionsService" }, - "; 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" - }, + ", ", + "MethodKeysOf", "<", - "ActionContext", - ">; readonly registerTrigger: (trigger: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", - "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" + "section": "def-public.UiActionsService", + "text": "UiActionsService" }, - "[]>; 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 d560148f35b13..9d77663b21731 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -128,26 +128,7 @@ "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", @@ -203,18 +184,7 @@ "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", @@ -297,7 +267,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "() => string" + "() => any" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", @@ -610,18 +580,7 @@ "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", @@ -1113,26 +1072,7 @@ "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", @@ -1318,24 +1258,7 @@ "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", @@ -1673,8 +1596,7 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" - }, - "" + } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", @@ -1984,26 +1906,7 @@ "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", @@ -2070,7 +1973,7 @@ "label": "getDisplayName", "description": [], "signature": [ - "({ embeddable }: ActionContext) => string" + "({ embeddable }: ActionContext) => any" ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", @@ -2788,16 +2691,7 @@ "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", @@ -3847,9 +3741,7 @@ "type": "string", "tags": [], "label": "appId", - "description": [ - "- The id of the app to fetch the title for" - ], + "description": [], "signature": [ "string" ], @@ -4613,36 +4505,7 @@ "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", @@ -4718,9 +4581,7 @@ "type": "CompoundType", "tags": [], "label": "props", - "description": [ - "- {@link EmbeddableRendererProps}" - ], + "description": [], "signature": [ { "pluginId": "embeddable", @@ -4971,32 +4832,7 @@ "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", @@ -5314,32 +5150,7 @@ "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", @@ -5446,130 +5257,14 @@ "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" - }, - ", O extends ", - { - "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": [ + } + ], + "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", @@ -5669,48 +5364,13 @@ "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, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -5759,26 +5419,13 @@ "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, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -5832,7 +5479,7 @@ "label": "SavedObjectFinder", "description": [], "signature": [ - "React.ComponentClass | React.FunctionComponent" + "React.ComponentType" ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", @@ -6209,7 +5856,7 @@ "label": "PanelComponent", "description": [], "signature": [ - "React.FunctionComponent<{ embeddable: ", + "React.FC<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", @@ -6239,42 +5886,7 @@ "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 22 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -6461,9 +6073,7 @@ "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 48 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -7217,41 +6827,15 @@ "label": "uiActions", "description": [], "signature": [ - "{ readonly addTriggerAction: (triggerId: string, action: ", + "Pick<", { "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.Trigger", - "text": "Trigger" + "section": "def-public.UiActionsService", + "text": "UiActionsService" }, - ") => void; readonly unregisterAction: (actionId: string) => void; }" + ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", @@ -7283,7 +6867,7 @@ "label": "uiActions", "description": [], "signature": [ - "{ readonly clear: () => void; readonly fork: () => ", + "Pick<", { "pluginId": "uiActions", "scope": "public", @@ -7291,77 +6875,17 @@ "section": "def-public.UiActionsService", "text": "UiActionsService" }, - "; 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.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" - }, + ", ", + "MethodKeysOf", "<", - "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" + "section": "def-public.UiActionsService", + "text": "UiActionsService" }, - "[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise; }" + ">>" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", @@ -7700,16 +7224,7 @@ "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", @@ -7824,24 +7339,7 @@ "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", @@ -8287,16 +7785,7 @@ "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", @@ -8717,26 +8206,7 @@ "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 24 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -8754,9 +8224,7 @@ "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 29 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -8774,9 +8242,7 @@ "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 34 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -9028,23 +8494,7 @@ "label": "EmbeddableFactoryDefinition", "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\">>" + "Pick, \"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", @@ -9061,23 +8511,7 @@ "label": "EmbeddableInput", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "src/plugins/embeddable/common/types.ts", @@ -9094,7 +8528,7 @@ "label": "EmbeddablePanelHOC", "description": [], "signature": [ - "React.FunctionComponent<{ embeddable: ", + "(props: React.PropsWithChildren<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", @@ -9118,7 +8552,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">; hideHeader?: boolean | undefined; }>" + ">; hideHeader?: boolean | undefined; }>, context: any) => React.ReactElement | null" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", @@ -9245,10 +8679,13 @@ { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 50 @@ -9258,10 +8695,13 @@ { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.description", - "type": "string", + "type": "Any", "tags": [], "label": "description", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 53 @@ -9300,10 +8740,13 @@ { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 61 @@ -9313,10 +8756,13 @@ { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.description", - "type": "string", + "type": "Any", "tags": [], "label": "description", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 64 @@ -9355,10 +8801,13 @@ { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.title", - "type": "string", + "type": "Any", "tags": [], "label": "title", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 72 @@ -9368,10 +8817,13 @@ { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.description", - "type": "string", + "type": "Any", "tags": [], "label": "description", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 75 @@ -9442,78 +8894,13 @@ "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, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -9545,41 +8932,7 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -9597,94 +8950,7 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 72 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "setup", @@ -9776,48 +9042,13 @@ "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, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -9866,26 +9097,13 @@ "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, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -9895,7 +9113,7 @@ "label": "EmbeddablePanel", "description": [], "signature": [ - "React.FunctionComponent<{ embeddable: ", + "React.FC<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", @@ -9925,42 +9143,7 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 84 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -9991,33 +9174,7 @@ "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 85 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -10060,55 +9217,13 @@ "text": "SavedObjectEmbeddableInput" }, ">(type: string, options: ", - "AttributeServiceOptions", - ") => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeService", - "text": "AttributeService" - }, - "" + "AttributeServiceOptions" ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 86 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -10286,41 +9401,7 @@ "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -10352,41 +9433,7 @@ "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 30 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -10402,9 +9449,7 @@ "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 31 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "lifecycle": "setup", @@ -10418,22 +9463,7 @@ "label": "EmbeddableStart", "description": [], "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.PersistableStateService", - "text": "PersistableStateService" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" - }, - ">" + "PersistableStateService" ], "source": { "path": "src/plugins/embeddable/server/plugin.ts", @@ -11012,23 +10042,7 @@ "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 70 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "embeddable", @@ -11044,23 +10058,7 @@ "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -11192,23 +10190,7 @@ "label": "EmbeddableInput", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "src/plugins/embeddable/common/types.ts", @@ -11225,22 +10207,7 @@ "label": "EmbeddablePersistableStateService", "description": [], "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.PersistableStateService", - "text": "PersistableStateService" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" - }, - ">" + "PersistableStateService" ], "source": { "path": "src/plugins/embeddable/common/types.ts", @@ -11257,14 +10224,7 @@ "label": "EmbeddableStateWithType", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " & { type: string; }" + "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 d5e7bb8526bcc..5edce68bbb31f 100644 --- a/api_docs/embeddable_enhanced.json +++ b/api_docs/embeddable_enhanced.json @@ -95,6 +95,14 @@ "label": "embeddable", "description": [], "signature": [ + { + "pluginId": "embeddableEnhanced", + "scope": "public", + "docId": "kibEmbeddableEnhancedPluginApi", + "section": "def-public.EnhancedEmbeddable", + "text": "EnhancedEmbeddable" + }, + "<", { "pluginId": "embeddable", "scope": "public", @@ -118,15 +126,7 @@ "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,7 +268,13 @@ "label": "drilldownGrouping", "description": [], "signature": [ - "PresentableGroup", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.PresentableGrouping", + "text": "PresentableGrouping" + }, "<{ embeddable?: ", { "pluginId": "embeddable", @@ -293,7 +299,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - "> | undefined; }>[]" + "> | undefined; }>" ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts", @@ -310,15 +316,7 @@ "label": "EnhancedEmbeddable", "description": [], "signature": [ - "E & { enhancements: { dynamicActions: ", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.DynamicActionManager", - "text": "DynamicActionManager" - }, - "; }; }" + "E & { enhancements: { dynamicActions: 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 6a699e3534d4b..82e9d314075b4 100644 --- a/api_docs/encrypted_saved_objects.json +++ b/api_docs/encrypted_saved_objects.json @@ -181,59 +181,7 @@ "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "lineNumber": 41 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -357,32 +305,7 @@ "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 36 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "encryptedSavedObjects", @@ -392,166 +315,13 @@ "label": "createMigration", "description": [], "signature": [ - "(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" + "CreateEncryptedSavedObjectsMigrationFn" ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 37 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "setup", @@ -584,26 +354,7 @@ "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 41 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "encryptedSavedObjects", @@ -613,42 +364,13 @@ "label": "getClient", "description": [], "signature": [ - "(options?: ", - "EncryptedSavedObjectsClientOptions", - " | undefined) => ", - { - "pluginId": "encryptedSavedObjects", - "scope": "server", - "docId": "kibEncryptedSavedObjectsPluginApi", - "section": "def-server.EncryptedSavedObjectsClient", - "text": "EncryptedSavedObjectsClient" - } + "ClientInstanciator" ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 42 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "start", diff --git a/api_docs/enterprise_search.json b/api_docs/enterprise_search.json index 6ea7bfe1c50f1..f0c8b49bcd00d 100644 --- a/api_docs/enterprise_search.json +++ b/api_docs/enterprise_search.json @@ -22,11 +22,11 @@ "label": "ConfigType", "description": [], "signature": [ - "{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" + "{ readonly host?: string | undefined; readonly enabled: boolean; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" ], "source": { "path": "x-pack/plugins/enterprise_search/server/index.ts", - "lineNumber": 24 + "lineNumber": 33 }, "deprecated": false, "initialIsOpen": false @@ -49,8 +49,7 @@ "; accessCheckTimeout: ", "Type", "; accessCheckTimeoutWarning: ", - "Type", - "; }>" + "Type" ], "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 e7117e6be62a0..55ede83e42dc1 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -35,8 +35,15 @@ "label": "getDerivedStateFromProps", "description": [], "signature": [ - "(props: Props) => ", - "FieldToValueMap" + "typeof ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.CronEditor", + "text": "CronEditor" + }, + ".getDerivedStateFromProps" ], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", @@ -350,32 +357,13 @@ "label": "JsonEditor", "description": [], "signature": [ - "({ label, helpText, onUpdate, value, defaultValue, euiCodeEditorProps, error: propsError, }: Props) => JSX.Element" + "typeof JsonEditorComp" ], "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 }, { @@ -1283,9 +1271,7 @@ "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 25 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -1391,32 +1377,14 @@ "label": "indexNameBeginsWithPeriod", "description": [], "signature": [ - "(indexName?: string | undefined) => boolean" + "typeof ", + "indexNameBeginsWithPeriod" ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 19 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "esUiShared", @@ -1426,29 +1394,14 @@ "label": "findIllegalCharactersInIndexName", "description": [], "signature": [ - "(indexName: string) => string[]" + "typeof ", + "findIllegalCharactersInIndexName" ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 20 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "esUiShared", @@ -1458,29 +1411,14 @@ "label": "indexNameContainsSpaces", "description": [], "signature": [ - "(indexName: string) => boolean" + "typeof ", + "indexNameContainsSpaces" ], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 21 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/event_log.json b/api_docs/event_log.json index 1eb19bf6310de..cff27c9339335 100644 --- a/api_docs/event_log.json +++ b/api_docs/event_log.json @@ -687,7 +687,7 @@ "label": "logEvent", "description": [], "signature": [ - "(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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + "(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" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -703,7 +703,7 @@ "label": "properties", "description": [], "signature": [ - "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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | 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; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -723,7 +723,7 @@ "label": "startTiming", "description": [], "signature": [ - "(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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + "(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" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -739,7 +739,7 @@ "label": "event", "description": [], "signature": [ - "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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | 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; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -759,7 +759,7 @@ "label": "stopTiming", "description": [], "signature": [ - "(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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + "(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" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", @@ -775,7 +775,7 @@ "label": "event", "description": [], "signature": [ - "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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | 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; } & {}>>> | 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<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | 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; } & {}> | undefined)[]" ], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", @@ -872,7 +872,7 @@ "label": "IEvent", "description": [], "signature": [ - "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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + "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; } & {}>>>" ], "source": { "path": "x-pack/plugins/event_log/generated/schemas.ts", @@ -889,7 +889,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: 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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined" + "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; } & {}>" ], "source": { "path": "x-pack/plugins/event_log/generated/schemas.ts", @@ -1171,7 +1171,7 @@ "label": "getLogger", "description": [], "signature": [ - "(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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ", + "(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) => ", { "pluginId": "eventLog", "scope": "server", @@ -1194,7 +1194,7 @@ "label": "properties", "description": [], "signature": [ - "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; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | 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; } & {}>>> | undefined" ], "source": { "path": "x-pack/plugins/event_log/server/types.ts", diff --git a/api_docs/expressions.json b/api_docs/expressions.json index e981414fe7bda..31be451557924 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -35,52 +35,12 @@ "\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.ExecutionState", - "text": "ExecutionState" - }, - ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionPureTransitions", - "text": "ExecutionPureTransitions" + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" }, ">, {}>" + " | undefined; }>>" ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", @@ -1011,15 +971,7 @@ "label": "createWithDefaults", "description": [], "signature": [ - " = Record>(state?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - " | undefined) => ", + "typeof ", { "pluginId": "expressions", "scope": "common", @@ -1027,7 +979,7 @@ "section": "def-common.Executor", "text": "Executor" }, - "" + ".createWithDefaults" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -1070,38 +1022,14 @@ "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" + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" }, - ", ", - { - "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", @@ -1520,7 +1448,7 @@ "label": "context", "description": [], "signature": [ - "{ [x: string]: unknown; }" + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -1571,16 +1499,7 @@ "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", @@ -2167,58 +2086,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 38 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -2304,50 +2172,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 56 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -2381,34 +2206,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 60 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -2442,51 +2240,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -2918,9 +2672,7 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -2957,64 +2709,7 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 17 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -3549,7 +3244,8 @@ "section": "def-common.ExpressionsInspectorAdapter", "text": "ExpressionsInspectorAdapter" }, - " extends EventEmitter" + " extends ", + "EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", @@ -3643,7 +3339,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "public", @@ -3726,7 +3422,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", @@ -3870,7 +3566,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "public", @@ -3953,7 +3649,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", @@ -4751,72 +4447,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 263 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -4875,9 +4506,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to extract references from" - ], + "description": [], "signature": [ { "pluginId": "expressions", @@ -4956,9 +4585,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to extract references from" - ], + "description": [], "signature": [ { "pluginId": "expressions", @@ -5021,9 +4648,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to update" - ], + "description": [], "signature": [ { "pluginId": "expressions", @@ -5046,9 +4671,7 @@ "type": "Array", "tags": [], "label": "references", - "description": [ - "array of saved object references" - ], + "description": [], "signature": [ "SavedObjectReference", "[]" @@ -5104,9 +4727,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to update" - ], + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -5129,9 +4750,7 @@ "type": "string", "tags": [], "label": "version", - "description": [ - "defines which migration version to run" - ], + "description": [], "signature": [ "string" ], @@ -5165,7 +4784,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", @@ -5280,26 +4899,7 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -5974,7 +5574,8 @@ "section": "def-common.TablesAdapter", "text": "TablesAdapter" }, - " extends EventEmitter" + " extends ", + "EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", @@ -7065,9 +6666,7 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -7079,7 +6678,7 @@ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ - "{ [x: string]: unknown; }" + "Record" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -7097,7 +6696,7 @@ "\nA map of available expression types." ], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -7165,9 +6764,7 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -7355,15 +6952,13 @@ "label": "ast", "description": [], "signature": [ - "{ type: \"expression\"; chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" - }, - "[]; }" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -7459,7 +7054,7 @@ "label": "functions", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -7483,7 +7078,7 @@ "label": "types", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -7632,37 +7227,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 66 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -7689,11 +7254,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 74 }, - "deprecated": false, - "returnComment": [ - "`ExpressionAstExpression`" - ], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -7713,11 +7274,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "deprecated": false, - "returnComment": [ - "`string`" - ], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -7832,55 +7389,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 86 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -7908,30 +7417,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 99 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -7959,56 +7445,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 111 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -8028,30 +7465,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -8078,11 +7492,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 130 }, - "deprecated": false, - "returnComment": [ - "`ExpressionAstFunction`" - ], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -8102,11 +7512,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "deprecated": false, - "returnComment": [ - "`string`" - ], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -8533,28 +7939,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8574,36 +7961,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8623,28 +7983,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8664,28 +8005,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8705,28 +8027,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8746,52 +8049,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8811,52 +8071,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -8876,52 +8093,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -9121,64 +8295,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 42 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -9325,23 +8442,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 79 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -9367,23 +8468,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 87 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -9409,23 +8494,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 95 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -9459,72 +8528,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 121 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -9566,72 +8570,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 132 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -9656,9 +8595,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 148 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -10224,9 +9161,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -10242,26 +9177,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -10277,9 +9193,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -10295,26 +9209,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -10330,26 +9225,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -10388,9 +9264,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 73 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -10406,9 +9280,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -11072,22 +9944,7 @@ "\nType to capture every possible expression function definition." ], "signature": [ - { - "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" - }, - "<", + "ExpressionFunctionDefinition, any, ExecutionContext<", { "pluginId": "inspector", "scope": "common", @@ -11114,14 +9971,7 @@ "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeDefinition", - "text": "ExpressionTypeDefinition" - }, - "" + "ExpressionTypeDefinition" ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", @@ -11159,7 +10009,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -11195,30 +10045,7 @@ "label": "ExecutionContainer", "description": [], "signature": [ - { - "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" - }, - ", {}>" + "StateContainer, ExecutionPureTransitions, {}>" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -11235,38 +10062,7 @@ "label": "ExecutorContainer", "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.ExecutorPureTransitions", - "text": "ExecutorPureTransitions" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorPureSelectors", - "text": "ExecutorPureSelectors" - }, - ">" + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -11283,7 +10079,7 @@ "label": "ExpressionAstArgument", "description": [], "signature": [ - "string | number | boolean | ", + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", @@ -11307,15 +10103,7 @@ "label": "ExpressionAstExpression", "description": [], "signature": [ - "{ type: \"expression\"; chain: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" - }, - "[]; }" + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -11332,23 +10120,7 @@ "label": "ExpressionAstFunction", "description": [], "signature": [ - "{ type: \"function\"; function: string; arguments: Record; debug?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionDebug", - "text": "ExpressionAstFunctionDebug" - }, - " | undefined; }" + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -11365,7 +10137,7 @@ "label": "ExpressionAstNode", "description": [], "signature": [ - "string | number | boolean | ", + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", @@ -11397,7 +10169,7 @@ "label": "ExpressionRendererComponent", "description": [], "signature": [ - "React.FunctionComponent<", + "(props: React.PropsWithChildren<", { "pluginId": "expressions", "scope": "public", @@ -11405,7 +10177,7 @@ "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, - ">" + ">, context: any) => React.ReactElement | null" ], "source": { "path": "src/plugins/expressions/public/react_expression_renderer.tsx", @@ -11473,23 +10245,7 @@ "label": "ExpressionValueError", "description": [], "signature": [ - "{ 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; }" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -11508,15 +10264,7 @@ "\nRepresents an object that is a Filter." ], "signature": [ - "{ 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; }" + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", @@ -11645,23 +10393,7 @@ "label": "InterpreterErrorType", "description": [], "signature": [ - "{ 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; }" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -11700,15 +10432,7 @@ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ - "{ type: \"pointseries\"; } & { columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.PointSeriesColumns", - "text": "PointSeriesColumns" - }, - "; rows: Record[]; }" + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -11727,7 +10451,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -11829,13 +10553,7 @@ "label": "Style", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeStyle", - "text": "ExpressionTypeStyle" - } + "ExpressionTypeStyle" ], "source": { "path": "src/plugins/expressions/common/types/style.ts", @@ -11854,43 +10572,7 @@ "\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", @@ -11965,23 +10647,7 @@ "section": "def-common.ExpressionType", "text": "ExpressionType" }, - " | 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) => ", + " | undefined; readonly getFunction: (name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -12012,72 +10678,7 @@ "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", @@ -12167,94 +10768,13 @@ "label": "loader", "description": [], "signature": [ - "(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" + "IExpressionLoader" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 27 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -12278,32 +10798,7 @@ "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 28 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -12313,74 +10808,14 @@ "label": "render", "description": [], "signature": [ - "(element: HTMLElement, data: any, options?: ", - "ExpressionRenderHandlerParams", - " | undefined) => ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderHandler", - "text": "ExpressionRenderHandler" - } + "typeof ", + "render" ], "source": { "path": "src/plugins/expressions/public/plugin.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -12422,52 +10857,12 @@ "\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.ExecutionState", - "text": "ExecutionState" - }, - ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionPureTransitions", - "text": "ExecutionPureTransitions" + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" }, ">, {}>" + " | undefined; }>>" ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", @@ -13183,15 +11578,7 @@ "label": "createWithDefaults", "description": [], "signature": [ - " = Record>(state?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - " | undefined) => ", + "typeof ", { "pluginId": "expressions", "scope": "common", @@ -13199,7 +11586,7 @@ "section": "def-common.Executor", "text": "Executor" }, - "" + ".createWithDefaults" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -13242,38 +11629,14 @@ "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.ExecutorPureTransitions", - "text": "ExecutorPureTransitions" - }, - ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorPureSelectors", - "text": "ExecutorPureSelectors" + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" }, - ">" + "" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -13692,7 +12055,7 @@ "label": "context", "description": [], "signature": [ - "{ [x: string]: unknown; }" + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -13743,16 +12106,7 @@ "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", @@ -14339,58 +12693,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 38 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -14476,50 +12779,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 56 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -14553,34 +12813,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 60 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -14614,51 +12847,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -15090,9 +13279,7 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -15129,64 +13316,7 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 17 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -15470,7 +13600,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "common", @@ -15575,7 +13705,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -15719,7 +13849,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">, ", + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", { "pluginId": "expressions", "scope": "common", @@ -15824,7 +13954,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -15994,26 +14124,7 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -17611,9 +15722,7 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -17625,7 +15734,7 @@ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ - "{ [x: string]: unknown; }" + "Record" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -17643,7 +15752,7 @@ "\nA map of available expression types." ], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -17711,9 +15820,7 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -17901,15 +16008,13 @@ "label": "ast", "description": [], "signature": [ - "{ type: \"expression\"; chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" - }, - "[]; }" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -18005,7 +16110,7 @@ "label": "functions", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -18029,7 +16134,7 @@ "label": "types", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -18178,37 +16283,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 66 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18235,11 +16310,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 74 }, - "deprecated": false, - "returnComment": [ - "`ExpressionAstExpression`" - ], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18259,11 +16330,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "deprecated": false, - "returnComment": [ - "`string`" - ], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -18378,55 +16445,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 86 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18454,30 +16473,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 99 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18505,56 +16501,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 111 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18574,30 +16521,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18624,11 +16548,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 130 }, - "deprecated": false, - "returnComment": [ - "`ExpressionAstFunction`" - ], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -18648,11 +16568,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "deprecated": false, - "returnComment": [ - "`string`" - ], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -19044,28 +16960,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19085,36 +16982,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19134,28 +17004,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19175,28 +17026,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19216,28 +17048,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19257,52 +17070,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19322,52 +17092,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19387,52 +17114,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -19632,64 +17316,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 42 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -19998,9 +17625,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20016,26 +17641,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20051,9 +17657,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20069,26 +17673,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20104,26 +17689,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20162,9 +17728,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 73 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20180,9 +17744,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -20643,22 +18205,7 @@ "\nType to capture every possible expression function definition." ], "signature": [ - { - "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" - }, - "<", + "ExpressionFunctionDefinition, any, ExecutionContext<", { "pluginId": "inspector", "scope": "common", @@ -20685,14 +18232,7 @@ "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeDefinition", - "text": "ExpressionTypeDefinition" - }, - "" + "ExpressionTypeDefinition" ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", @@ -20730,7 +18270,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -20766,30 +18306,7 @@ "label": "ExecutionContainer", "description": [], "signature": [ - { - "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" - }, - ", {}>" + "StateContainer, ExecutionPureTransitions, {}>" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -20806,38 +18323,7 @@ "label": "ExecutorContainer", "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.ExecutorPureTransitions", - "text": "ExecutorPureTransitions" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorPureSelectors", - "text": "ExecutorPureSelectors" - }, - ">" + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -20854,7 +18340,7 @@ "label": "ExpressionAstArgument", "description": [], "signature": [ - "string | number | boolean | ", + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", @@ -20878,15 +18364,7 @@ "label": "ExpressionAstExpression", "description": [], "signature": [ - "{ type: \"expression\"; chain: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" - }, - "[]; }" + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -20903,23 +18381,7 @@ "label": "ExpressionAstFunction", "description": [], "signature": [ - "{ type: \"function\"; function: string; arguments: Record; debug?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionDebug", - "text": "ExpressionAstFunctionDebug" - }, - " | undefined; }" + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -20936,7 +18398,7 @@ "label": "ExpressionAstNode", "description": [], "signature": [ - "string | number | boolean | ", + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", @@ -21019,23 +18481,7 @@ "label": "ExpressionValueError", "description": [], "signature": [ - "{ 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; }" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -21054,15 +18500,7 @@ "\nRepresents an object that is a Filter." ], "signature": [ - "{ 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; }" + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", @@ -21191,23 +18629,7 @@ "label": "InterpreterErrorType", "description": [], "signature": [ - "{ 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; }" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -21246,15 +18668,7 @@ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ - "{ type: \"pointseries\"; } & { columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.PointSeriesColumns", - "text": "PointSeriesColumns" - }, - "; rows: Record[]; }" + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -21273,7 +18687,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -21342,13 +18756,7 @@ "label": "Style", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeStyle", - "text": "ExpressionTypeStyle" - } + "ExpressionTypeStyle" ], "source": { "path": "src/plugins/expressions/common/types/style.ts", @@ -21367,43 +18775,7 @@ "\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", @@ -21476,23 +18848,7 @@ "section": "def-common.ExpressionType", "text": "ExpressionType" }, - " | 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) => ", + " | undefined; readonly getFunction: (name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -21523,72 +18879,7 @@ "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", @@ -21606,13 +18897,7 @@ "label": "ExpressionsServerStart", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsServiceStart", - "text": "ExpressionsServiceStart" - } + "ExpressionsServiceStart" ], "source": { "path": "src/plugins/expressions/server/plugin.ts", @@ -21658,52 +18943,12 @@ "\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.ExecutionState", - "text": "ExecutionState" - }, - ">, ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionPureTransitions", - "text": "ExecutionPureTransitions" + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" }, ">, {}>" + " | undefined; }>>" ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", @@ -22634,15 +19879,7 @@ "label": "createWithDefaults", "description": [], "signature": [ - " = Record>(state?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - " | undefined) => ", + "typeof ", { "pluginId": "expressions", "scope": "common", @@ -22650,7 +19887,7 @@ "section": "def-common.Executor", "text": "Executor" }, - "" + ".createWithDefaults" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -22693,38 +19930,14 @@ "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" + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" }, - ", ", - { - "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", @@ -23143,7 +20356,7 @@ "label": "context", "description": [], "signature": [ - "{ [x: string]: unknown; }" + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", @@ -23194,16 +20407,7 @@ "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", @@ -23790,58 +20994,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 38 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -23927,50 +21080,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 56 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -24004,34 +21114,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 60 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -24065,51 +21148,7 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 63 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -24541,9 +21580,7 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 15 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -24580,64 +21617,7 @@ "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "lineNumber": 17 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -24905,7 +21885,8 @@ "section": "def-common.ExpressionsInspectorAdapter", "text": "ExpressionsInspectorAdapter" }, - " extends EventEmitter" + " extends ", + "EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", @@ -25653,72 +22634,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 263 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -25777,9 +22693,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to extract references from" - ], + "description": [], "signature": [ { "pluginId": "expressions", @@ -25858,9 +22772,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to extract references from" - ], + "description": [], "signature": [ { "pluginId": "expressions", @@ -25923,9 +22835,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to update" - ], + "description": [], "signature": [ { "pluginId": "expressions", @@ -25948,9 +22858,7 @@ "type": "Array", "tags": [], "label": "references", - "description": [ - "array of saved object references" - ], + "description": [], "signature": [ "SavedObjectReference", "[]" @@ -26006,9 +22914,7 @@ "type": "Object", "tags": [], "label": "state", - "description": [ - "expression AST to update" - ], + "description": [], "signature": [ { "pluginId": "kibanaUtils", @@ -26031,9 +22937,7 @@ "type": "string", "tags": [], "label": "version", - "description": [ - "defines which migration version to run" - ], + "description": [], "signature": [ "string" ], @@ -26067,7 +22971,7 @@ "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, - ", \"getType\" | \"registerType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"run\" | \"fork\">" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", @@ -26182,26 +23086,7 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "lineNumber": 23 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -26876,7 +23761,8 @@ "section": "def-common.TablesAdapter", "text": "TablesAdapter" }, - " extends EventEmitter" + " extends ", + "EventEmitter" ], "source": { "path": "src/plugins/expressions/common/util/tables_adapter.ts", @@ -29084,7 +25970,13 @@ "label": "type", "description": [], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumnType", + "text": "DatatableColumnType" + } ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -29387,9 +26279,7 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 27 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -29401,7 +26291,7 @@ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ - "{ [x: string]: unknown; }" + "Record" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -29419,7 +26309,7 @@ "\nA map of available expression types." ], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/execution/types.ts", @@ -29487,9 +26377,7 @@ "path": "src/plugins/expressions/common/execution/types.ts", "lineNumber": 52 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -29691,33 +26579,7 @@ "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 51 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -29749,33 +26611,7 @@ "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 52 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -29807,33 +26643,7 @@ "path": "src/plugins/expressions/common/execution/container.ts", "lineNumber": 53 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -29877,15 +26687,13 @@ "label": "ast", "description": [], "signature": [ - "{ type: \"expression\"; chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" - }, - "[]; }" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -29993,33 +26801,7 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 44 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30051,33 +26833,7 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 45 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30101,33 +26857,7 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 46 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -30183,33 +26913,7 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30249,33 +26953,7 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 30 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30307,33 +26985,7 @@ "path": "src/plugins/expressions/common/executor/container.ts", "lineNumber": 31 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -30369,7 +27021,7 @@ "label": "functions", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -30393,7 +27045,7 @@ "label": "types", "description": [], "signature": [ - "{ [x: string]: ", + "Record" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -30542,37 +27194,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 66 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30599,11 +27221,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 74 }, - "deprecated": false, - "returnComment": [ - "`ExpressionAstExpression`" - ], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30623,11 +27241,7 @@ "path": "src/plugins/expressions/common/ast/build_expression.ts", "lineNumber": 80 }, - "deprecated": false, - "returnComment": [ - "`string`" - ], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -30742,55 +27356,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 86 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30818,30 +27384,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 99 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30869,56 +27412,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 111 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30938,30 +27432,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 124 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -30988,11 +27459,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 130 }, - "deprecated": false, - "returnComment": [ - "`ExpressionAstFunction`" - ], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -31012,11 +27479,7 @@ "path": "src/plugins/expressions/common/ast/build_function.ts", "lineNumber": 136 }, - "deprecated": false, - "returnComment": [ - "`string`" - ], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -31595,28 +28058,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31636,36 +28080,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31685,28 +28102,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31726,28 +28124,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31767,28 +28146,9 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "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", - ">>" + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31808,52 +28168,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31873,52 +28190,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -31938,52 +28212,9 @@ "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", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } ], "source": { "path": "src/plugins/expressions/common/expression_functions/types.ts", @@ -32183,64 +28414,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 42 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -32346,23 +28520,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 79 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -32388,23 +28546,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 87 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -32430,23 +28572,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 95 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -32480,72 +28606,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 121 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -32587,72 +28648,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 132 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -32677,9 +28673,7 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 148 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -32988,9 +28982,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 67 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33006,26 +28998,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 68 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33041,9 +29014,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 69 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33059,26 +29030,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 70 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33094,26 +29046,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 71 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33152,9 +29085,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 73 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33170,9 +29101,7 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "lineNumber": 74 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "expressions", @@ -33865,22 +29794,7 @@ "\nType to capture every possible expression function definition." ], "signature": [ - { - "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" - }, - "<", + "ExpressionFunctionDefinition, any, ExecutionContext<", { "pluginId": "inspector", "scope": "common", @@ -33907,14 +29821,7 @@ "label": "AnyExpressionRenderDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderDefinition", - "text": "ExpressionRenderDefinition" - }, - "" + "ExpressionRenderDefinition" ], "source": { "path": "src/plugins/expressions/common/expression_renderers/types.ts", @@ -33931,14 +29838,7 @@ "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeDefinition", - "text": "ExpressionTypeDefinition" - }, - "" + "ExpressionTypeDefinition" ], "source": { "path": "src/plugins/expressions/common/expression_types/types.ts", @@ -33976,7 +29876,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"unknown\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", @@ -34012,22 +29912,7 @@ "label": "ErrorLike", "description": [], "signature": [ - { - "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; }" + "SerializedError & { original?: SerializedError | undefined; }" ], "source": { "path": "src/plugins/expressions/common/util/create_error.ts", @@ -34044,30 +29929,7 @@ "label": "ExecutionContainer", "description": [], "signature": [ - { - "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" - }, - ", {}>" + "StateContainer, ExecutionPureTransitions, {}>" ], "source": { "path": "src/plugins/expressions/common/execution/container.ts", @@ -34084,38 +29946,7 @@ "label": "ExecutorContainer", "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.ExecutorPureTransitions", - "text": "ExecutorPureTransitions" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorPureSelectors", - "text": "ExecutorPureSelectors" - }, - ">" + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" ], "source": { "path": "src/plugins/expressions/common/executor/container.ts", @@ -34132,7 +29963,7 @@ "label": "ExpressionAstArgument", "description": [], "signature": [ - "string | number | boolean | ", + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", @@ -34156,15 +29987,7 @@ "label": "ExpressionAstExpression", "description": [], "signature": [ - "{ type: \"expression\"; chain: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" - }, - "[]; }" + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -34181,23 +30004,7 @@ "label": "ExpressionAstFunction", "description": [], "signature": [ - "{ type: \"function\"; function: string; arguments: Record; debug?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionDebug", - "text": "ExpressionAstFunctionDebug" - }, - " | undefined; }" + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -34214,7 +30021,7 @@ "label": "ExpressionAstFunctionDebug", "description": [], "signature": [ - "{ success: boolean; fn: string; input: any; args: Record; output?: any; error?: ", + "{ success: boolean; fn: string; input: ExpressionValue; args: Record; output?: ExpressionValue; error?: ", { "pluginId": "expressions", "scope": "common", @@ -34238,7 +30045,7 @@ "section": "def-common.SerializableState", "text": "SerializableState" }, - " | undefined; }> | undefined; rawError?: any; duration: number | undefined; }" + " | undefined; }> | undefined; rawError?: any | Error; duration: number | undefined; }" ], "source": { "path": "src/plugins/expressions/common/ast/types.ts", @@ -34255,7 +30062,7 @@ "label": "ExpressionAstNode", "description": [], "signature": [ - "string | number | boolean | ", + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", @@ -34287,14 +30094,7 @@ "label": "ExpressionFunctionClog", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"clog\", unknown, {}, unknown, ", + "ExpressionFunctionDefinition<\"clog\", unknown, {}, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -34329,38 +30129,7 @@ "label": "ExpressionFunctionCumulativeSum", "description": [], "signature": [ - { - "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" - }, - ", ", + "ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ", { "pluginId": "expressions", "scope": "common", @@ -34395,38 +30164,7 @@ "label": "ExpressionFunctionDerivative", "description": [], "signature": [ - { - "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" - }, - ", ", + "ExpressionFunctionDefinition<\"derivative\", Datatable, DerivativeArgs, Datatable, ", { "pluginId": "expressions", "scope": "common", @@ -34461,14 +30199,7 @@ "label": "ExpressionFunctionFont", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"font\", null, Arguments, ", + "ExpressionFunctionDefinition<\"font\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", @@ -34511,38 +30242,7 @@ "label": "ExpressionFunctionMovingAverage", "description": [], "signature": [ - { - "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" - }, - ", ", + "ExpressionFunctionDefinition<\"moving_average\", Datatable, MovingAverageArgs, Datatable, ", { "pluginId": "expressions", "scope": "common", @@ -34577,14 +30277,7 @@ "label": "ExpressionFunctionTheme", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"theme\", null, Arguments, any, ", + "ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ", { "pluginId": "expressions", "scope": "common", @@ -34619,14 +30312,7 @@ "label": "ExpressionFunctionVar", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"var\", unknown, Arguments, unknown, ", + "ExpressionFunctionDefinition<\"var\", unknown, Arguments, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -34661,14 +30347,7 @@ "label": "ExpressionFunctionVarSet", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"var_set\", unknown, Arguments, unknown, ", + "ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -34713,23 +30392,7 @@ "section": "def-common.ExpressionType", "text": "ExpressionType" }, - " | 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) => ", + " | undefined; readonly getFunction: (name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -34760,72 +30423,7 @@ "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", @@ -34893,23 +30491,7 @@ "label": "ExpressionValueError", "description": [], "signature": [ - "{ 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; }" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -34928,15 +30510,7 @@ "\nRepresents an object that is a Filter." ], "signature": [ - "{ 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; }" + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", @@ -35087,15 +30661,7 @@ "label": "InferFunctionDefinition", "description": [], "signature": [ - "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" + "FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" ], "source": { "path": "src/plugins/expressions/common/ast/build_function.ts", @@ -35114,23 +30680,7 @@ "label": "InterpreterErrorType", "description": [], "signature": [ - "{ 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; }" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", @@ -35210,15 +30760,7 @@ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ - "{ type: \"pointseries\"; } & { columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.PointSeriesColumns", - "text": "PointSeriesColumns" - }, - "; rows: Record[]; }" + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -35237,7 +30779,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", @@ -35538,13 +31080,7 @@ "label": "Style", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeStyle", - "text": "ExpressionTypeStyle" - } + "ExpressionTypeStyle" ], "source": { "path": "src/plugins/expressions/common/types/style.ts", @@ -35587,43 +31123,7 @@ "\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", @@ -36182,10 +31682,13 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 61 @@ -36221,10 +31724,13 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 67 @@ -36297,10 +31803,13 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 75 @@ -36357,10 +31866,13 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 82 @@ -36417,10 +31929,13 @@ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "lineNumber": 89 @@ -37101,10 +32616,13 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 62 @@ -37140,10 +32658,13 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.by.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 68 @@ -37216,10 +32737,13 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 76 @@ -37276,10 +32800,13 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 83 @@ -37336,10 +32863,13 @@ { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "lineNumber": 90 @@ -37579,24 +33109,7 @@ "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", @@ -38022,10 +33535,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 50 @@ -38090,10 +33606,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.align.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 57 @@ -38170,10 +33689,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.color.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 65 @@ -38227,10 +33749,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.family.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 72 @@ -38284,10 +33809,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.italic.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 82 @@ -38373,10 +33901,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 91 @@ -38430,10 +33961,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.size.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 98 @@ -38487,10 +34021,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.underline.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 105 @@ -38560,10 +34097,13 @@ { "parentPluginId": "expressions", "id": "def-common.font.args.weight.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "lineNumber": 113 @@ -38819,7 +34359,7 @@ "section": "def-common.ExpressionImage", "text": "ExpressionImage" }, - ", \"mode\" | \"dataurl\">; }>" + ", \"dataurl\" | \"mode\">; }>" ], "source": { "path": "src/plugins/expressions/common/expression_types/specs/image.ts", @@ -38955,10 +34495,13 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 32 @@ -39010,10 +34553,13 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 45 @@ -39102,10 +34648,13 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 55 @@ -39151,7 +34700,7 @@ "label": "types", "description": [], "signature": [ - "(\"boolean\" | \"string\" | \"number\" | \"null\")[]" + "(\"number\" | \"boolean\" | \"string\" | \"null\")[]" ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", @@ -39194,10 +34743,13 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 64 @@ -39254,10 +34806,13 @@ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 75 @@ -39456,10 +35011,13 @@ { "parentPluginId": "expressions", "id": "def-common.math.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 88 @@ -39527,10 +35085,13 @@ { "parentPluginId": "expressions", "id": "def-common.math.args.expression.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 105 @@ -39587,10 +35148,13 @@ { "parentPluginId": "expressions", "id": "def-common.math.args.onError.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "lineNumber": 116 @@ -39751,10 +35315,13 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 60 @@ -39790,10 +35357,13 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 66 @@ -39866,10 +35436,13 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 74 @@ -39926,10 +35499,13 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 81 @@ -39986,10 +35562,13 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 88 @@ -40046,10 +35625,13 @@ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "lineNumber": 95 @@ -42147,10 +37729,13 @@ { "parentPluginId": "expressions", "id": "def-common.theme.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 30 @@ -42218,10 +37803,13 @@ { "parentPluginId": "expressions", "id": "def-common.theme.args.variable.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 37 @@ -42278,10 +37866,13 @@ { "parentPluginId": "expressions", "id": "def-common.theme.args.default.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "lineNumber": 44 @@ -42432,10 +38023,13 @@ { "parentPluginId": "expressions", "id": "def-common.variable.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 25 @@ -42519,10 +38113,13 @@ { "parentPluginId": "expressions", "id": "def-common.variable.args.name.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "lineNumber": 33 @@ -42673,10 +38270,13 @@ { "parentPluginId": "expressions", "id": "def-common.variableSet.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 26 @@ -42760,10 +38360,13 @@ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.help", - "type": "string", + "type": "Any", "tags": [], "label": "help", "description": [], + "signature": [ + "any" + ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "lineNumber": 34 @@ -42804,10 +38407,13 @@ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.help", - "type": "string", + "type": "Any", "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 63c3ebe3a92de..f0424e11a81ff 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -11,7 +11,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 137 + "lineNumber": 142 }, "deprecated": false, "children": [ @@ -34,7 +34,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 138 + "lineNumber": 143 }, "deprecated": false }, @@ -50,7 +50,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 + "lineNumber": 145 }, "deprecated": false, "children": [ @@ -62,7 +62,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", + "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { "pluginId": "features", "scope": "common", @@ -70,11 +70,11 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"all\" | \"none\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; ui: readonly string[]; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 + "lineNumber": 145 }, "deprecated": false, "isRequired": true @@ -91,7 +91,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 146 + "lineNumber": 151 }, "deprecated": false }, @@ -104,7 +104,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 150 + "lineNumber": 155 }, "deprecated": false }, @@ -120,7 +120,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 154 + "lineNumber": 159 }, "deprecated": false }, @@ -132,11 +132,11 @@ "label": "category", "description": [], "signature": [ - "{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }" + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 158 + "lineNumber": 163 }, "deprecated": false }, @@ -152,7 +152,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 162 + "lineNumber": 167 }, "deprecated": false }, @@ -168,7 +168,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 166 + "lineNumber": 171 }, "deprecated": false }, @@ -184,7 +184,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 170 + "lineNumber": 175 }, "deprecated": false }, @@ -200,7 +200,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 174 + "lineNumber": 179 }, "deprecated": false }, @@ -212,11 +212,11 @@ "label": "privileges", "description": [], "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 178 + "lineNumber": 183 }, "deprecated": false }, @@ -232,7 +232,23 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 182 + "lineNumber": 187 + }, + "deprecated": false + }, + { + "parentPluginId": "features", + "id": "def-public.KibanaFeature.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 191 }, "deprecated": false }, @@ -245,7 +261,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 186 + "lineNumber": 195 }, "deprecated": false }, @@ -257,11 +273,11 @@ "label": "reserved", "description": [], "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 190 + "lineNumber": 199 }, "deprecated": false }, @@ -284,7 +300,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 194 + "lineNumber": 203 }, "deprecated": false, "children": [], @@ -411,7 +427,7 @@ "\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], "signature": [ - "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + "{ rule?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; alert?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; } | undefined" ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", @@ -419,6 +435,24 @@ }, "deprecated": false }, + { + "parentPluginId": "features", + "id": "def-public.FeatureKibanaPrivileges.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nIf your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should\nbe unique identifiers for the owners of cases you want access to." + ], + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 135 + }, + "deprecated": false + }, { "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.savedObject", @@ -433,7 +467,7 @@ ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 110 + "lineNumber": 161 }, "deprecated": false }, @@ -453,7 +487,7 @@ ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 153 + "lineNumber": 204 }, "deprecated": false } @@ -651,6 +685,24 @@ }, "deprecated": false }, + { + "parentPluginId": "features", + "id": "def-public.KibanaFeatureConfig.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nIf your feature grants access to specific case types, you can specify them here to control visibility based on the current space." + ], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 104 + }, + "deprecated": false + }, { "parentPluginId": "features", "id": "def-public.KibanaFeatureConfig.privileges", @@ -683,7 +735,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 113 + "lineNumber": 118 }, "deprecated": false }, @@ -709,7 +761,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 121 + "lineNumber": 126 }, "deprecated": false }, @@ -727,7 +779,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 126 + "lineNumber": 131 }, "deprecated": false }, @@ -747,7 +799,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 131 + "lineNumber": 136 }, "deprecated": false } @@ -838,7 +890,7 @@ "section": "def-common.FeatureKibanaPrivileges", "text": "FeatureKibanaPrivileges" }, - ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"app\" | \"api\" | \"savedObject\">" + ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"cases\" | \"app\" | \"api\" | \"savedObject\">" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -886,7 +938,7 @@ "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." ], "signature": [ - "\"none\" | \"all\" | \"read\"" + "\"all\" | \"none\" | \"read\"" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -1139,7 +1191,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 137 + "lineNumber": 142 }, "deprecated": false, "children": [ @@ -1162,7 +1214,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 138 + "lineNumber": 143 }, "deprecated": false }, @@ -1178,7 +1230,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 + "lineNumber": 145 }, "deprecated": false, "children": [ @@ -1190,7 +1242,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", + "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { "pluginId": "features", "scope": "common", @@ -1198,11 +1250,11 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"all\" | \"none\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; ui: readonly string[]; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 + "lineNumber": 145 }, "deprecated": false, "isRequired": true @@ -1219,7 +1271,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 146 + "lineNumber": 151 }, "deprecated": false }, @@ -1232,7 +1284,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 150 + "lineNumber": 155 }, "deprecated": false }, @@ -1248,7 +1300,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 154 + "lineNumber": 159 }, "deprecated": false }, @@ -1260,11 +1312,11 @@ "label": "category", "description": [], "signature": [ - "{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }" + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 158 + "lineNumber": 163 }, "deprecated": false }, @@ -1280,7 +1332,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 162 + "lineNumber": 167 }, "deprecated": false }, @@ -1296,7 +1348,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 166 + "lineNumber": 171 }, "deprecated": false }, @@ -1312,7 +1364,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 170 + "lineNumber": 175 }, "deprecated": false }, @@ -1328,7 +1380,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 174 + "lineNumber": 179 }, "deprecated": false }, @@ -1340,11 +1392,11 @@ "label": "privileges", "description": [], "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 178 + "lineNumber": 183 }, "deprecated": false }, @@ -1360,7 +1412,23 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 182 + "lineNumber": 187 + }, + "deprecated": false + }, + { + "parentPluginId": "features", + "id": "def-server.KibanaFeature.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 191 }, "deprecated": false }, @@ -1373,7 +1441,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 186 + "lineNumber": 195 }, "deprecated": false }, @@ -1385,11 +1453,11 @@ "label": "reserved", "description": [], "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 190 + "lineNumber": 199 }, "deprecated": false }, @@ -1412,7 +1480,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 194 + "lineNumber": 203 }, "deprecated": false, "children": [], @@ -1740,7 +1808,7 @@ "\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], "signature": [ - "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + "{ rule?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; alert?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; } | undefined" ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", @@ -1748,6 +1816,24 @@ }, "deprecated": false }, + { + "parentPluginId": "features", + "id": "def-server.FeatureKibanaPrivileges.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nIf your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should\nbe unique identifiers for the owners of cases you want access to." + ], + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 135 + }, + "deprecated": false + }, { "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.savedObject", @@ -1762,7 +1848,7 @@ ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 110 + "lineNumber": 161 }, "deprecated": false }, @@ -1782,7 +1868,7 @@ ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 153 + "lineNumber": 204 }, "deprecated": false } @@ -1980,6 +2066,24 @@ }, "deprecated": false }, + { + "parentPluginId": "features", + "id": "def-server.KibanaFeatureConfig.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nIf your feature grants access to specific case types, you can specify them here to control visibility based on the current space." + ], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 104 + }, + "deprecated": false + }, { "parentPluginId": "features", "id": "def-server.KibanaFeatureConfig.privileges", @@ -2012,7 +2116,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 113 + "lineNumber": 118 }, "deprecated": false }, @@ -2038,7 +2142,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 121 + "lineNumber": 126 }, "deprecated": false }, @@ -2056,7 +2160,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 126 + "lineNumber": 131 }, "deprecated": false }, @@ -2076,7 +2180,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 131 + "lineNumber": 136 }, "deprecated": false } @@ -2297,72 +2401,13 @@ "\nUtility for iterating through all privileges belonging to a specific feature.\n{@see FeaturePrivilegeIterator }" ], "signature": [ - "(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" - }, - "; }>" + "FeaturePrivilegeIterator" ], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 70 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "features", @@ -2374,70 +2419,13 @@ "\nUtility for iterating through all sub-feature privileges belonging to a specific feature.\n{@see SubFeaturePrivilegeIterator }" ], "signature": [ - "(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" - }, - ">" + "SubFeaturePrivilegeIterator" ], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 76 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -2708,7 +2696,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 137 + "lineNumber": 142 }, "deprecated": false, "children": [ @@ -2731,7 +2719,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 138 + "lineNumber": 143 }, "deprecated": false }, @@ -2747,7 +2735,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 + "lineNumber": 145 }, "deprecated": false, "children": [ @@ -2759,7 +2747,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", + "Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", { "pluginId": "features", "scope": "common", @@ -2767,11 +2755,11 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"all\" | \"none\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; ui: readonly string[]; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 140 + "lineNumber": 145 }, "deprecated": false, "isRequired": true @@ -2788,7 +2776,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 146 + "lineNumber": 151 }, "deprecated": false }, @@ -2801,7 +2789,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 150 + "lineNumber": 155 }, "deprecated": false }, @@ -2817,7 +2805,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 154 + "lineNumber": 159 }, "deprecated": false }, @@ -2829,11 +2817,11 @@ "label": "category", "description": [], "signature": [ - "{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }" + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 158 + "lineNumber": 163 }, "deprecated": false }, @@ -2849,7 +2837,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 162 + "lineNumber": 167 }, "deprecated": false }, @@ -2865,7 +2853,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 166 + "lineNumber": 171 }, "deprecated": false }, @@ -2881,7 +2869,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 170 + "lineNumber": 175 }, "deprecated": false }, @@ -2897,7 +2885,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 174 + "lineNumber": 179 }, "deprecated": false }, @@ -2909,11 +2897,11 @@ "label": "privileges", "description": [], "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 178 + "lineNumber": 183 }, "deprecated": false }, @@ -2929,7 +2917,23 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 182 + "lineNumber": 187 + }, + "deprecated": false + }, + { + "parentPluginId": "features", + "id": "def-common.KibanaFeature.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 191 }, "deprecated": false }, @@ -2942,7 +2946,7 @@ "description": [], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 186 + "lineNumber": 195 }, "deprecated": false }, @@ -2954,11 +2958,11 @@ "label": "reserved", "description": [], "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 190 + "lineNumber": 199 }, "deprecated": false }, @@ -2981,7 +2985,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 194 + "lineNumber": 203 }, "deprecated": false, "children": [], @@ -3035,7 +3039,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"all\" | \"none\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; ui: readonly string[]; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -3076,7 +3080,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"all\" | \"none\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; ui: readonly string[]; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -3100,7 +3104,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"all\" | \"none\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; ui: readonly string[]; cases?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -3432,7 +3436,7 @@ "\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access." ], "signature": [ - "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + "{ rule?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; alert?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; } | undefined" ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", @@ -3440,6 +3444,24 @@ }, "deprecated": false }, + { + "parentPluginId": "features", + "id": "def-common.FeatureKibanaPrivileges.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nIf your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should\nbe unique identifiers for the owners of cases you want access to." + ], + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 135 + }, + "deprecated": false + }, { "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.savedObject", @@ -3454,7 +3476,7 @@ ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 110 + "lineNumber": 161 }, "deprecated": false }, @@ -3474,7 +3496,7 @@ ], "source": { "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "lineNumber": 153 + "lineNumber": 204 }, "deprecated": false } @@ -3672,6 +3694,24 @@ }, "deprecated": false }, + { + "parentPluginId": "features", + "id": "def-common.KibanaFeatureConfig.cases", + "type": "Object", + "tags": [], + "label": "cases", + "description": [ + "\nIf your feature grants access to specific case types, you can specify them here to control visibility based on the current space." + ], + "signature": [ + "readonly string[] | undefined" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 104 + }, + "deprecated": false + }, { "parentPluginId": "features", "id": "def-common.KibanaFeatureConfig.privileges", @@ -3704,7 +3744,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 113 + "lineNumber": 118 }, "deprecated": false }, @@ -3730,7 +3770,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 121 + "lineNumber": 126 }, "deprecated": false }, @@ -3748,7 +3788,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 126 + "lineNumber": 131 }, "deprecated": false }, @@ -3768,7 +3808,7 @@ ], "source": { "path": "x-pack/plugins/features/common/kibana_feature.ts", - "lineNumber": 131 + "lineNumber": 136 }, "deprecated": false } @@ -3859,7 +3899,7 @@ "section": "def-common.FeatureKibanaPrivileges", "text": "FeatureKibanaPrivileges" }, - ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"app\" | \"api\" | \"savedObject\">" + ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"cases\" | \"app\" | \"api\" | \"savedObject\">" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -3907,7 +3947,7 @@ "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." ], "signature": [ - "\"none\" | \"all\" | \"read\"" + "\"all\" | \"none\" | \"read\"" ], "source": { "path": "x-pack/plugins/features/common/sub_feature.ts", @@ -3961,7 +4001,13 @@ "\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": [ - "\"mutually_exclusive\" | \"independent\"" + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "text": "SubFeaturePrivilegeGroupType" + } ], "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 c536acd5f4997..5f60af1967dae 100644 --- a/api_docs/file_data_visualizer.json +++ b/api_docs/file_data_visualizer.json @@ -15,11 +15,11 @@ "label": "FileDataVisualizerPluginStart", "description": [], "signature": [ - "{ getFileDataVisualizerComponent: () => Promise>; getMaxBytesFormatted: () => string; }" + "{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }" ], "source": { "path": "x-pack/plugins/file_data_visualizer/public/plugin.ts", - "lineNumber": 33 + "lineNumber": 36 }, "deprecated": false, "lifecycle": "start", @@ -230,7 +230,7 @@ "label": "JobFieldType", "description": [], "signature": [ - "\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\"" + "\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"unknown\" | \"ip\" | \"geo_point\" | \"geo_shape\"" ], "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 406c5e440972a..80d3add483ffc 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -125,52 +125,7 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 25 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -186,9 +141,7 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 26 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -204,9 +157,7 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 27 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -222,9 +173,7 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 28 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -248,32 +197,7 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 29 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -289,9 +213,7 @@ "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 30 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -958,39 +880,7 @@ "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 17 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -1006,9 +896,7 @@ "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 18 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "fileUpload", @@ -1024,9 +912,7 @@ "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 19 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -1355,208 +1241,7 @@ "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", @@ -1839,13 +1524,12 @@ "label": "doc", "description": [], "signature": [ - "string | object | ", { "pluginId": "fileUpload", "scope": "common", "docId": "kibFileUploadPluginApi", - "section": "def-common.Doc", - "text": "Doc" + "section": "def-common.ImportDoc", + "text": "ImportDoc" } ], "source": { @@ -2299,14 +1983,7 @@ "label": "FormattedOverrides", "description": [], "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.InputOverrides", - "text": "InputOverrides" - }, - " & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" + "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 043dfcd16c2a7..1cbeaaa6e0656 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -14,7 +14,7 @@ "(packageInfo: T) => string" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts", + "path": "x-pack/plugins/fleet/public/services/pkg_key_from_package_info.ts", "lineNumber": 8 }, "deprecated": false, @@ -30,7 +30,7 @@ "T" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts", + "path": "x-pack/plugins/fleet/public/services/pkg_key_from_package_info.ts", "lineNumber": 9 }, "deprecated": false, @@ -52,7 +52,7 @@ "\nSupported routing state for the agent policy details page routes with deploy agents action" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 37 }, "deprecated": false, @@ -78,7 +78,7 @@ " | undefined] | undefined" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 39 }, "deprecated": false @@ -96,7 +96,7 @@ "\nSupported routing state for the agent policy details page routes with deploy agents action" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 29 }, "deprecated": false, @@ -122,7 +122,7 @@ " | undefined] | undefined" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 31 }, "deprecated": false @@ -140,7 +140,7 @@ "\nSupported routing state for the create package policy page routes" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 15 }, "deprecated": false, @@ -182,7 +182,7 @@ " | undefined]) | undefined" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 17 }, "deprecated": false @@ -208,7 +208,7 @@ " | undefined] | undefined" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 21 }, "deprecated": false @@ -226,7 +226,7 @@ "string | undefined" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 23 }, "deprecated": false @@ -411,7 +411,7 @@ "Extension point registration contract for Integration details Custom view" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 94 }, "deprecated": false, @@ -424,7 +424,7 @@ "label": "package", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 95 }, "deprecated": false @@ -440,7 +440,7 @@ "\"package-detail-custom\"" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 96 }, "deprecated": false @@ -453,7 +453,7 @@ "label": "component", "description": [], "signature": [ - "React.ExoticComponent<(", + "React.LazyExoticComponent>) | 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/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 97 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -523,7 +480,7 @@ "label": "PackageCustomExtensionComponentProps", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 87 }, "deprecated": false, @@ -538,7 +495,7 @@ "The package key value that should be used used for URLs" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 89 }, "deprecated": false @@ -555,101 +512,12 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "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" - }, - ">" + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 90 }, "deprecated": false @@ -667,7 +535,7 @@ "Extension point registration contract for Integration Policy Create views" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 76 }, "deprecated": false, @@ -680,7 +548,7 @@ "label": "package", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 77 }, "deprecated": false @@ -696,7 +564,7 @@ "\"package-policy-create\"" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 78 }, "deprecated": false @@ -709,31 +577,7 @@ "label": "component", "description": [], "signature": [ - "React.ExoticComponent<(", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.PackagePolicyCreateExtensionComponentProps", - "text": "PackagePolicyCreateExtensionComponentProps" - }, - " & React.RefAttributes>) | React.PropsWithChildren<", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.PackagePolicyCreateExtensionComponentProps", - "text": "PackagePolicyCreateExtensionComponentProps" - }, - ">> & { readonly _result: React.ComponentType<", + "React.LazyExoticComponent; }" + ">>" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 79 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -779,7 +604,7 @@ "label": "PackagePolicyCreateExtensionComponentProps", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 60 }, "deprecated": false, @@ -803,7 +628,7 @@ } ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 62 }, "deprecated": false @@ -829,37 +654,10 @@ "; }) => void" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 67 }, - "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/applications/fleet/types/ui_extensions.ts", - "lineNumber": 67 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -874,7 +672,7 @@ "Extension point registration contract for Integration Policy Edit views" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 48 }, "deprecated": false, @@ -887,7 +685,7 @@ "label": "package", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 49 }, "deprecated": false @@ -903,7 +701,7 @@ "\"package-policy-edit\"" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 50 }, "deprecated": false @@ -916,31 +714,7 @@ "label": "component", "description": [], "signature": [ - "React.ExoticComponent<(", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.PackagePolicyEditExtensionComponentProps", - "text": "PackagePolicyEditExtensionComponentProps" - }, - " & React.RefAttributes>) | React.PropsWithChildren<", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.PackagePolicyEditExtensionComponentProps", - "text": "PackagePolicyEditExtensionComponentProps" - }, - ">> & { readonly _result: React.ComponentType<", + "React.LazyExoticComponent; }" + ">>" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 51 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -986,7 +741,7 @@ "label": "PackagePolicyEditExtensionComponentProps", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 26 }, "deprecated": false, @@ -1010,7 +765,7 @@ } ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 28 }, "deprecated": false @@ -1034,7 +789,7 @@ } ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 30 }, "deprecated": false @@ -1060,37 +815,10 @@ ">; }) => void" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 39 }, - "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/applications/fleet/types/ui_extensions.ts", - "lineNumber": 39 - }, - "deprecated": false - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -1105,7 +833,7 @@ "Internal storage for registered UI Extension Points" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 16 }, "deprecated": false, @@ -1121,7 +849,7 @@ "any" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 17 }, "deprecated": false @@ -1167,7 +895,7 @@ } ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "lineNumber": 45 }, "deprecated": false, @@ -1202,7 +930,7 @@ ">" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 85 }, "deprecated": false, @@ -1237,7 +965,7 @@ ">" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 58 }, "deprecated": false, @@ -1272,7 +1000,7 @@ ">" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 24 }, "deprecated": false, @@ -1313,7 +1041,7 @@ } ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 101 }, "deprecated": false, @@ -1340,7 +1068,7 @@ ") => void" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "lineNumber": 13 }, "deprecated": false, @@ -1356,8 +1084,8 @@ "label": "pagePathGetters", "description": [], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 69 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 73 }, "deprecated": false, "children": [ @@ -1369,11 +1097,11 @@ "label": "base", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 75 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 79 }, "deprecated": false, "children": [], @@ -1387,11 +1115,11 @@ "label": "overview", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 76 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 80 }, "deprecated": false, "children": [], @@ -1405,11 +1133,11 @@ "label": "integrations", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 77 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 81 }, "deprecated": false, "children": [], @@ -1423,11 +1151,11 @@ "label": "integrations_all", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 78 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 82 }, "deprecated": false, "children": [], @@ -1441,11 +1169,11 @@ "label": "integrations_installed", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 79 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 83 }, "deprecated": false, "children": [], @@ -1461,11 +1189,11 @@ "signature": [ "({ pkgkey, integration }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 80 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 84 }, "deprecated": false, "children": [ @@ -1480,8 +1208,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 80 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 84 }, "deprecated": false, "isRequired": true @@ -1499,11 +1227,11 @@ "signature": [ "({ pkgkey, integration }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 82 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 88 }, "deprecated": false, "children": [ @@ -1518,8 +1246,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 82 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 88 }, "deprecated": false, "isRequired": true @@ -1537,11 +1265,11 @@ "signature": [ "({ pkgkey, integration }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 84 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 92 }, "deprecated": false, "children": [ @@ -1556,8 +1284,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 84 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 92 }, "deprecated": false, "isRequired": true @@ -1575,11 +1303,11 @@ "signature": [ "({ pkgkey, integration }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 86 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 96 }, "deprecated": false, "children": [ @@ -1594,8 +1322,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 86 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 96 }, "deprecated": false, "isRequired": true @@ -1613,11 +1341,11 @@ "signature": [ "({ packagePolicyId }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 88 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 100 }, "deprecated": false, "children": [ @@ -1632,8 +1360,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 88 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 100 }, "deprecated": false, "isRequired": true @@ -1649,11 +1377,11 @@ "label": "policies", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 90 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 104 }, "deprecated": false, "children": [], @@ -1667,11 +1395,11 @@ "label": "policies_list", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 91 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 105 }, "deprecated": false, "children": [], @@ -1687,11 +1415,11 @@ "signature": [ "({ policyId, tabId }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 92 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 106 }, "deprecated": false, "children": [ @@ -1706,8 +1434,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 92 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 106 }, "deprecated": false, "isRequired": true @@ -1725,11 +1453,11 @@ "signature": [ "({ policyId }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 93 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 110 }, "deprecated": false, "children": [ @@ -1744,8 +1472,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 93 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 110 }, "deprecated": false, "isRequired": true @@ -1763,11 +1491,11 @@ "signature": [ "({ pkgkey, integration }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 94 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 114 }, "deprecated": false, "children": [ @@ -1782,8 +1510,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 94 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 114 }, "deprecated": false, "isRequired": true @@ -1801,11 +1529,11 @@ "signature": [ "({ policyId, packagePolicyId }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 96 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 118 }, "deprecated": false, "children": [ @@ -1820,8 +1548,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 96 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 118 }, "deprecated": false, "isRequired": true @@ -1837,11 +1565,11 @@ "label": "fleet", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 98 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 122 }, "deprecated": false, "children": [], @@ -1857,11 +1585,11 @@ "signature": [ "({ kuery }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 99 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 123 }, "deprecated": false, "children": [ @@ -1876,8 +1604,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 99 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 123 }, "deprecated": false, "isRequired": true @@ -1895,11 +1623,11 @@ "signature": [ "({ agentId, tabId, logQuery }: ", "DynamicPagePathValues", - ") => string" + ") => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 100 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 127 }, "deprecated": false, "children": [ @@ -1914,8 +1642,8 @@ "DynamicPagePathValues" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 100 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 127 }, "deprecated": false, "isRequired": true @@ -1931,11 +1659,11 @@ "label": "fleet_enrollment_tokens", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 102 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 131 }, "deprecated": false, "children": [], @@ -1949,11 +1677,11 @@ "label": "data_streams", "description": [], "signature": [ - "() => string" + "() => [string, string]" ], "source": { - "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 103 + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "lineNumber": 132 }, "deprecated": false, "children": [], @@ -1972,7 +1700,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 51 + "lineNumber": 48 }, "deprecated": false, "children": [], @@ -1990,7 +1718,7 @@ ], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 56 + "lineNumber": 53 }, "deprecated": false, "children": [ @@ -2002,62 +1730,19 @@ "label": "registerExtension", "description": [], "signature": [ - "(extensionPoint: ", { "pluginId": "fleet", "scope": "public", "docId": "kibFleetPluginApi", - "section": "def-public.UIExtensionPoint", - "text": "UIExtensionPoint" - }, - ") => void" + "section": "def-public.UIExtensionRegistrationCallback", + "text": "UIExtensionRegistrationCallback" + } ], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 57 + "lineNumber": 54 }, - "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/applications/fleet/types/ui_extensions.ts", - "lineNumber": 13 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "fleet", @@ -2071,11 +1756,9 @@ ], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 58 + "lineNumber": 55 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "lifecycle": "start", @@ -2221,352 +1904,7 @@ "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 68 }, - "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": 263 - }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "fleet", @@ -2598,1065 +1936,63 @@ "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 + "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 + }, + { + "parentPluginId": "fleet", + "id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy", + "type": "Function", + "tags": [], + "label": "getFullAgentPolicy", + "description": [], + "signature": [ + "(soClient: Pick<", { - "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 + "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<", { - "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 - } - ] + "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 } ], "initialIsOpen": false @@ -3686,71 +2022,14 @@ "\nGet an Agent by id" ], "signature": [ - "(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" - }, - ">" + "typeof ", + "getAgentById" ], "source": { "path": "x-pack/plugins/fleet/server/services/index.ts", "lineNumber": 49 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "fleet", @@ -3912,93 +2191,33 @@ "string" ], "source": { - "path": "x-pack/plugins/fleet/server/services/index.ts", - "lineNumber": 60 - }, - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-server.AgentService.listAgents", - "type": "Function", - "tags": [], - "label": "listAgents", - "description": [ - "\nList agents" - ], - "signature": [ - "(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, - "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 + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 60 }, - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-server.AgentService.listAgents", + "type": "Function", + "tags": [], + "label": "listAgents", + "description": [ + "\nList agents" + ], + "signature": [ + "typeof ", + "getAgentsByKuery" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 64 + }, + "deprecated": false } ], "initialIsOpen": false @@ -4448,7 +2667,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 90 + "lineNumber": 91 }, "deprecated": false, "children": [ @@ -4470,7 +2689,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 91 + "lineNumber": 92 }, "deprecated": false }, @@ -4493,7 +2712,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 92 + "lineNumber": 93 }, "deprecated": false }, @@ -4516,7 +2735,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 93 + "lineNumber": 94 }, "deprecated": false }, @@ -4538,7 +2757,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 94 + "lineNumber": 95 }, "deprecated": false }, @@ -4561,7 +2780,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 96 }, "deprecated": false }, @@ -4584,7 +2803,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 96 + "lineNumber": 97 }, "deprecated": false } @@ -4738,36 +2957,11 @@ "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": 137 + "lineNumber": 138 }, "deprecated": false, "initialIsOpen": false @@ -4784,7 +2978,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/index.ts", - "lineNumber": 66 + "lineNumber": 83 }, "deprecated": false, "initialIsOpen": false @@ -4838,7 +3032,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 122 + "lineNumber": 123 }, "deprecated": false, "lifecycle": "setup", @@ -4855,7 +3049,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 160 + "lineNumber": 161 }, "deprecated": false, "children": [ @@ -4873,11 +3067,9 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 166 + "lineNumber": 167 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "fleet", @@ -4897,7 +3089,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 167 + "lineNumber": 168 }, "deprecated": false }, @@ -4919,7 +3111,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 168 + "lineNumber": 169 }, "deprecated": false }, @@ -4941,7 +3133,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 169 + "lineNumber": 170 }, "deprecated": false }, @@ -4959,7 +3151,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 173 + "lineNumber": 174 }, "deprecated": false }, @@ -4981,7 +3173,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 174 + "lineNumber": 175 }, "deprecated": false }, @@ -5007,92 +3199,9 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 179 + "lineNumber": 180 }, - "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": 179 - }, - "deprecated": false - } - ] + "deprecated": false }, { "parentPluginId": "fleet", @@ -5109,25 +3218,9 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 185 + "lineNumber": 186 }, - "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": 185 - }, - "deprecated": false - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -5421,177 +3514,46 @@ "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.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" - }, - "> | (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", - "lineNumber": 9 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.doesPackageHaveIntegrations.$1", - "type": "CompoundType", - "tags": [], - "label": "pkgInfo", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "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.EpmPackageAdditions", + "text": "EpmPackageAdditions" + }, + ">> | ", + { + "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", @@ -5693,25 +3620,6 @@ "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 }, { @@ -6349,7 +4257,13 @@ "label": "type", "description": [], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionType", + "text": "AgentActionType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -6530,7 +4444,14 @@ "label": "status", "description": [], "signature": [ - "\"active\" | \"inactive\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ValueOf", + "text": "ValueOf" + }, + "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", @@ -6668,7 +4589,13 @@ "label": "type", "description": [], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionType", + "text": "AgentActionType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -6850,7 +4777,13 @@ "label": "service", "description": [], "signature": [ - "\"kibana\" | \"elasticsearch\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ServiceName", + "text": "ServiceName" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -6866,21 +4799,12 @@ "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.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" + "section": "def-common.AssetType", + "text": "AssetType" } ], "source": { @@ -7234,7 +5158,15 @@ "label": "body", "description": [], "signature": [ - "{ description?: string | undefined; name: string; }" + "Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + ", \"description\" | \"name\">" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -7621,7 +5553,13 @@ "label": "installType", "description": [], "signature": [ - "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallType", + "text": "InstallType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -8078,39 +6016,13 @@ "label": "assets", "description": [], "signature": [ - "Record<\"kibana\", 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<\"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" - }, - "[]>>" + "section": "def-common.AssetsGroupedByServiceByType", + "text": "AssetsGroupedByServiceByType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -8203,7 +6115,7 @@ "label": "agents", "description": [], "signature": [ - "{ enabled: boolean; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; }" + "{ enabled: boolean; elasticsearch: { hosts?: string[] | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", @@ -8322,7 +6234,13 @@ "\nType" ], "signature": [ - "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentType", + "text": "AgentType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -10117,10 +8035,9 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryItem", - "text": "CategorySummaryItem" - }, - "[]" + "section": "def-common.CategorySummaryList", + "text": "CategorySummaryList" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -10461,121 +8378,32 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetInfoResponse", - "type": "Interface", - "tags": [], - "label": "GetInfoResponse", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 56 - }, - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetInfoResponse.response", - "type": "CompoundType", - "tags": [], - "label": "response", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "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" - }, - ">" + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -10885,10 +8713,9 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - }, - " & { id: string; }" + "section": "def-common.Output", + "text": "Output" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", @@ -11214,10 +9041,9 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageListItem", - "text": "PackageListItem" - }, - "[]" + "section": "def-common.PackageList", + "text": "PackageList" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -11636,7 +9462,7 @@ "label": "es_index_patterns", "description": [], "signature": [ - "{ [x: string]: string; }" + "Record" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -11678,7 +9504,13 @@ "label": "install_status", "description": [], "signature": [ - "\"installed\" | \"installing\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EpmPackageInstallStatus", + "text": "EpmPackageInstallStatus" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -11720,7 +9552,13 @@ "label": "install_source", "description": [], "signature": [ - "\"registry\" | \"upload\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallSource", + "text": "InstallSource" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -11878,7 +9716,13 @@ "label": "installType", "description": [], "signature": [ - "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallType", + "text": "InstallType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", @@ -12165,7 +10009,13 @@ "label": "type", "description": [], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionType", + "text": "AgentActionType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -14290,7 +12140,7 @@ "label": "id", "description": [], "signature": [ - "string | number" + "React.ReactText" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", @@ -14493,10 +12343,9 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - }, - " & { id: string; }" + "section": "def-common.Output", + "text": "Output" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", @@ -14528,7 +12377,15 @@ "label": "body", "description": [], "signature": [ - "{ has_seen_add_data_notice?: boolean | undefined; has_seen_fleet_migration_notice?: boolean | undefined; fleet_server_hosts?: string[] | undefined; }" + "Partial>" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", @@ -15365,7 +13222,13 @@ "label": "[RegistryVarsEntryKeys.type]", "description": [], "signature": [ - "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryVarType", + "text": "RegistryVarType" + } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16243,23 +14106,7 @@ "label": "AgentPolicyActionV7_9", "description": [], "signature": [ - "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" - }, - "; }; }" + "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", @@ -16276,23 +14123,7 @@ "label": "AgentPolicySOAttributes", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", @@ -16394,22 +14225,7 @@ "label": "ArchivePackage", "description": [], "signature": [ - { - "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\">" + "PackageSpecManifest & Pick" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16474,39 +14290,7 @@ "label": "AssetsGroupedByServiceByType", "description": [], "signature": [ - "Record<\"kibana\", 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<\"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" - }, - "[]>>" + "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16531,31 +14315,7 @@ "section": "def-common.KibanaAssetType", "text": "KibanaAssetType" }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 51 - }, - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetTypeToParts", - "type": "Type", - "tags": [], - "label": "AssetTypeToParts", - "description": [], - "signature": [ - "Record<", + ".dashboard | ", { "pluginId": "fleet", "scope": "common", @@ -16563,31 +14323,47 @@ "section": "def-common.KibanaAssetType", "text": "KibanaAssetType" }, - ", ", + ".visualization | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" }, - "[]> & Record<", + ".search | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" }, - ", ", + ".indexPattern | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]>" + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 51 + }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AssetTypeToParts", + "type": "Type", + "tags": [], + "label": "AssetTypeToParts", + "description": [], + "signature": [ + "Record & Record" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16652,14 +14428,7 @@ "label": "CategorySummaryList", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryItem", - "text": "CategorySummaryItem" - }, - "[]" + "CategorySummaryItem[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16775,22 +14544,7 @@ "label": "ElasticsearchAssetParts", "description": [], "signature": [ - { - "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" - }, - "; }" + "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16807,55 +14561,7 @@ "label": "ElasticsearchAssetTypeToParts", "description": [], "signature": [ - "{ 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" - }, - "[]; }" + "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -16954,17 +14660,7 @@ "label": "EsAssetReference", "description": [], "signature": [ - "Pick<", - "SavedObjectReference", - ", \"id\"> & { type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" - }, - "; }" + "Pick & { type: ElasticsearchAssetType; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17083,14 +14779,7 @@ "label": "GetAgentPoliciesResponseItem", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - }, - " & { agents?: number | undefined; }" + "AgentPolicy & { agents?: number | undefined; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -17124,15 +14813,7 @@ "label": "InputsOverride", "description": [], "signature": [ - "Partial<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInput", - "text": "NewPackagePolicyInput" - }, - "> & { vars?: (Record & { vars?: (Record; }" + "signature": [ + "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17304,6 +14975,23 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.INTEGRATIONS_PLUGIN_ID", + "type": "string", + "tags": [], + "label": "INTEGRATIONS_PLUGIN_ID", + "description": [], + "signature": [ + "\"integrations\"" + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/plugin.ts", + "lineNumber": 9 + }, + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.KibanaAssetParts", @@ -17312,22 +15000,7 @@ "label": "KibanaAssetParts", "description": [], "signature": [ - { - "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" - }, - "; }" + "AssetParts & { service: Extract; type: KibanaAssetType; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17344,17 +15017,7 @@ "label": "KibanaAssetReference", "description": [], "signature": [ - "Pick<", - "SavedObjectReference", - ", \"id\"> & { type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaSavedObjectType", - "text": "KibanaSavedObjectType" - }, - "; }" + "Pick & { type: KibanaSavedObjectType; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17371,71 +15034,7 @@ "label": "KibanaAssetTypeToParts", "description": [], "signature": [ - "{ 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" - }, - "[]; }" + "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; security_rule: KibanaAssetParts[]; ml_module: KibanaAssetParts[]; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17486,7 +15085,7 @@ "label": "NotInstalled", "description": [], "signature": [ - "T & { status: \"not_installed\"; }" + "T & { status: InstallationStatus['NotInstalled']; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17503,14 +15102,7 @@ "label": "Output", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - }, - " & { id: string; }" + "NewOutput & { id: string; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", @@ -17544,13 +15136,7 @@ "label": "OutputSOAttributes", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - } + "NewOutput" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", @@ -17615,9 +15201,7 @@ "label": "PackageAssetReference", "description": [], "signature": [ - "Pick<", - "SavedObjectReference", - ", \"id\"> & { type: \"epm-packages-assets\"; }" + "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17672,64 +15256,7 @@ "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", @@ -17746,14 +15273,7 @@ "label": "PackageList", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageListItem", - "text": "PackageListItem" - }, - "[]" + "PackageListItem[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -17770,7 +15290,7 @@ "label": "PackageListItem", "description": [], "signature": [ - "(Pick<", + "Pick<", { "pluginId": "fleet", "scope": "common", @@ -17778,7 +15298,7 @@ "section": "def-common.RegistryPackage", "text": "RegistryPackage" }, - ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"download\" | \"path\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ", + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ", "SavedObject", "<", { @@ -17788,7 +15308,7 @@ "section": "def-common.Installation", "text": "Installation" }, - ">; } & { integration?: string | undefined; id: string; }) | (Pick<", + ">; } & { integration?: string | undefined; id: string; } | Pick<", { "pluginId": "fleet", "scope": "common", @@ -17796,7 +15316,7 @@ "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; })" + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"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", @@ -17813,15 +15333,7 @@ "label": "PackagePolicyConfigRecord", "description": [], "signature": [ - "{ [x: string]: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecordEntry", - "text": "PackagePolicyConfigRecordEntry" - }, - "; }" + "{ [x: string]: PackagePolicyConfigRecordEntry; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", @@ -17838,31 +15350,7 @@ "label": "PackagePolicySOAttributes", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", @@ -17896,23 +15384,7 @@ "label": "PackagesGroupedByStatus", "description": [], "signature": [ - "{ 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" - }, - "; }" + "{ installed: PackageList; not_installed: PackageList; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -18099,22 +15571,7 @@ "label": "RegistryPackage", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecManifest", - "text": "PackageSpecManifest" - }, - " & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" + "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -18148,39 +15605,7 @@ "label": "RegistrySearchResult", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -18197,15 +15622,7 @@ "label": "RegistrySearchResults", "description": [], "signature": [ - "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\">[]" + "Pick[]" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -18273,7 +15690,7 @@ "label": "RequirementsByServiceName", "description": [], "signature": [ - "Record<\"kibana\", { version: string; }> | undefined" + "undefined | Record<\"kibana\", { version: string; }>" ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -18420,22 +15837,7 @@ "label": "UpdateAgentPolicyRequest", "description": [], "signature": [ - { - "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" - }, - "; }" + "GetOneAgentPolicyRequest & { body: NewAgentPolicy; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -18452,22 +15854,7 @@ "label": "UpdatePackagePolicyRequest", "description": [], "signature": [ - { - "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" - }, - "; }" + "GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }" ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", @@ -18484,13 +15871,7 @@ "label": "UpdatePackagePolicyResponse", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.CreatePackagePolicyResponse", - "text": "CreatePackagePolicyResponse" - } + "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 c69dc7718c2f2..a264a3f46736d 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": [ - "string | { path: string; prependBasePath: boolean; }" + "GlobalSearchProviderResultUrl" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -478,9 +478,7 @@ "path": "x-pack/plugins/global_search/public/types.ts", "lineNumber": 53 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -534,9 +532,7 @@ "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" ], "signature": [ - "Pick<", - "GlobalSearchProviderResult", - ", \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }" + "Pick & { url: string; }" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -555,15 +551,7 @@ "label": "GlobalSearchPluginSetup", "description": [], "signature": [ - "{ registerResultProvider: (provider: ", - { - "pluginId": "globalSearch", - "scope": "public", - "docId": "kibGlobalSearchPluginApi", - "section": "def-public.GlobalSearchResultProvider", - "text": "GlobalSearchResultProvider" - }, - ") => void; }" + "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" ], "source": { "path": "x-pack/plugins/global_search/public/types.ts", @@ -591,9 +579,7 @@ "section": "def-public.GlobalSearchFindOptions", "text": "GlobalSearchFindOptions" }, - ") => ", - "Observable", - "<", + ") => Observable<", "GlobalSearchBatchedResults", ">; getSearchableTypes: () => Promise; }" ], @@ -758,10 +744,7 @@ "text": "IUiSettingsClient" }, "; }; capabilities: ", - "Observable", - "<", - "Capabilities", - ">; }" + "Observable" ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", @@ -927,7 +910,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": [ - "string | { path: string; prependBasePath: boolean; }" + "GlobalSearchProviderResultUrl" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -1028,8 +1011,7 @@ ") => ", "Observable", "<", - "GlobalSearchProviderResult", - "[]>" + "GlobalSearchProviderResult" ], "source": { "path": "x-pack/plugins/global_search/server/types.ts", @@ -1121,32 +1103,7 @@ "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 140 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -1257,9 +1214,7 @@ "path": "x-pack/plugins/global_search/server/types.ts", "lineNumber": 57 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -1296,9 +1251,7 @@ "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" ], "signature": [ - "Pick<", - "GlobalSearchProviderResult", - ", \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }" + "Pick & { url: string; }" ], "source": { "path": "x-pack/plugins/global_search/common/types.ts", @@ -1317,33 +1270,19 @@ "label": "GlobalSearchPluginStart", "description": [], "signature": [ - "{ find: (params: ", - "GlobalSearchFindParams", - ", options: ", - { - "pluginId": "globalSearch", - "scope": "server", - "docId": "kibGlobalSearchPluginApi", - "section": "def-server.GlobalSearchFindOptions", - "text": "GlobalSearchFindOptions" - }, - ", request: ", + "{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", + "docId": "kibCorePluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ") => ", - "Observable", - "<", - "GlobalSearchBatchedResults", - ">; getSearchableTypes: (request: ", + ") => Observable; getSearchableTypes: (request: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", + "docId": "kibCorePluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, @@ -1365,15 +1304,7 @@ "label": "GlobalSearchPluginSetup", "description": [], "signature": [ - "{ registerResultProvider: (provider: ", - { - "pluginId": "globalSearch", - "scope": "server", - "docId": "kibGlobalSearchPluginApi", - "section": "def-server.GlobalSearchResultProvider", - "text": "GlobalSearchResultProvider" - }, - ") => void; }" + "{ registerResultProvider: (provider: 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 a1039beb8d3a2..b72c3d692769f 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": [ - "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>" + "IconType" ], "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": [ - "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>" + "IconType" ], "source": { "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", @@ -501,7 +501,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 161 + "lineNumber": 166 }, "deprecated": false, "initialIsOpen": false @@ -534,7 +534,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 158 + "lineNumber": 163 }, "deprecated": false, "initialIsOpen": false @@ -547,7 +547,7 @@ "label": "TutorialDirectoryHeaderLinkComponent", "description": [], "signature": [ - "React.FunctionComponent<{}>" + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", @@ -564,7 +564,7 @@ "label": "TutorialDirectoryNoticeComponent", "description": [], "signature": [ - "React.FunctionComponent<{}>" + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", @@ -581,7 +581,7 @@ "label": "TutorialModuleNoticeComponent", "description": [], "signature": [ - "React.FunctionComponent<{ moduleName: string; }>" + "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" ], "source": { "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", @@ -598,11 +598,17 @@ "label": "TutorialSetup", "description": [], "signature": [ - "{ 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; }" + "{ 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; }" ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 164 + "lineNumber": 169 }, "deprecated": false, "initialIsOpen": false @@ -873,7 +879,7 @@ "description": [], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 167 + "lineNumber": 175 }, "deprecated": false, "children": [ @@ -889,7 +895,25 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 168 + "lineNumber": 176 + }, + "deprecated": false + }, + { + "parentPluginId": "home", + "id": "def-public.HomePublicPluginSetup.addData", + "type": "Object", + "tags": [], + "label": "addData", + "description": [], + "signature": [ + "{ registerAddDataTab: (tab: ", + "AddDataTab", + ") => void; }" + ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 177 }, "deprecated": false }, @@ -921,7 +945,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 169 + "lineNumber": 178 }, "deprecated": false }, @@ -949,7 +973,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 176 + "lineNumber": 185 }, "deprecated": true, "references": [ @@ -964,7 +988,7 @@ "plugin": "apm", "link": { "path": "x-pack/plugins/apm/public/plugin.ts", - "lineNumber": 82 + "lineNumber": 85 } }, { @@ -989,7 +1013,7 @@ "description": [], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 178 + "lineNumber": 187 }, "deprecated": false, "children": [ @@ -1005,7 +1029,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 179 + "lineNumber": 188 }, "deprecated": false } @@ -1060,21 +1084,9 @@ "label": "SampleDataRegistrySetup", "description": [], "signature": [ - "{ registerSampleDataset: (specProvider: ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.SampleDatasetProvider", - "text": "SampleDatasetProvider" - }, - ") => void; getSampleDatasets: () => ", + "{ registerSampleDataset: (specProvider: 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", @@ -1112,7 +1124,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\" | \"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; } & {}>[]; }>[]; }>[]; }>; }>" + ") => 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; } & {}>[]; }>[]; }>[]; }>; }>" ], "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 9d4edf199ca27..91895dbe109c0 100644 --- a/api_docs/index_management.json +++ b/api_docs/index_management.json @@ -722,7 +722,7 @@ "description": [], "source": { "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 25 + "lineNumber": 23 }, "deprecated": false, "children": [ @@ -740,7 +740,7 @@ ], "source": { "path": "x-pack/plugins/index_management/server/plugin.ts", - "lineNumber": 26 + "lineNumber": 24 }, "deprecated": false } @@ -1262,7 +1262,7 @@ "label": "health", "description": [], "signature": [ - "\"green\" | \"yellow\" | \"red\"" + "ClusterStatus" ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", @@ -1491,7 +1491,7 @@ "label": "status", "description": [], "signature": [ - "\"GREEN\" | \"YELLOW\" | \"RED\"" + "HealthFromEs" ], "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 d7afa005cf2da..15f00324d585f 100644 --- a/api_docs/index_pattern_field_editor.json +++ b/api_docs/index_pattern_field_editor.json @@ -67,13 +67,15 @@ "label": "getDerivedStateFromProps", "description": [], "signature": [ - "(nextProps: ", - "FormatEditorProps", - "<{}>, state: ", - "FormatEditorState", - ") => { error: string | undefined; samples: ", - "Sample", - "[]; }" + "typeof ", + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.DefaultFormatEditor", + "text": "DefaultFormatEditor" + }, + ".getDerivedStateFromProps" ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", @@ -224,7 +226,7 @@ "\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\"" ], "signature": [ - "\"concrete\" | \"runtime\"" + "InternalFieldType" ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", @@ -592,42 +594,7 @@ "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 33 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "start", diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json index 77ca8b9505d99..9676ef7b4b9c3 100644 --- a/api_docs/index_pattern_management.json +++ b/api_docs/index_pattern_management.json @@ -799,9 +799,7 @@ "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", "lineNumber": 33 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false }, { "parentPluginId": "indexPatternManagement", @@ -906,54 +904,19 @@ "[]>; }; list: { getIndexPatternTags: (indexPattern: ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IIndexPattern", "text": "IIndexPattern" }, " | ", { "pluginId": "core", "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", + "docId": "kibCorePluginApi", "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 bb50bcdd072bd..8ff9ded3938e6 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -109,23 +109,7 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 16 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "infra", @@ -143,23 +127,7 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 19 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "infra", @@ -177,23 +145,7 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 21 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "infra", @@ -211,23 +163,7 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 23 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "infra", @@ -243,23 +179,7 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 24 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "infra", @@ -275,23 +195,7 @@ "path": "x-pack/plugins/infra/common/formatters/index.ts", "lineNumber": 25 }, - "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 - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -329,9 +233,7 @@ "label": "InfraRequestHandlerContext", "description": [], "signature": [ - "InfraMlRequestHandlerContext", - " & ", - "InfraSpacesRequestHandlerContext" + "InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext" ], "source": { "path": "x-pack/plugins/infra/server/types.ts", @@ -371,39 +273,7 @@ "path": "x-pack/plugins/infra/server/plugin.ts", "lineNumber": 76 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "setup", diff --git a/api_docs/inspector.json b/api_docs/inspector.json index f94e708c021c9..776e7869e4fb8 100644 --- a/api_docs/inspector.json +++ b/api_docs/inspector.json @@ -217,8 +217,7 @@ "docId": "kibCorePluginApi", "section": "def-public.OverlayRef", "text": "OverlayRef" - }, - "; }" + } ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", @@ -292,7 +291,8 @@ "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, - " extends EventEmitter" + " extends ", + "EventEmitter" ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", @@ -919,23 +919,7 @@ "label": "component", "description": [], "signature": [ - "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<", + "React.ComponentType<", { "pluginId": "inspector", "scope": "public", @@ -1231,13 +1215,7 @@ "label": "InspectorSession", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "OverlayRef" ], "source": { "path": "src/plugins/inspector/public/types.ts", @@ -1283,32 +1261,7 @@ "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 21 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "inspector", @@ -1369,37 +1322,7 @@ "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 37 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "inspector", @@ -1443,61 +1366,7 @@ "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 51 }, - "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 - } - ] + "deprecated": false } ], "lifecycle": "start", @@ -1533,7 +1402,8 @@ "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 1b5309235adde..33874c82ab07a 100644 --- a/api_docs/kibana_legacy.json +++ b/api_docs/kibana_legacy.json @@ -982,25 +982,6 @@ "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 }, { @@ -1019,7 +1000,7 @@ "section": "def-public.AngularHttpError", "text": "AngularHttpError" }, - ") => string" + ") => any" ], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", @@ -1203,8 +1184,6 @@ "lineNumber": 15 }, "deprecated": false, - "returnComment": [], - "children": [], "initialIsOpen": false }, { @@ -1842,7 +1821,7 @@ "label": "AngularHttpError", "description": [], "signature": [ - "angular.IHttpResponse<{ message: string; }>" + "IHttpResponse<{ message: string; }>" ], "source": { "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", @@ -1859,7 +1838,7 @@ "label": "createTopNavDirective", "description": [], "signature": [ - "angular.IDirectiveFactory | (string | angular.IDirectiveFactory)[]" + "angular.Injectable>" ], "source": { "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", @@ -1876,7 +1855,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", @@ -1893,7 +1872,7 @@ "label": "KbnAccessibleClickProvider", "description": [], "signature": [ - "angular.IDirectiveFactory | (string | angular.IDirectiveFactory)[]" + "angular.Injectable>" ], "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 98537d71d7b01..aa21e6090ea27 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -151,23 +151,7 @@ "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 122 }, - "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 - } - ] + "deprecated": false }, { "parentPluginId": "kibanaReact", @@ -547,7 +531,15 @@ "label": "getDerivedStateFromProps", "description": [], "signature": [ - "(nextProps: Props, prevState: State) => { value: [React.ReactText, React.ReactText] | undefined; prevValue: [React.ReactText, React.ReactText] | undefined; isValid: boolean; errorMessage: string; } | null" + "typeof ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.ValidatedDualRange", + "text": "ValidatedDualRange" + }, + ".getDerivedStateFromProps" ], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", @@ -1038,7 +1030,7 @@ "label": "KibanaContextProvider", "description": [], "signature": [ - "React.FunctionComponent<{ services?: {} | undefined; }>" + "React.FC<{ services?: {} | undefined; }>" ], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", @@ -1581,9 +1573,7 @@ "type": "CompoundType", "tags": [], "label": "ReactComp", - "description": [ - "A React component." - ], + "description": [], "signature": [ "React.ComponentType" ], @@ -1669,9 +1659,7 @@ "type": "CompoundType", "tags": [], "label": "node", - "description": [ - "to get a mount point for" - ], + "description": [], "signature": [ "React.ReactNode" ], @@ -2137,9 +2125,7 @@ "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", "lineNumber": 15 }, - "deprecated": false, - "returnComment": [], - "children": [] + "deprecated": false } ], "initialIsOpen": false @@ -2177,7 +2163,7 @@ "\nLabel for the button" ], "signature": [ - "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" + "React.ReactNode" ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", @@ -2195,7 +2181,7 @@ "\nIcon representing the field type.\nRecommend using FieldIcon" ], "signature": [ - "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" + "React.ReactNode" ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", @@ -2213,7 +2199,7 @@ "\nAn optional node to place inside and at the end of the