diff --git a/api_docs/actions.json b/api_docs/actions.json index f3f7f284c046..1a92e7270d4f 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -30,6 +30,7 @@ "description": [], "children": [ { + "id": "def-server.asHttpRequestExecutionSource.$1", "type": "Object", "label": "source", "isRequired": true, @@ -71,18 +72,13 @@ "description": [], "children": [ { + "id": "def-server.asSavedObjectExecutionSource.$1", "type": "Object", "label": "source", "isRequired": true, "signature": [ "Pick<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", ", \"type\" | \"id\">" ], "description": [], @@ -381,11 +377,12 @@ "type": "Function", "label": "renderParameterTemplates", "signature": [ - "((params: Params, variables: Record) => Params) | undefined" + "((params: Params, variables: Record, actionId?: string | undefined) => Params) | undefined" ], "description": [], "children": [ { + "id": "def-server.ActionType.renderParameterTemplates.$1", "type": "Uncategorized", "label": "params", "isRequired": true, @@ -395,10 +392,11 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 110 + "lineNumber": 111 } }, { + "id": "def-server.ActionType.renderParameterTemplates.$2", "type": "Object", "label": "variables", "isRequired": true, @@ -408,7 +406,21 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 110 + "lineNumber": 112 + } + }, + { + "id": "def-server.ActionType.renderParameterTemplates.$3", + "type": "string", + "label": "actionId", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 113 } } ], @@ -427,16 +439,10 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 111 + "lineNumber": 115 }, "signature": [ - { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.ExecutorType", - "text": "ExecutorType" - }, + "ExecutorType", "" ] } @@ -486,13 +492,7 @@ "lineNumber": 56 }, "signature": [ - { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.Services", - "text": "Services" - } + "Services" ] }, { @@ -616,10 +616,10 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", - "lineNumber": 34 + "lineNumber": 36 }, "signature": [ - "{ readonly documents: Record[]; }" + "{ readonly documents: Record[]; readonly indexOverride: string | null; }" ], "initialIsOpen": false }, @@ -661,7 +661,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", - "lineNumber": 46 + "lineNumber": 48 }, "signature": [ "{ readonly message: string; }" @@ -823,7 +823,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", - "lineNumber": 43 + "lineNumber": 54 }, "signature": [ "\".index\"" @@ -868,7 +868,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", - "lineNumber": 54 + "lineNumber": 56 }, "signature": [ "\".slack\"" @@ -992,6 +992,7 @@ "description": [], "children": [ { + "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", "label": "actionType", "isRequired": true, @@ -1008,7 +1009,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 85 + "lineNumber": 88 } } ], @@ -1016,13 +1017,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 79 + "lineNumber": 82 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 78 + "lineNumber": 81 }, "lifecycle": "setup", "initialIsOpen": true @@ -1044,6 +1045,7 @@ "description": [], "children": [ { + "id": "def-server.PluginStartContract.isActionTypeEnabled.$1", "type": "string", "label": "id", "isRequired": true, @@ -1053,11 +1055,11 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 90 + "lineNumber": 93 } }, { - "id": "def-server.PluginStartContract.isActionTypeEnabled.options", + "id": "def-server.PluginStartContract.isActionTypeEnabled.$2.options", "type": "Object", "label": "options", "tags": [], @@ -1065,19 +1067,19 @@ "children": [ { "tags": [], - "id": "def-server.PluginStartContract.isActionTypeEnabled.options.notifyUsage", + "id": "def-server.PluginStartContract.isActionTypeEnabled.$2.options.notifyUsage", "type": "boolean", "label": "notifyUsage", "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 90 + "lineNumber": 93 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 90 + "lineNumber": 93 } } ], @@ -1085,7 +1087,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 90 + "lineNumber": 93 } }, { @@ -1098,6 +1100,7 @@ "description": [], "children": [ { + "id": "def-server.PluginStartContract.isActionExecutable.$1", "type": "string", "label": "actionId", "isRequired": true, @@ -1107,10 +1110,11 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 92 + "lineNumber": 95 } }, { + "id": "def-server.PluginStartContract.isActionExecutable.$2", "type": "string", "label": "actionTypeId", "isRequired": true, @@ -1120,11 +1124,11 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 + "lineNumber": 96 } }, { - "id": "def-server.PluginStartContract.isActionExecutable.options", + "id": "def-server.PluginStartContract.isActionExecutable.$3.options", "type": "Object", "label": "options", "tags": [], @@ -1132,19 +1136,19 @@ "children": [ { "tags": [], - "id": "def-server.PluginStartContract.isActionExecutable.options.notifyUsage", + "id": "def-server.PluginStartContract.isActionExecutable.$3.options.notifyUsage", "type": "boolean", "label": "notifyUsage", "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 94 + "lineNumber": 97 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 94 + "lineNumber": 97 } } ], @@ -1152,7 +1156,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 91 + "lineNumber": 94 } }, { @@ -1181,6 +1185,7 @@ "description": [], "children": [ { + "id": "def-server.PluginStartContract.getActionsClientWithRequest.$1", "type": "Object", "label": "request", "isRequired": true, @@ -1197,7 +1202,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 96 + "lineNumber": 99 } } ], @@ -1205,7 +1210,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 96 + "lineNumber": 99 } }, { @@ -1234,6 +1239,7 @@ "description": [], "children": [ { + "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest.$1", "type": "Object", "label": "request", "isRequired": true, @@ -1250,7 +1256,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97 + "lineNumber": 100 } } ], @@ -1258,7 +1264,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97 + "lineNumber": 100 } }, { @@ -1269,7 +1275,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 98 + "lineNumber": 101 }, "signature": [ { @@ -1287,11 +1293,12 @@ "type": "Function", "label": "renderActionParameterTemplates", "signature": [ - " = Record>(actionTypeId: string, params: Params, variables: Record) => Params" + " = Record>(actionTypeId: string, actionId: string, params: Params, variables: Record) => Params" ], "description": [], "children": [ { + "id": "def-server.PluginStartContract.renderActionParameterTemplates.$1", "type": "string", "label": "actionTypeId", "isRequired": true, @@ -1301,10 +1308,25 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 100 + "lineNumber": 103 } }, { + "id": "def-server.PluginStartContract.renderActionParameterTemplates.$2", + "type": "string", + "label": "actionId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 104 + } + }, + { + "id": "def-server.PluginStartContract.renderActionParameterTemplates.$3", "type": "Uncategorized", "label": "params", "isRequired": true, @@ -1314,10 +1336,11 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 101 + "lineNumber": 105 } }, { + "id": "def-server.PluginStartContract.renderActionParameterTemplates.$4", "type": "Object", "label": "variables", "isRequired": true, @@ -1327,7 +1350,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 102 + "lineNumber": 106 } } ], @@ -1335,13 +1358,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 99 + "lineNumber": 102 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 89 + "lineNumber": 92 }, "lifecycle": "start", "initialIsOpen": true @@ -1350,6 +1373,38 @@ "common": { "classes": [], "functions": [ + { + "id": "def-common.buildAlertHistoryDocument", + "type": "Function", + "children": [ + { + "id": "def-common.buildAlertHistoryDocument.$1", + "type": "Object", + "label": "variables", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 14 + } + } + ], + "signature": [ + "(variables: Record) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; } | null" + ], + "description": [], + "label": "buildAlertHistoryDocument", + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 14 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-common.isActionTypeExecutorResult", "type": "Function", @@ -1360,6 +1415,7 @@ "description": [], "children": [ { + "id": "def-common.isActionTypeExecutorResult.$1", "type": "Unknown", "label": "result", "isRequired": true, @@ -1646,6 +1702,63 @@ ], "enums": [], "misc": [ + { + "tags": [], + "id": "def-common.ALERT_HISTORY_PREFIX", + "type": "string", + "label": "ALERT_HISTORY_PREFIX", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 10 + }, + "signature": [ + "\"kibana-alert-history-\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AlertHistoryDefaultIndexName", + "type": "string", + "label": "AlertHistoryDefaultIndexName", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AlertHistoryDocumentTemplate", + "type": "CompoundType", + "label": "AlertHistoryDocumentTemplate", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 73 + }, + "signature": [ + "Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; }> | null" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AlertHistoryEsIndexConnectorId", + "type": "string", + "label": "AlertHistoryEsIndexConnectorId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/alert_history_schema.ts", + "lineNumber": 12 + }, + "signature": [ + "\"preconfigured-alert-history-es-index\"" + ], + "initialIsOpen": false + }, { "id": "def-common.AsApiContract", "type": "Type", @@ -1669,7 +1782,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/common/index.ts", - "lineNumber": 10 + "lineNumber": 12 }, "signature": [ "\"/api/actions\"" diff --git a/api_docs/alerting.json b/api_docs/alerting.json index f6e37bafdedb..803047ef9237 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -26,13 +26,7 @@ }, "signature": [ "(consumer: string, alertType: string, handler: ", - { - "pluginId": "alerting", - "scope": "public", - "docId": "kibAlertingPluginApi", - "section": "def-public.AlertNavigationHandler", - "text": "AlertNavigationHandler" - }, + "AlertNavigationHandler", ") => void" ] }, @@ -48,13 +42,7 @@ }, "signature": [ "(consumer: string, handler: ", - { - "pluginId": "alerting", - "scope": "public", - "docId": "kibAlertingPluginApi", - "section": "def-public.AlertNavigationHandler", - "text": "AlertNavigationHandler" - }, + "AlertNavigationHandler", ") => void" ] } @@ -125,6 +113,7 @@ "description": [], "children": [ { + "id": "def-server.parseDuration.$1", "type": "string", "label": "duration", "isRequired": true, @@ -429,13 +418,7 @@ }, "signature": [ "() => Set<", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RegistryAlertType", - "text": "RegistryAlertType" - }, + "RegistryAlertType", ">" ] }, @@ -552,13 +535,7 @@ }, "signature": [ "(id: string) => Pick<", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertInstance", - "text": "AlertInstance" - }, + "AlertInstance", ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" ] } @@ -620,13 +597,7 @@ }, "signature": [ "{ params?: ", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertTypeParamsValidator", - "text": "AlertTypeParamsValidator" - }, + "AlertTypeParamsValidator", " | undefined; } | undefined" ] }, @@ -697,13 +668,7 @@ "lineNumber": 128 }, "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.ExecutorType", - "text": "ExecutorType" - }, + "ExecutorType", ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" ] } ], @@ -889,6 +854,7 @@ "description": [], "children": [ { + "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", "label": "alertType", "isRequired": true, @@ -942,13 +908,7 @@ }, "signature": [ "() => Set<", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RegistryAlertType", - "text": "RegistryAlertType" - }, + "RegistryAlertType", ">" ] }, @@ -978,6 +938,7 @@ "description": [], "children": [ { + "id": "def-server.PluginStartContract.getAlertsClientWithRequest.$1", "type": "Object", "label": "request", "isRequired": true, @@ -1116,7 +1077,7 @@ "section": "def-common.Alert", "text": "Alert" }, - ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ", + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"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\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: ({ 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<", { @@ -1180,7 +1141,7 @@ "lineNumber": 178 }, "signature": [ - "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"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\">>" ], "initialIsOpen": false }, @@ -1239,6 +1200,7 @@ "description": [], "children": [ { + "id": "def-common.getBuiltinActionGroups.$1", "type": "Object", "label": "customRecoveryGroup", "isRequired": false, @@ -1277,6 +1239,7 @@ "description": [], "children": [ { + "id": "def-common.getDurationNumberInItsUnit.$1", "type": "string", "label": "duration", "isRequired": true, @@ -1308,6 +1271,7 @@ "description": [], "children": [ { + "id": "def-common.getDurationUnitValue.$1", "type": "string", "label": "duration", "isRequired": true, @@ -1339,6 +1303,7 @@ "description": [], "children": [ { + "id": "def-common.isActionGroupDisabledForActionTypeId.$1", "type": "string", "label": "actionGroup", "isRequired": true, @@ -1352,6 +1317,7 @@ } }, { + "id": "def-common.isActionGroupDisabledForActionTypeId.$2", "type": "string", "label": "actionTypeId", "isRequired": true, @@ -1383,6 +1349,7 @@ "description": [], "children": [ { + "id": "def-common.parseDuration.$1", "type": "string", "label": "duration", "isRequired": true, @@ -1414,6 +1381,7 @@ "description": [], "children": [ { + "id": "def-common.validateDurationSchema.$1", "type": "string", "label": "duration", "isRequired": true, @@ -1445,6 +1413,7 @@ "description": [], "children": [ { + "id": "def-common.validateNotifyWhenType.$1", "type": "string", "label": "notifyWhen", "isRequired": true, @@ -1951,13 +1920,7 @@ "lineNumber": 47 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "SavedObjectAttributes" ] } ], @@ -3120,7 +3083,7 @@ "lineNumber": 78 }, "signature": [ - "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }" + "{ enabled: boolean; id: string; name: string; params: Params; actions: 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; }" ], "initialIsOpen": false }, diff --git a/api_docs/apm.json b/api_docs/apm.json index 7ddf4f2548d8..e3d8747d7b46 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -107,7 +107,10 @@ "section": "def-server.APMPluginSetup", "text": "APMPluginSetup" }, - ", void, object, object>" + ", void, ", + "APMPluginSetupDependencies", + ", ", + "APMPluginStartDependencies" ], "children": [ { @@ -120,6 +123,7 @@ "description": [], "children": [ { + "id": "def-server.APMPlugin.Unnamed.$1", "type": "Object", "label": "initContext", "isRequired": true, @@ -136,7 +140,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 61 + "lineNumber": 58 } } ], @@ -144,7 +148,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 61 + "lineNumber": 58 } }, { @@ -160,42 +164,19 @@ "section": "def-server.CoreSetup", "text": "CoreSetup" }, - ", plugins: { apmOss: ", - { - "pluginId": "apmOss", - "scope": "server", - "docId": "kibApmOssPluginApi", - "section": "def-server.APMOSSPluginSetup", - "text": "APMOSSPluginSetup" - }, - "; home: ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.HomeServerPluginSetup", - "text": "HomeServerPluginSetup" - }, - "; licensing: ", - { - "pluginId": "licensing", - "scope": "server", - "docId": "kibLicensingPluginApi", - "section": "def-server.LicensingPluginSetup", - "text": "LicensingPluginSetup" - }, - "; cloud?: ", - { - "pluginId": "cloud", - "scope": "server", - "docId": "kibCloudPluginApi", - "section": "def-server.CloudSetup", - "text": "CloudSetup" - } + "<", + "APMPluginStartDependencies", + ", unknown>, plugins: Pick<", + "APMPluginSetupDependencies", + ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"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" ], "description": [], "children": [ { + "id": "def-server.APMPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -207,274 +188,30 @@ "section": "def-server.CoreSetup", "text": "CoreSetup" }, - "" + "<", + "APMPluginStartDependencies", + ", unknown>" ], "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 66 + "lineNumber": 63 } }, { - "id": "def-server.APMPlugin.setup.plugins", + "id": "def-server.APMPlugin.setup.$2", "type": "Object", "label": "plugins", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.apmOss", - "type": "Object", - "label": "apmOss", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 68 - }, - "signature": [ - { - "pluginId": "apmOss", - "scope": "server", - "docId": "kibApmOssPluginApi", - "section": "def-server.APMOSSPluginSetup", - "text": "APMOSSPluginSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.home", - "type": "Object", - "label": "home", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 69 - }, - "signature": [ - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.HomeServerPluginSetup", - "text": "HomeServerPluginSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.licensing", - "type": "Object", - "label": "licensing", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 70 - }, - "signature": [ - { - "pluginId": "licensing", - "scope": "server", - "docId": "kibLicensingPluginApi", - "section": "def-server.LicensingPluginSetup", - "text": "LicensingPluginSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.cloud", - "type": "Object", - "label": "cloud", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 71 - }, - "signature": [ - { - "pluginId": "cloud", - "scope": "server", - "docId": "kibCloudPluginApi", - "section": "def-server.CloudSetup", - "text": "CloudSetup" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.usageCollection", - "type": "Object", - "label": "usageCollection", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 72 - }, - "signature": [ - "Pick<", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorSet", - "text": "CollectorSet" - }, - ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.taskManager", - "type": "CompoundType", - "label": "taskManager", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 73 - }, - "signature": [ - { - "pluginId": "taskManager", - "scope": "server", - "docId": "kibTaskManagerPluginApi", - "section": "def-server.TaskManagerSetupContract", - "text": "TaskManagerSetupContract" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.alerting", - "type": "Object", - "label": "alerting", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 74 - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.PluginSetupContract", - "text": "PluginSetupContract" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.actions", - "type": "Object", - "label": "actions", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 75 - }, - "signature": [ - { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.PluginSetupContract", - "text": "PluginSetupContract" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.observability", - "type": "Object", - "label": "observability", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 76 - }, - "signature": [ - { - "pluginId": "observability", - "scope": "server", - "docId": "kibObservabilityPluginApi", - "section": "def-server.ObservabilityPluginSetup", - "text": "ObservabilityPluginSetup" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.features", - "type": "Object", - "label": "features", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 77 - }, - "signature": [ - { - "pluginId": "features", - "scope": "server", - "docId": "kibFeaturesPluginApi", - "section": "def-server.PluginSetupContract", - "text": "PluginSetupContract" - } - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.security", - "type": "Object", - "label": "security", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 78 - }, - "signature": [ - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.SecurityPluginSetup", - "text": "SecurityPluginSetup" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.APMPlugin.setup.plugins.ml", - "type": "CompoundType", - "label": "ml", - "description": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 79 - }, - "signature": [ - { - "pluginId": "ml", - "scope": "server", - "docId": "kibMlPluginApi", - "section": "def-server.SharedServices", - "text": "SharedServices" - }, - " | undefined" - ] - } + "isRequired": true, + "signature": [ + "Pick<", + "APMPluginSetupDependencies", + ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">" ], + "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 67 + "lineNumber": 64 } } ], @@ -482,7 +219,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 65 + "lineNumber": 62 } }, { @@ -503,6 +240,7 @@ "description": [], "children": [ { + "id": "def-server.APMPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -518,7 +256,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 196 + "lineNumber": 208 } } ], @@ -526,7 +264,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 196 + "lineNumber": 208 } }, { @@ -542,13 +280,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 215 + "lineNumber": 227 } } ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 58 + "lineNumber": 48 }, "initialIsOpen": false } @@ -568,6 +306,7 @@ "description": [], "children": [ { + "id": "def-server.mergeConfigs.$1", "type": "Object", "label": "apmOssConfig", "isRequired": true, @@ -581,18 +320,13 @@ } }, { + "id": "def-server.mergeConfigs.$2", "type": "Object", "label": "apmConfig", "isRequired": true, "signature": [ "Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", - { - "pluginId": "apm", - "scope": "common", - "docId": "kibApmPluginApi", - "section": "def-common.SearchAggregatedTransactionSetting", - "text": "SearchAggregatedTransactionSetting" - }, + "SearchAggregatedTransactionSetting", "; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>" ], "description": [], @@ -611,7 +345,184 @@ "initialIsOpen": false } ], - "interfaces": [], + "interfaces": [ + { + "id": "def-server.APMRouteHandlerResources", + "type": "Interface", + "label": "APMRouteHandlerResources", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.request", + "type": "Object", + "label": "request", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 43 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.context", + "type": "Object", + "label": "context", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 44 + }, + "signature": [ + "ApmPluginRequestHandlerContext" + ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 45 + }, + "signature": [ + "{ query: { _inspect: boolean; }; }" + ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 50 + }, + "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; }" + ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.logger", + "type": "Object", + "label": "logger", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 51 + }, + "signature": [ + "Logger" + ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.core", + "type": "Object", + "label": "core", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 52 + }, + "signature": [ + "{ setup: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "; start: () => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ">; }" + ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.plugins", + "type": "Object", + "label": "plugins", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 56 + }, + "signature": [ + "{ data: { setup: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginSetup", + "text": "DataPluginSetup" + }, + "; start: () => Promise<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">; }; features: { setup: ", + { + "pluginId": "features", + "scope": "server", + "docId": "kibFeaturesPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + }, + "; start: () => Promise<", + { + "pluginId": "features", + "scope": "server", + "docId": "kibFeaturesPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + }, + ">; }; apmOss: { setup: ", + { + "pluginId": "apmOss", + "scope": "server", + "docId": "kibApmOssPluginApi", + "section": "def-server.APMOSSPluginSetup", + "text": "APMOSSPluginSetup" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 42 + }, + "initialIsOpen": false + } + ], "enums": [ { "id": "def-server.ProcessorEvent", @@ -642,6 +553,30 @@ ], "initialIsOpen": false }, + { + "id": "def-server.APMServerRouteRepository", + "type": "Type", + "label": "APMServerRouteRepository", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts", + "lineNumber": 60 + }, + "signature": [ + "ServerRouteRepository; } & { \"GET /api/apm/index_pattern/dynamic\": ", + "ServerRoute", + "<\"GET /api/apm/index_pattern/dynamic\", undefined, APMRouteHandlerResources, { dynamicIndexPattern: ", + "IndexPatternTitleAndFields" + ], + "initialIsOpen": false + }, { "id": "def-server.APMXPackConfig", "type": "Type", @@ -656,6 +591,21 @@ "{ 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; }" ], "initialIsOpen": false + }, + { + "id": "def-server.InspectResponse", + "type": "Type", + "label": "InspectResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 23 + }, + "signature": [ + "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" + ], + "initialIsOpen": false } ], "objects": [], @@ -673,19 +623,13 @@ "label": "config$", "description": [], "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 49 + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 48 }, "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': ", - { - "pluginId": "apm", - "scope": "common", - "docId": "kibApmPluginApi", - "section": "def-common.SearchAggregatedTransactionSetting", - "text": "SearchAggregatedTransactionSetting" - }, + "SearchAggregatedTransactionSetting", "; 'xpack.apm.metricsInterval': number; }>" ] }, @@ -696,18 +640,12 @@ "label": "getApmIndices", "description": [], "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 50 + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 49 }, "signature": [ "() => Promise<", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.ApmIndicesConfig", - "text": "ApmIndicesConfig" - }, + "ApmIndicesConfig", ">" ] }, @@ -718,8 +656,8 @@ "label": "createApmEventClient", "description": [], "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 51 + "path": "x-pack/plugins/apm/server/types.ts", + "lineNumber": 50 }, "signature": [ "(params: { debug?: boolean | undefined; request: ", @@ -731,21 +669,9 @@ "text": "KibanaRequest" }, "; context: ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.ApmPluginRequestHandlerContext", - "text": "ApmPluginRequestHandlerContext" - }, + "ApmPluginRequestHandlerContext", "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<", "InferSearchResponseOf", " +### Interfaces + + ### Enums diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json index 389cf7672661..69dc62ceff4c 100644 --- a/api_docs/apm_oss.json +++ b/api_docs/apm_oss.json @@ -60,6 +60,7 @@ "type": "Function", "children": [ { + "id": "def-server.createDjangoAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -73,6 +74,7 @@ } }, { + "id": "def-server.createDjangoAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -104,6 +106,7 @@ "type": "Function", "children": [ { + "id": "def-server.createDotNetAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -117,6 +120,7 @@ } }, { + "id": "def-server.createDotNetAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -148,6 +152,7 @@ "type": "Function", "children": [ { + "id": "def-server.createFlaskAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -161,6 +166,7 @@ } }, { + "id": "def-server.createFlaskAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -192,6 +198,7 @@ "type": "Function", "children": [ { + "id": "def-server.createGoAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -205,6 +212,7 @@ } }, { + "id": "def-server.createGoAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -236,6 +244,7 @@ "type": "Function", "children": [ { + "id": "def-server.createJavaAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -249,6 +258,7 @@ } }, { + "id": "def-server.createJavaAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -280,6 +290,7 @@ "type": "Function", "children": [ { + "id": "def-server.createJsAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -311,6 +322,7 @@ "type": "Function", "children": [ { + "id": "def-server.createNodeAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -324,6 +336,7 @@ } }, { + "id": "def-server.createNodeAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -355,6 +368,7 @@ "type": "Function", "children": [ { + "id": "def-server.createPhpAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -368,6 +382,7 @@ } }, { + "id": "def-server.createPhpAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -399,6 +414,7 @@ "type": "Function", "children": [ { + "id": "def-server.createRackAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -412,6 +428,7 @@ } }, { + "id": "def-server.createRackAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, @@ -443,6 +460,7 @@ "type": "Function", "children": [ { + "id": "def-server.createRailsAgentInstructions.$1", "type": "string", "label": "apmServerUrl", "isRequired": true, @@ -456,6 +474,7 @@ } }, { + "id": "def-server.createRailsAgentInstructions.$2", "type": "string", "label": "secretToken", "isRequired": true, diff --git a/api_docs/banners.json b/api_docs/banners.json index 46c827ab4776..15fe714af200 100644 --- a/api_docs/banners.json +++ b/api_docs/banners.json @@ -146,7 +146,7 @@ "lineNumber": 13 }, "signature": [ - "\"disabled\" | \"header\"" + "\"top\" | \"disabled\"" ], "initialIsOpen": false } diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json index 99d37a0c9acb..b3b251d2c49b 100644 --- a/api_docs/bfetch.json +++ b/api_docs/bfetch.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.split.$1", "type": "string", "label": "delimiter", "isRequired": true, @@ -80,13 +81,7 @@ }, "signature": [ "(params: ", - { - "pluginId": "bfetch", - "scope": "public", - "docId": "kibBfetchPluginApi", - "section": "def-public.FetchStreamingParams", - "text": "FetchStreamingParams" - }, + "FetchStreamingParams", ") => { xhr: XMLHttpRequest; stream: ", "Observable", "; }" @@ -104,13 +99,7 @@ }, "signature": [ "(params: ", - { - "pluginId": "bfetch", - "scope": "public", - "docId": "kibBfetchPluginApi", - "section": "def-public.StreamingBatchedFunctionParams", - "text": "StreamingBatchedFunctionParams" - }, + "StreamingBatchedFunctionParams", ") => ", { "pluginId": "bfetch", @@ -395,6 +384,7 @@ "description": [], "children": [ { + "id": "def-common.ItemBuffer.Unnamed.$1", "type": "Object", "label": "params", "isRequired": true, @@ -447,6 +437,7 @@ ], "children": [ { + "id": "def-common.ItemBuffer.write.$1", "type": "Uncategorized", "label": "item", "isRequired": true, @@ -545,6 +536,7 @@ "description": [], "children": [ { + "id": "def-common.TimedItemBuffer.Unnamed.$1", "type": "Object", "label": "params", "isRequired": true, @@ -582,6 +574,7 @@ "description": [], "children": [ { + "id": "def-common.TimedItemBuffer.write.$1", "type": "Uncategorized", "label": "item", "isRequired": true, @@ -648,6 +641,7 @@ "type": "Function", "children": [ { + "id": "def-common.createBatchedFunction.$1", "type": "Object", "label": "params", "isRequired": true, @@ -702,6 +696,7 @@ "type": "Function", "children": [ { + "id": "def-common.normalizeError.$1", "type": "Any", "label": "err", "isRequired": true, @@ -749,6 +744,7 @@ "type": "Function", "children": [ { + "id": "def-common.removeLeadingSlash.$1", "type": "string", "label": "text", "isRequired": true, @@ -1068,6 +1064,7 @@ "description": [], "children": [ { + "id": "def-common.StreamingResponseHandler.getResponseStream.$1", "type": "Uncategorized", "label": "payload", "isRequired": true, diff --git a/api_docs/canvas.json b/api_docs/canvas.json index 70d3fa06bf2e..e4b56ae0d6aa 100644 --- a/api_docs/canvas.json +++ b/api_docs/canvas.json @@ -31,21 +31,9 @@ "text": "CoreStart" }, " & ", - { - "pluginId": "canvas", - "scope": "public", - "docId": "kibCanvasPluginApi", - "section": "def-public.CanvasStartDeps", - "text": "CanvasStartDeps" - }, + "CanvasStartDeps", " & { canvas: ", - { - "pluginId": "canvas", - "scope": "public", - "docId": "kibCanvasPluginApi", - "section": "def-public.CanvasServices", - "text": "CanvasServices" - }, + "CanvasServices", "; }; }" ] } @@ -72,7 +60,7 @@ ], "source": { "path": "x-pack/plugins/canvas/public/plugin.tsx", - "lineNumber": 63 + "lineNumber": 65 }, "signature": [ "CanvasApi" @@ -88,7 +76,7 @@ "description": [], "source": { "path": "x-pack/plugins/canvas/public/plugin.tsx", - "lineNumber": 64 + "lineNumber": 66 }, "signature": [ "void" diff --git a/api_docs/cases.json b/api_docs/cases.json index 8ac2fb86061b..71538a0ad5d4 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -31,13 +31,7 @@ }, "signature": [ "() => ", - { - "pluginId": "cases", - "scope": "server", - "docId": "kibCasesPluginApi", - "section": "def-server.CasesClient", - "text": "CasesClient" - } + "CasesClient" ] } ], diff --git a/api_docs/charts.json b/api_docs/charts.json index 70bf2166de7c..9bc9b559cee6 100644 --- a/api_docs/charts.json +++ b/api_docs/charts.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.ColorPicker.$1", "type": "Object", "label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n}", "isRequired": true, @@ -46,6 +47,7 @@ ], "children": [ { + "id": "def-public.createColorPalette.$1", "type": "number", "label": "num", "isRequired": true, @@ -72,6 +74,7 @@ "type": "Function", "children": [ { + "id": "def-public.CurrentTime.$1", "type": "CompoundType", "label": "{ isDarkMode, domainEnd }", "isRequired": true, @@ -105,6 +108,7 @@ "type": "Function", "children": [ { + "id": "def-public.Endzones.$1", "type": "CompoundType", "label": "{\n isDarkMode,\n domainStart,\n domainEnd,\n interval,\n domainMin,\n domainMax,\n hideTooltips = true,\n isFullBin = false,\n}", "isRequired": true, @@ -136,6 +140,7 @@ "type": "Function", "children": [ { + "id": "def-public.getAdjustedInterval.$1", "type": "Array", "label": "xValues", "isRequired": true, @@ -149,6 +154,7 @@ } }, { + "id": "def-public.getAdjustedInterval.$2", "type": "number", "label": "esValue", "isRequired": true, @@ -162,6 +168,7 @@ } }, { + "id": "def-public.getAdjustedInterval.$3", "type": "CompoundType", "label": "esUnit", "isRequired": true, @@ -175,6 +182,7 @@ } }, { + "id": "def-public.getAdjustedInterval.$4", "type": "string", "label": "timeZone", "isRequired": true, @@ -208,6 +216,7 @@ "type": "Function", "children": [ { + "id": "def-public.getBrushFromChartBrushEventFn.$1", "type": "Object", "label": "table", "isRequired": true, @@ -227,6 +236,7 @@ } }, { + "id": "def-public.getBrushFromChartBrushEventFn.$2", "type": "CompoundType", "label": "xAccessor", "isRequired": true, @@ -280,6 +290,7 @@ "type": "Function", "children": [ { + "id": "def-public.getFilterFromChartClickEventFn.$1", "type": "Object", "label": "table", "isRequired": true, @@ -299,6 +310,7 @@ } }, { + "id": "def-public.getFilterFromChartClickEventFn.$2", "type": "CompoundType", "label": "xAccessor", "isRequired": true, @@ -313,6 +325,7 @@ } }, { + "id": "def-public.getFilterFromChartClickEventFn.$3", "type": "Object", "label": "splitSeriesAccessorFnMap", "isRequired": false, @@ -328,6 +341,7 @@ } }, { + "id": "def-public.getFilterFromChartClickEventFn.$4", "type": "CompoundType", "label": "splitChartAccessor", "isRequired": false, @@ -343,6 +357,7 @@ } }, { + "id": "def-public.getFilterFromChartClickEventFn.$5", "type": "boolean", "label": "negate", "isRequired": true, @@ -391,6 +406,7 @@ "type": "Function", "children": [ { + "id": "def-public.getFilterFromSeriesFn.$1", "type": "Object", "label": "table", "isRequired": true, @@ -456,6 +472,7 @@ "description": [], "children": [ { + "id": "def-public.getHeatmapColors.$1", "type": "Any", "label": "value", "isRequired": true, @@ -469,6 +486,7 @@ } }, { + "id": "def-public.getHeatmapColors.$2", "type": "string", "label": "colorSchemaName", "isRequired": true, @@ -510,6 +528,7 @@ "type": "Function", "children": [ { + "id": "def-public.renderEndzoneTooltip.$1", "type": "number", "label": "xInterval", "isRequired": false, @@ -523,6 +542,7 @@ } }, { + "id": "def-public.renderEndzoneTooltip.$2", "type": "number", "label": "domainStart", "isRequired": false, @@ -536,6 +556,7 @@ } }, { + "id": "def-public.renderEndzoneTooltip.$3", "type": "number", "label": "domainEnd", "isRequired": false, @@ -549,6 +570,7 @@ } }, { + "id": "def-public.renderEndzoneTooltip.$4", "type": "Function", "label": "formatter", "isRequired": false, @@ -562,6 +584,7 @@ } }, { + "id": "def-public.renderEndzoneTooltip.$5", "type": "boolean", "label": "renderValue", "isRequired": true, @@ -1743,13 +1766,13 @@ "tags": [], "children": [ { - "id": "def-public.vislibColorMaps.[ColorSchemas.Blues]", + "id": "def-public.vislibColorMaps.ColorSchemas.Blues", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Blues].id", + "id": "def-public.vislibColorMaps.ColorSchemas.Blues.id", "type": "string", "label": "id", "description": [], @@ -1770,7 +1793,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Blues].label", + "id": "def-public.vislibColorMaps.ColorSchemas.Blues.label", "type": "string", "label": "label", "description": [], @@ -1781,7 +1804,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Blues].value", + "id": "def-public.vislibColorMaps.ColorSchemas.Blues.value", "type": "Array", "label": "value", "description": [], @@ -1804,13 +1827,13 @@ } }, { - "id": "def-public.vislibColorMaps.[ColorSchemas.Greens]", + "id": "def-public.vislibColorMaps.ColorSchemas.Greens", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Greens].id", + "id": "def-public.vislibColorMaps.ColorSchemas.Greens.id", "type": "string", "label": "id", "description": [], @@ -1831,7 +1854,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Greens].label", + "id": "def-public.vislibColorMaps.ColorSchemas.Greens.label", "type": "string", "label": "label", "description": [], @@ -1842,7 +1865,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Greens].value", + "id": "def-public.vislibColorMaps.ColorSchemas.Greens.value", "type": "Array", "label": "value", "description": [], @@ -1863,13 +1886,13 @@ } }, { - "id": "def-public.vislibColorMaps.[ColorSchemas.Greys]", + "id": "def-public.vislibColorMaps.ColorSchemas.Greys", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Greys].id", + "id": "def-public.vislibColorMaps.ColorSchemas.Greys.id", "type": "string", "label": "id", "description": [], @@ -1890,7 +1913,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Greys].label", + "id": "def-public.vislibColorMaps.ColorSchemas.Greys.label", "type": "string", "label": "label", "description": [], @@ -1901,7 +1924,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Greys].value", + "id": "def-public.vislibColorMaps.ColorSchemas.Greys.value", "type": "Array", "label": "value", "description": [], @@ -1922,13 +1945,13 @@ } }, { - "id": "def-public.vislibColorMaps.[ColorSchemas.Reds]", + "id": "def-public.vislibColorMaps.ColorSchemas.Reds", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Reds].id", + "id": "def-public.vislibColorMaps.ColorSchemas.Reds.id", "type": "string", "label": "id", "description": [], @@ -1949,7 +1972,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Reds].label", + "id": "def-public.vislibColorMaps.ColorSchemas.Reds.label", "type": "string", "label": "label", "description": [], @@ -1960,7 +1983,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.Reds].value", + "id": "def-public.vislibColorMaps.ColorSchemas.Reds.value", "type": "Array", "label": "value", "description": [], @@ -1981,13 +2004,13 @@ } }, { - "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed]", + "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].id", + "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.id", "type": "string", "label": "id", "description": [], @@ -2008,7 +2031,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].label", + "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label", "type": "string", "label": "label", "description": [], @@ -2019,7 +2042,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].value", + "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.value", "type": "Array", "label": "value", "description": [], @@ -2040,13 +2063,13 @@ } }, { - "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed]", + "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].id", + "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.id", "type": "string", "label": "id", "description": [], @@ -2067,7 +2090,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].label", + "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label", "type": "string", "label": "label", "description": [], @@ -2078,7 +2101,7 @@ }, { "tags": [], - "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].value", + "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.value", "type": "Array", "label": "value", "description": [], diff --git a/api_docs/cloud.json b/api_docs/cloud.json index 28364d79367d..1ac97f2fac5b 100644 --- a/api_docs/cloud.json +++ b/api_docs/cloud.json @@ -19,7 +19,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 17 + "lineNumber": 18 }, "signature": [ "string | undefined" @@ -27,13 +27,13 @@ }, { "tags": [], - "id": "def-public.CloudConfigType.resetPasswordUrl", + "id": "def-public.CloudConfigType.cname", "type": "string", - "label": "resetPasswordUrl", + "label": "cname", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 18 + "lineNumber": 19 }, "signature": [ "string | undefined" @@ -41,13 +41,13 @@ }, { "tags": [], - "id": "def-public.CloudConfigType.deploymentUrl", + "id": "def-public.CloudConfigType.base_url", "type": "string", - "label": "deploymentUrl", + "label": "base_url", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 19 + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -55,13 +55,41 @@ }, { "tags": [], - "id": "def-public.CloudConfigType.accountUrl", + "id": "def-public.CloudConfigType.profile_url", "type": "string", - "label": "accountUrl", + "label": "profile_url", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 20 + "lineNumber": 21 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudConfigType.deployment_url", + "type": "string", + "label": "deployment_url", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 22 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudConfigType.organization_url", + "type": "string", + "label": "organization_url", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 23 }, "signature": [ "string | undefined" @@ -70,7 +98,7 @@ ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 16 + "lineNumber": 17 }, "initialIsOpen": false } @@ -93,7 +121,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 32 + "lineNumber": 35 }, "signature": [ "string | undefined" @@ -101,13 +129,13 @@ }, { "tags": [], - "id": "def-public.CloudSetup.cloudDeploymentUrl", + "id": "def-public.CloudSetup.cname", "type": "string", - "label": "cloudDeploymentUrl", + "label": "cname", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 33 + "lineNumber": 36 }, "signature": [ "string | undefined" @@ -115,24 +143,27 @@ }, { "tags": [], - "id": "def-public.CloudSetup.isCloudEnabled", - "type": "boolean", - "label": "isCloudEnabled", + "id": "def-public.CloudSetup.baseUrl", + "type": "string", + "label": "baseUrl", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 34 - } + "lineNumber": 37 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-public.CloudSetup.resetPasswordUrl", + "id": "def-public.CloudSetup.deploymentUrl", "type": "string", - "label": "resetPasswordUrl", + "label": "deploymentUrl", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 35 + "lineNumber": 38 }, "signature": [ "string | undefined" @@ -140,22 +171,47 @@ }, { "tags": [], - "id": "def-public.CloudSetup.accountUrl", + "id": "def-public.CloudSetup.profileUrl", "type": "string", - "label": "accountUrl", + "label": "profileUrl", "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 36 + "lineNumber": 39 }, "signature": [ "string | undefined" ] + }, + { + "tags": [], + "id": "def-public.CloudSetup.organizationUrl", + "type": "string", + "label": "organizationUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 40 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudSetup.isCloudEnabled", + "type": "boolean", + "label": "isCloudEnabled", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 41 + } } ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 31 + "lineNumber": 34 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/core.json b/api_docs/core.json index cb416cba8007..9695aaebdd31 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -41,7 +41,7 @@ "description": [], "children": [ { - "id": "def-public.ToastsApi.Unnamed.deps", + "id": "def-public.ToastsApi.Unnamed.$1.deps", "type": "Object", "label": "deps", "tags": [], @@ -49,7 +49,7 @@ "children": [ { "tags": [], - "id": "def-public.ToastsApi.Unnamed.deps.uiSettings", + "id": "def-public.ToastsApi.Unnamed.$1.deps.uiSettings", "type": "Object", "label": "uiSettings", "description": [], @@ -136,6 +136,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.add.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -186,6 +187,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.remove.$1", "type": "CompoundType", "label": "toastOrId", "isRequired": true, @@ -250,6 +252,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.addInfo.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -271,6 +274,7 @@ } }, { + "id": "def-public.ToastsApi.addInfo.$2", "type": "Object", "label": "options", "isRequired": false, @@ -337,6 +341,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.addSuccess.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -358,6 +363,7 @@ } }, { + "id": "def-public.ToastsApi.addSuccess.$2", "type": "Object", "label": "options", "isRequired": false, @@ -424,6 +430,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.addWarning.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -445,6 +452,7 @@ } }, { + "id": "def-public.ToastsApi.addWarning.$2", "type": "Object", "label": "options", "isRequired": false, @@ -511,6 +519,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.addDanger.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -532,6 +541,7 @@ } }, { + "id": "def-public.ToastsApi.addDanger.$2", "type": "Object", "label": "options", "isRequired": false, @@ -590,6 +600,7 @@ ], "children": [ { + "id": "def-public.ToastsApi.addError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -605,6 +616,7 @@ } }, { + "id": "def-public.ToastsApi.addError.$2", "type": "Object", "label": "options", "isRequired": true, @@ -777,6 +789,7 @@ "description": [], "children": [ { + "id": "def-public.AsyncPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -797,6 +810,7 @@ } }, { + "id": "def-public.AsyncPlugin.setup.$2", "type": "Uncategorized", "label": "plugins", "isRequired": true, @@ -835,6 +849,7 @@ "description": [], "children": [ { + "id": "def-public.AsyncPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -854,6 +869,7 @@ } }, { + "id": "def-public.AsyncPlugin.start.$2", "type": "Uncategorized", "label": "plugins", "isRequired": true, @@ -1010,7 +1026,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 207 + "lineNumber": 210 }, "signature": [ { @@ -1032,7 +1048,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 209 + "lineNumber": 212 }, "signature": [ { @@ -1054,7 +1070,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 211 + "lineNumber": 214 }, "signature": [ { @@ -1076,7 +1092,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 213 + "lineNumber": 216 }, "signature": [ { @@ -1098,7 +1114,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 215 + "lineNumber": 218 }, "signature": [ { @@ -1122,7 +1138,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 222 + "lineNumber": 225 }, "signature": [ "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" @@ -1138,7 +1154,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 226 + "lineNumber": 229 }, "signature": [ { @@ -1154,7 +1170,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 205 + "lineNumber": 208 }, "initialIsOpen": false }, @@ -1179,7 +1195,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 252 + "lineNumber": 255 }, "signature": [ { @@ -1201,7 +1217,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 254 + "lineNumber": 257 }, "signature": [ { @@ -1223,7 +1239,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 256 + "lineNumber": 259 }, "signature": [ { @@ -1245,7 +1261,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 258 + "lineNumber": 261 }, "signature": [ { @@ -1267,7 +1283,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 260 + "lineNumber": 263 }, "signature": [ { @@ -1289,7 +1305,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 262 + "lineNumber": 265 }, "signature": [ { @@ -1311,7 +1327,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 264 + "lineNumber": 267 }, "signature": [ { @@ -1333,7 +1349,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 266 + "lineNumber": 269 }, "signature": [ { @@ -1355,7 +1371,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 268 + "lineNumber": 271 }, "signature": [ { @@ -1377,7 +1393,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 270 + "lineNumber": 273 }, "signature": [ { @@ -1389,6 +1405,28 @@ } ] }, + { + "tags": [], + "id": "def-public.CoreStart.deprecations", + "type": "Object", + "label": "deprecations", + "description": [ + "{@link DeprecationsServiceStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 275 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.DeprecationsServiceStart", + "text": "DeprecationsServiceStart" + } + ] + }, { "tags": [ "deprecated" @@ -1401,7 +1439,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 277 + "lineNumber": 282 }, "signature": [ "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" @@ -1410,7 +1448,105 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 250 + "lineNumber": 253 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DeprecationsServiceStart", + "type": "Interface", + "label": "DeprecationsServiceStart", + "description": [ + "\nDeprecationsService provides methods to fetch domain deprecation details from\nthe Kibana server.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.DeprecationsServiceStart.getAllDeprecations", + "type": "Function", + "label": "getAllDeprecations", + "description": [ + "\nGrabs deprecations details for all domains." + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 24 + }, + "signature": [ + "() => Promise<", + "DomainDeprecationDetails", + "[]>" + ] + }, + { + "tags": [], + "id": "def-public.DeprecationsServiceStart.getDeprecations", + "type": "Function", + "label": "getDeprecations", + "description": [ + "\nGrabs deprecations for a specific domain.\n" + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 30 + }, + "signature": [ + "(domainId: string) => Promise<", + "DomainDeprecationDetails", + "[]>" + ] + }, + { + "tags": [], + "id": "def-public.DeprecationsServiceStart.isDeprecationResolvable", + "type": "Function", + "label": "isDeprecationResolvable", + "description": [ + "\nReturns a boolean if the provided deprecation can be automatically resolvable.\n" + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 36 + }, + "signature": [ + "(details: ", + "DomainDeprecationDetails", + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-public.DeprecationsServiceStart.resolveDeprecation", + "type": "Function", + "label": "resolveDeprecation", + "description": [ + "\nCalls the correctiveActions.api to automatically resolve the depprecation.\n" + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 42 + }, + "signature": [ + "(details: ", + "DomainDeprecationDetails", + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ResolveDeprecationResponse", + "text": "ResolveDeprecationResponse" + }, + ">" + ] + } + ], + "source": { + "path": "src/core/public/deprecations/deprecations_service.ts", + "lineNumber": 20 }, "initialIsOpen": false }, @@ -1431,7 +1567,7 @@ "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 302 + "lineNumber": 349 } }, { @@ -1442,7 +1578,7 @@ "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 303 + "lineNumber": 350 } }, { @@ -1453,16 +1589,16 @@ "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 304 + "lineNumber": 351 }, "signature": [ - "{ readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: string; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; }; readonly addData: string; readonly kibana: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly luceneQuerySyntax: string; readonly queryDsl: string; readonly kueryQuerySyntax: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record; readonly ml: Record; readonly transforms: Record; readonly visualize: Record; readonly apis: Readonly<{ createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putWatch: string; updateTransform: string; }>; readonly observability: Record; readonly alerting: Record; readonly maps: Record; readonly monitoring: Record; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record; readonly ccs: Record; readonly plugins: Record; readonly snapshotRestore: Record; readonly ingest: Record; }" + "{ readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: { readonly mapping: string; }; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; }; readonly addData: string; readonly kibana: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly luceneQuerySyntax: string; readonly queryDsl: string; readonly kueryQuerySyntax: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record; readonly ml: Record; readonly transforms: Record; readonly visualize: Record; readonly apis: Readonly<{ createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putWatch: string; simulatePipeline: string; updateTransform: string; }>; readonly observability: Record; readonly alerting: Record; readonly maps: Record; readonly monitoring: Record; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record; readonly ccs: Record; readonly plugins: Record; readonly snapshotRestore: Record; readonly ingest: Record; }" ] } ], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 301 + "lineNumber": 348 }, "initialIsOpen": false }, @@ -1874,21 +2010,9 @@ }, "signature": [ "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"validation\"> & ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.UserProvidedValues", - "text": "UserProvidedValues" - }, + "UiSettingsParams", + ", \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"validation\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\"> & ", + "UserProvidedValues", ">>" ] }, @@ -2174,6 +2298,7 @@ ], "children": [ { + "id": "def-public.OverlayBannersStart.add.$1", "type": "Function", "label": "mount", "isRequired": true, @@ -2194,6 +2319,7 @@ } }, { + "id": "def-public.OverlayBannersStart.add.$2", "type": "number", "label": "priority", "isRequired": false, @@ -2230,6 +2356,7 @@ ], "children": [ { + "id": "def-public.OverlayBannersStart.remove.$1", "type": "string", "label": "id", "isRequired": true, @@ -2274,6 +2401,7 @@ ], "children": [ { + "id": "def-public.OverlayBannersStart.replace.$1", "type": "string", "label": "id", "isRequired": false, @@ -2289,6 +2417,7 @@ } }, { + "id": "def-public.OverlayBannersStart.replace.$2", "type": "Function", "label": "mount", "isRequired": true, @@ -2309,6 +2438,7 @@ } }, { + "id": "def-public.OverlayBannersStart.replace.$3", "type": "number", "label": "priority", "isRequired": false, @@ -2409,7 +2539,7 @@ }, { "tags": [], - "id": "def-public.OverlayFlyoutOpenOptions.'data-test-subj'", + "id": "def-public.OverlayFlyoutOpenOptions.datatestsubj", "type": "string", "label": "'data-test-subj'", "description": [], @@ -2502,6 +2632,7 @@ ], "children": [ { + "id": "def-public.OverlayFlyoutStart.open.$1", "type": "Function", "label": "mount", "isRequired": true, @@ -2522,6 +2653,7 @@ } }, { + "id": "def-public.OverlayFlyoutStart.open.$2", "type": "Object", "label": "options", "isRequired": false, @@ -2639,7 +2771,7 @@ }, { "tags": [], - "id": "def-public.OverlayModalConfirmOptions.'data-test-subj'", + "id": "def-public.OverlayModalConfirmOptions.datatestsubj", "type": "string", "label": "'data-test-subj'", "description": [], @@ -2741,7 +2873,7 @@ }, { "tags": [], - "id": "def-public.OverlayModalOpenOptions.'data-test-subj'", + "id": "def-public.OverlayModalOpenOptions.datatestsubj", "type": "string", "label": "'data-test-subj'", "description": [], @@ -2820,6 +2952,7 @@ ], "children": [ { + "id": "def-public.OverlayModalStart.open.$1", "type": "Function", "label": "mount", "isRequired": true, @@ -2840,6 +2973,7 @@ } }, { + "id": "def-public.OverlayModalStart.open.$2", "type": "Object", "label": "options", "isRequired": false, @@ -2897,6 +3031,7 @@ ], "children": [ { + "id": "def-public.OverlayModalStart.openConfirm.$1", "type": "CompoundType", "label": "message", "isRequired": true, @@ -2918,6 +3053,7 @@ } }, { + "id": "def-public.OverlayModalStart.openConfirm.$2", "type": "Object", "label": "options", "isRequired": false, @@ -3265,6 +3401,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3285,6 +3422,7 @@ } }, { + "id": "def-public.Plugin.setup.$2", "type": "Uncategorized", "label": "plugins", "isRequired": true, @@ -3323,6 +3461,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3342,6 +3481,7 @@ } }, { + "id": "def-public.Plugin.start.$2", "type": "Uncategorized", "label": "plugins", "isRequired": true, @@ -3541,13 +3681,7 @@ "lineNumber": 78 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, + "SavedObjectError", " | undefined" ] }, @@ -3580,13 +3714,7 @@ "lineNumber": 82 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ] }, @@ -3603,13 +3731,7 @@ "lineNumber": 84 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -5334,13 +5456,7 @@ "lineNumber": 68 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.DeprecationSettings", - "text": "DeprecationSettings" - }, + "DeprecationSettings", " | undefined" ] }, @@ -5371,29 +5487,11 @@ "lineNumber": 81 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.ImageValidation", - "text": "ImageValidation" - }, + "ImageValidation", " | ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.StringValidationRegex", - "text": "StringValidationRegex" - }, + "StringValidationRegex", " | ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.StringValidationRegexString", - "text": "StringValidationRegexString" - }, + "StringValidationRegexString", " | undefined" ] }, @@ -5661,7 +5759,22 @@ "lineNumber": 102 }, "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; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | 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; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ResolveDeprecationResponse", + "type": "Type", + "label": "ResolveDeprecationResponse", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/deprecations/deprecations_client.ts", + "lineNumber": 18 + }, + "signature": [ + "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" ], "initialIsOpen": false }, @@ -5772,7 +5885,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 236 + "lineNumber": 239 }, "signature": [ "() => Promise<[", @@ -6385,6 +6498,7 @@ "description": [], "children": [ { + "id": "def-server.ElasticsearchConfig.Unnamed.$1", "type": "Object", "label": "rawConfig", "isRequired": true, @@ -6452,6 +6566,7 @@ "description": [], "children": [ { + "id": "def-server.LegacyClusterClient.Unnamed.$1", "type": "CompoundType", "label": "config", "isRequired": true, @@ -6471,6 +6586,7 @@ } }, { + "id": "def-server.LegacyClusterClient.Unnamed.$2", "type": "Object", "label": "log", "isRequired": true, @@ -6484,6 +6600,7 @@ } }, { + "id": "def-server.LegacyClusterClient.Unnamed.$3", "type": "string", "label": "type", "isRequired": true, @@ -6497,6 +6614,7 @@ } }, { + "id": "def-server.LegacyClusterClient.Unnamed.$4", "type": "Function", "label": "getAuthHeaders", "isRequired": true, @@ -6528,6 +6646,7 @@ "type": "Function", "children": [ { + "id": "def-server.LegacyClusterClient.callAsInternalUser.$1", "type": "string", "label": "endpoint", "isRequired": true, @@ -6541,6 +6660,7 @@ } }, { + "id": "def-server.LegacyClusterClient.callAsInternalUser.$2", "type": "Object", "label": "clientParams", "isRequired": true, @@ -6554,6 +6674,7 @@ } }, { + "id": "def-server.LegacyClusterClient.callAsInternalUser.$3", "type": "Object", "label": "options", "isRequired": false, @@ -6660,6 +6781,7 @@ ], "children": [ { + "id": "def-server.LegacyClusterClient.asScoped.$1", "type": "CompoundType", "label": "request", "isRequired": false, @@ -6741,6 +6863,7 @@ "description": [], "children": [ { + "id": "def-server.LegacyElasticsearchErrorHelpers.isNotAuthorizedError.$1", "type": "Any", "label": "error", "isRequired": true, @@ -6779,6 +6902,7 @@ "description": [], "children": [ { + "id": "def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -6792,6 +6916,7 @@ } }, { + "id": "def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -6859,6 +6984,7 @@ "description": [], "children": [ { + "id": "def-server.LegacyScopedClusterClient.Unnamed.$1", "type": "Function", "label": "internalAPICaller", "isRequired": true, @@ -6878,6 +7004,7 @@ } }, { + "id": "def-server.LegacyScopedClusterClient.Unnamed.$2", "type": "Function", "label": "scopedAPICaller", "isRequired": true, @@ -6897,6 +7024,7 @@ } }, { + "id": "def-server.LegacyScopedClusterClient.Unnamed.$3", "type": "CompoundType", "label": "headers", "isRequired": false, @@ -6944,6 +7072,7 @@ ], "children": [ { + "id": "def-server.LegacyScopedClusterClient.callAsInternalUser.$1", "type": "string", "label": "endpoint", "isRequired": true, @@ -6959,6 +7088,7 @@ } }, { + "id": "def-server.LegacyScopedClusterClient.callAsInternalUser.$2", "type": "Object", "label": "clientParams", "isRequired": true, @@ -6974,6 +7104,7 @@ } }, { + "id": "def-server.LegacyScopedClusterClient.callAsInternalUser.$3", "type": "Object", "label": "options", "isRequired": false, @@ -7025,6 +7156,7 @@ ], "children": [ { + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$1", "type": "string", "label": "endpoint", "isRequired": true, @@ -7040,6 +7172,7 @@ } }, { + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$2", "type": "Object", "label": "clientParams", "isRequired": true, @@ -7055,6 +7188,7 @@ } }, { + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$3", "type": "Object", "label": "options", "isRequired": false, @@ -7323,6 +7457,7 @@ "description": [], "children": [ { + "id": "def-server.AsyncPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -7339,10 +7474,11 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 269 + "lineNumber": 274 } }, { + "id": "def-server.AsyncPlugin.setup.$2", "type": "Uncategorized", "label": "plugins", "isRequired": true, @@ -7352,7 +7488,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 269 + "lineNumber": 274 } } ], @@ -7360,7 +7496,7 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 269 + "lineNumber": 274 } }, { @@ -7381,6 +7517,7 @@ "description": [], "children": [ { + "id": "def-server.AsyncPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -7396,10 +7533,11 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 270 + "lineNumber": 276 } }, { + "id": "def-server.AsyncPlugin.start.$2", "type": "Uncategorized", "label": "plugins", "isRequired": true, @@ -7409,7 +7547,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 270 + "lineNumber": 276 } } ], @@ -7417,7 +7555,7 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 270 + "lineNumber": 276 } }, { @@ -7433,13 +7571,13 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 271 + "lineNumber": 278 } } ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 263 + "lineNumber": 268 }, "initialIsOpen": false }, @@ -7556,6 +7694,7 @@ ], "children": [ { + "id": "def-server.CapabilitiesSetup.registerProvider.$1", "type": "Function", "label": "provider", "isRequired": true, @@ -7602,6 +7741,7 @@ ], "children": [ { + "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", "type": "Function", "label": "switcher", "isRequired": true, @@ -7668,13 +7808,7 @@ "text": "ResolveCapabilitiesOptions" }, " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - }, + "Capabilities", ">" ], "description": [ @@ -7682,6 +7816,7 @@ ], "children": [ { + "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", "type": "Object", "label": "request", "isRequired": true, @@ -7702,6 +7837,7 @@ } }, { + "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", "type": "Object", "label": "options", "isRequired": false, @@ -7755,7 +7891,9 @@ "type": "Function", "label": "rename", "signature": [ - "(oldKey: string, newKey: string) => ", + "(oldKey: string, newKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", "ConfigDeprecation" ], "description": [ @@ -7763,6 +7901,7 @@ ], "children": [ { + "id": "def-server.ConfigDeprecationFactory.rename.$1", "type": "string", "label": "oldKey", "isRequired": true, @@ -7772,10 +7911,11 @@ "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 63 + "lineNumber": 80 } }, { + "id": "def-server.ConfigDeprecationFactory.rename.$2", "type": "string", "label": "newKey", "isRequired": true, @@ -7785,7 +7925,23 @@ "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 63 + "lineNumber": 80 + } + }, + { + "id": "def-server.ConfigDeprecationFactory.rename.$3", + "type": "Object", + "label": "details", + "isRequired": false, + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 80 } } ], @@ -7793,7 +7949,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 63 + "lineNumber": 80 } }, { @@ -7801,7 +7957,9 @@ "type": "Function", "label": "renameFromRoot", "signature": [ - "(oldKey: string, newKey: string, silent?: boolean | undefined) => ", + "(oldKey: string, newKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", "ConfigDeprecation" ], "description": [ @@ -7809,6 +7967,7 @@ ], "children": [ { + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", "type": "string", "label": "oldKey", "isRequired": true, @@ -7818,10 +7977,11 @@ "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 79 + "lineNumber": 96 } }, { + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", "type": "string", "label": "newKey", "isRequired": true, @@ -7831,20 +7991,23 @@ "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 79 + "lineNumber": 96 } }, { - "type": "CompoundType", - "label": "silent", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", + "type": "Object", + "label": "details", "isRequired": false, "signature": [ - "boolean | undefined" + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" ], "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 79 + "lineNumber": 96 } } ], @@ -7852,7 +8015,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 79 + "lineNumber": 96 } }, { @@ -7860,7 +8023,9 @@ "type": "Function", "label": "unused", "signature": [ - "(unusedKey: string) => ", + "(unusedKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", "ConfigDeprecation" ], "description": [ @@ -7868,6 +8033,7 @@ ], "children": [ { + "id": "def-server.ConfigDeprecationFactory.unused.$1", "type": "string", "label": "unusedKey", "isRequired": true, @@ -7877,7 +8043,23 @@ "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 92 + "lineNumber": 109 + } + }, + { + "id": "def-server.ConfigDeprecationFactory.unused.$2", + "type": "Object", + "label": "details", + "isRequired": false, + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 109 } } ], @@ -7885,7 +8067,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 92 + "lineNumber": 109 } }, { @@ -7893,7 +8075,9 @@ "type": "Function", "label": "unusedFromRoot", "signature": [ - "(unusedKey: string) => ", + "(unusedKey: string, details?: Partial<", + "DeprecatedConfigDetails", + "> | undefined) => ", "ConfigDeprecation" ], "description": [ @@ -7901,6 +8085,7 @@ ], "children": [ { + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", "type": "string", "label": "unusedKey", "isRequired": true, @@ -7910,7 +8095,23 @@ "description": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 108 + "lineNumber": 125 + } + }, + { + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", + "type": "Object", + "label": "details", + "isRequired": false, + "signature": [ + "Partial<", + "DeprecatedConfigDetails", + "> | undefined" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 125 } } ], @@ -7918,13 +8119,13 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 108 + "lineNumber": 125 } } ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 50 + "lineNumber": 67 }, "initialIsOpen": false }, @@ -8002,7 +8203,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 462 + "lineNumber": 466 }, "signature": [ { @@ -8024,7 +8225,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 464 + "lineNumber": 468 }, "signature": [ { @@ -8046,7 +8247,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 466 + "lineNumber": 470 }, "signature": [ { @@ -8068,7 +8269,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 468 + "lineNumber": 472 }, "signature": [ { @@ -8099,7 +8300,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 473 + "lineNumber": 477 }, "signature": [ { @@ -8121,7 +8322,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 475 + "lineNumber": 479 }, "signature": [ { @@ -8143,7 +8344,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 477 + "lineNumber": 481 }, "signature": [ { @@ -8165,7 +8366,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 479 + "lineNumber": 483 }, "signature": [ { @@ -8187,7 +8388,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 481 + "lineNumber": 485 }, "signature": [ { @@ -8209,7 +8410,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 483 + "lineNumber": 487 }, "signature": [ { @@ -8221,6 +8422,28 @@ } ] }, + { + "tags": [], + "id": "def-server.CoreSetup.deprecations", + "type": "Object", + "label": "deprecations", + "description": [ + "{@link DeprecationsServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 489 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsServiceSetup", + "text": "DeprecationsServiceSetup" + } + ] + }, { "tags": [], "id": "def-server.CoreSetup.getStartServices", @@ -8231,7 +8454,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 485 + "lineNumber": 491 }, "signature": [ { @@ -8247,7 +8470,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 460 + "lineNumber": 464 }, "initialIsOpen": false }, @@ -8272,7 +8495,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 508 + "lineNumber": 514 }, "signature": [ { @@ -8294,7 +8517,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 510 + "lineNumber": 516 }, "signature": [ { @@ -8316,7 +8539,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 512 + "lineNumber": 518 }, "signature": [ { @@ -8338,7 +8561,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 514 + "lineNumber": 520 }, "signature": [ { @@ -8360,7 +8583,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 516 + "lineNumber": 522 }, "signature": [ { @@ -8382,7 +8605,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 518 + "lineNumber": 524 }, "signature": [ { @@ -8397,7 +8620,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 506 + "lineNumber": 512 }, "initialIsOpen": false }, @@ -8853,6 +9076,75 @@ }, "initialIsOpen": false }, + { + "id": "def-server.DeprecationsDetails", + "type": "Interface", + "label": "DeprecationsDetails", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.DeprecationsDetails.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 20 + } + }, + { + "tags": [], + "id": "def-server.DeprecationsDetails.level", + "type": "CompoundType", + "label": "level", + "description": [ + "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 27 + }, + "signature": [ + "\"warning\" | \"critical\" | \"fetch_error\"" + ] + }, + { + "tags": [], + "id": "def-server.DeprecationsDetails.documentationUrl", + "type": "string", + "label": "documentationUrl", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 29 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.DeprecationsDetails.correctiveActions", + "type": "Object", + "label": "correctiveActions", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 31 + }, + "signature": [ + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps?: string[] | undefined; }" + ] + } + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + }, { "id": "def-server.DeprecationSettings", "type": "Interface", @@ -8897,6 +9189,47 @@ }, "initialIsOpen": false }, + { + "id": "def-server.DeprecationsServiceSetup", + "type": "Interface", + "label": "DeprecationsServiceSetup", + "description": [ + "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" + ], + "tags": [ + "gmail", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "type": "Function", + "label": "registerDeprecations", + "description": [], + "source": { + "path": "src/core/server/deprecations/deprecations_service.ts", + "lineNumber": 104 + }, + "signature": [ + "(deprecationContext: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + }, + ") => void" + ] + } + ], + "source": { + "path": "src/core/server/deprecations/deprecations_service.ts", + "lineNumber": 103 + }, + "initialIsOpen": false + }, { "id": "def-server.DiscoveredPlugin", "type": "Interface", @@ -9314,6 +9647,62 @@ }, "initialIsOpen": false }, + { + "id": "def-server.GetDeprecationsContext", + "type": "Interface", + "label": "GetDeprecationsContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.GetDeprecationsContext.esClient", + "type": "Object", + "label": "esClient", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 61 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ] + }, + { + "tags": [], + "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "type": "Object", + "label": "savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 62 + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + ] + } + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 60 + }, + "initialIsOpen": false + }, { "id": "def-server.GetResponse", "type": "Interface", @@ -9854,6 +10243,7 @@ ], "children": [ { + "id": "def-server.IContextContainer.registerContext.$1", "type": "Uncategorized", "label": "pluginOpaqueId", "isRequired": true, @@ -9869,6 +10259,7 @@ } }, { + "id": "def-server.IContextContainer.registerContext.$2", "type": "Uncategorized", "label": "contextName", "isRequired": true, @@ -9884,6 +10275,7 @@ } }, { + "id": "def-server.IContextContainer.registerContext.$3", "type": "Function", "label": "provider", "isRequired": true, @@ -9947,19 +10339,14 @@ "text": "CustomHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - } + "KibanaResponse" ], "description": [ "\nCreate a new handler function pre-wired to context for the plugin.\n" ], "children": [ { + "id": "def-server.IContextContainer.createHandler.$1", "type": "Uncategorized", "label": "pluginOpaqueId", "isRequired": true, @@ -9975,6 +10362,7 @@ } }, { + "id": "def-server.IContextContainer.createHandler.$2", "type": "Function", "label": "handler", "isRequired": true, @@ -10005,13 +10393,7 @@ "text": "CustomHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - } + "KibanaResponse" ], "description": [ "- Handler function to pass context object to." @@ -10446,14 +10828,8 @@ }, "signature": [ "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"validation\">>>" + "UiSettingsParams", + ", \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"validation\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\">>>" ] }, { @@ -10502,13 +10878,7 @@ }, "signature": [ "() => Promise>>" ] }, @@ -12387,7 +12757,7 @@ "children": [ { "tags": [], - "id": "def-server.LegacyElasticsearchError.[code]", + "id": "def-server.LegacyElasticsearchError.code", "type": "string", "label": "[code]", "description": [], @@ -12406,116 +12776,6 @@ }, "initialIsOpen": false }, - { - "id": "def-server.LegacyServiceSetupDeps", - "type": "Interface", - "label": "LegacyServiceSetupDeps", - "description": [], - "tags": [ - "public", - "deprecated" - ], - "children": [ - { - "tags": [], - "id": "def-server.LegacyServiceSetupDeps.core", - "type": "CompoundType", - "label": "core", - "description": [], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 43 - }, - "signature": [ - "LegacyCoreSetup" - ] - }, - { - "tags": [], - "id": "def-server.LegacyServiceSetupDeps.plugins", - "type": "Object", - "label": "plugins", - "description": [], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 44 - }, - "signature": [ - "Record" - ] - }, - { - "tags": [], - "id": "def-server.LegacyServiceSetupDeps.uiPlugins", - "type": "Object", - "label": "uiPlugins", - "description": [], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 45 - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiPlugins", - "text": "UiPlugins" - } - ] - } - ], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 42 - }, - "initialIsOpen": false - }, - { - "id": "def-server.LegacyServiceStartDeps", - "type": "Interface", - "label": "LegacyServiceStartDeps", - "description": [], - "tags": [ - "public", - "deprecated" - ], - "children": [ - { - "tags": [], - "id": "def-server.LegacyServiceStartDeps.core", - "type": "CompoundType", - "label": "core", - "description": [], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 53 - }, - "signature": [ - "LegacyCoreStart" - ] - }, - { - "tags": [], - "id": "def-server.LegacyServiceStartDeps.plugins", - "type": "Object", - "label": "plugins", - "description": [], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 54 - }, - "signature": [ - "Record" - ] - } - ], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 52 - }, - "initialIsOpen": false - }, { "id": "def-server.Logger", "type": "Interface", @@ -12544,6 +12804,7 @@ ], "children": [ { + "id": "def-server.Logger.trace.$1", "type": "string", "label": "message", "isRequired": true, @@ -12559,6 +12820,7 @@ } }, { + "id": "def-server.Logger.trace.$2", "type": "Object", "label": "meta", "isRequired": false, @@ -12596,6 +12858,7 @@ ], "children": [ { + "id": "def-server.Logger.debug.$1", "type": "string", "label": "message", "isRequired": true, @@ -12611,6 +12874,7 @@ } }, { + "id": "def-server.Logger.debug.$2", "type": "Object", "label": "meta", "isRequired": false, @@ -12648,6 +12912,7 @@ ], "children": [ { + "id": "def-server.Logger.info.$1", "type": "string", "label": "message", "isRequired": true, @@ -12663,6 +12928,7 @@ } }, { + "id": "def-server.Logger.info.$2", "type": "Object", "label": "meta", "isRequired": false, @@ -12700,6 +12966,7 @@ ], "children": [ { + "id": "def-server.Logger.warn.$1", "type": "CompoundType", "label": "errorOrMessage", "isRequired": true, @@ -12715,6 +12982,7 @@ } }, { + "id": "def-server.Logger.warn.$2", "type": "Object", "label": "meta", "isRequired": false, @@ -12752,6 +13020,7 @@ ], "children": [ { + "id": "def-server.Logger.error.$1", "type": "CompoundType", "label": "errorOrMessage", "isRequired": true, @@ -12767,6 +13036,7 @@ } }, { + "id": "def-server.Logger.error.$2", "type": "Object", "label": "meta", "isRequired": false, @@ -12804,6 +13074,7 @@ ], "children": [ { + "id": "def-server.Logger.fatal.$1", "type": "CompoundType", "label": "errorOrMessage", "isRequired": true, @@ -12819,6 +13090,7 @@ } }, { + "id": "def-server.Logger.fatal.$2", "type": "Object", "label": "meta", "isRequired": false, @@ -12855,6 +13127,7 @@ ], "children": [ { + "id": "def-server.Logger.get.$1", "type": "Array", "label": "childContextPaths", "isRequired": true, @@ -12899,7 +13172,7 @@ "description": [], "source": { "path": "src/core/server/logging/logging_config.ts", - "lineNumber": 111 + "lineNumber": 113 }, "signature": [ "Record MaybePromise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsDetails", + "text": "DeprecationsDetails" + }, + "[]>" + ] + } + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 56 + }, + "initialIsOpen": false + }, { "id": "def-server.RequestHandlerContext", "type": "Interface", @@ -14272,7 +14595,7 @@ "description": [], "source": { "path": "src/core/server/index.ts", - "lineNumber": 428 + "lineNumber": 432 }, "signature": [ "{ savedObjects: { client: Pick<", @@ -14283,7 +14606,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">; typeRegistry: Pick<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; typeRegistry: Pick<", { "pluginId": "core", "scope": "server", @@ -14307,7 +14630,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">; getExporter: (client: Pick<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; getExporter: (client: Pick<", { "pluginId": "core", "scope": "server", @@ -14320,7 +14643,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 427 + "lineNumber": 431 }, "initialIsOpen": false }, @@ -14435,13 +14758,7 @@ "lineNumber": 78 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, + "SavedObjectError", " | undefined" ] }, @@ -14474,13 +14791,7 @@ "lineNumber": 82 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ] }, @@ -14497,13 +14808,7 @@ "lineNumber": 84 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -14764,13 +15069,7 @@ }, "signature": [ "{ total: number; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number | undefined; _explanation?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Explanation", - "text": "Explanation" - }, + "Explanation", " | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: unknown[] | undefined; }[]; }" ] }, @@ -15125,6 +15424,7 @@ ], "children": [ { + "id": "def-server.StatusServiceSetup.set.$1", "type": "Object", "label": "status$", "isRequired": true, @@ -15498,13 +15798,7 @@ "lineNumber": 68 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.DeprecationSettings", - "text": "DeprecationSettings" - }, + "DeprecationSettings", " | undefined" ] }, @@ -15535,29 +15829,11 @@ "lineNumber": 81 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.ImageValidation", - "text": "ImageValidation" - }, + "ImageValidation", " | ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.StringValidationRegex", - "text": "StringValidationRegex" - }, + "StringValidationRegex", " | ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.StringValidationRegexString", - "text": "StringValidationRegexString" - }, + "StringValidationRegexString", " | undefined" ] }, @@ -15618,13 +15894,7 @@ "label": "register", "signature": [ "(settings: Record>) => void" ], "description": [ @@ -15632,18 +15902,13 @@ ], "children": [ { + "id": "def-server.UiSettingsServiceSetup.register.$1", "type": "Object", "label": "settings", "isRequired": true, "signature": [ "Record>" ], "description": [], @@ -15689,7 +15954,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">) => ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => ", { "pluginId": "core", "scope": "server", @@ -15703,6 +15968,7 @@ ], "children": [ { + "id": "def-server.UiSettingsServiceStart.asScopedToClient.$1", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -15715,7 +15981,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "description": [], "source": { @@ -15791,6 +16057,27 @@ ], "enums": [], "misc": [ + { + "id": "def-server.AddConfigDeprecation", + "type": "Type", + "label": "AddConfigDeprecation", + "tags": [ + "public" + ], + "description": [ + "\nConfig deprecation hook used when invoking a {@link ConfigDeprecation}\n" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 6 + }, + "signature": [ + "(details: ", + "DeprecatedConfigDetails", + ") => void" + ], + "initialIsOpen": false + }, { "id": "def-server.AppenderConfigType", "type": "Type", @@ -15882,34 +16169,15 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 16 + "lineNumber": 33 }, "signature": [ - "(config: Record, fromPath: string, logger: ", - "ConfigDeprecationLogger", + "(config: Record, fromPath: string, addDeprecation: ", + "AddConfigDeprecation", ") => Record" ], "initialIsOpen": false }, - { - "id": "def-server.ConfigDeprecationLogger", - "type": "Type", - "label": "ConfigDeprecationLogger", - "tags": [ - "public" - ], - "description": [ - "\nLogger interface used when invoking a {@link ConfigDeprecation}\n" - ], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 6 - }, - "signature": [ - "(message: string) => void" - ], - "initialIsOpen": false - }, { "id": "def-server.ConfigDeprecationProvider", "type": "Type", @@ -15922,7 +16190,7 @@ ], "source": { "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 33 + "lineNumber": 50 }, "signature": [ "(factory: ", @@ -15965,7 +16233,7 @@ "lineNumber": 22 }, "signature": [ - "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" + "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" ], "initialIsOpen": false }, @@ -16280,7 +16548,7 @@ "lineNumber": 27 }, "signature": [ - "Pick & Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ConfigOptions['requestTimeout']; sniffInterval?: ElasticsearchConfig['sniffInterval'] | ConfigOptions['sniffInterval']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; }" + "Pick & 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; }" ], "initialIsOpen": false }, @@ -16294,7 +16562,7 @@ "description": [], "source": { "path": "src/core/server/logging/logging_config.ts", - "lineNumber": 59 + "lineNumber": 60 }, "signature": [ "{ readonly name: string; readonly level: ", @@ -16389,7 +16657,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 404 + "lineNumber": 411 }, "signature": [ "(core: ", @@ -16471,7 +16739,7 @@ "lineNumber": 102 }, "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; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | 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; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; }" ], "initialIsOpen": false }, @@ -16588,7 +16856,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 285 + "lineNumber": 292 }, "signature": [ "{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => ", @@ -16616,7 +16884,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 496 + "lineNumber": 502 }, "signature": [ "() => Promise<[", diff --git a/api_docs/core_application.json b/api_docs/core_application.json index c15b47dcb098..0c9ae36b4cc9 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -35,6 +35,7 @@ "description": [], "children": [ { + "id": "def-public.ScopedHistory.Unnamed.$1", "type": "Object", "label": "parentHistory", "isRequired": true, @@ -49,6 +50,7 @@ } }, { + "id": "def-public.ScopedHistory.Unnamed.$2", "type": "string", "label": "basePath", "isRequired": true, @@ -74,6 +76,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.createSubHistory.$1", "type": "string", "label": "basePath", "isRequired": true, @@ -160,6 +163,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.push.$1", "type": "CompoundType", "label": "pathOrLocation", "isRequired": true, @@ -175,6 +179,7 @@ } }, { + "id": "def-public.ScopedHistory.push.$2", "type": "Uncategorized", "label": "state", "isRequired": false, @@ -209,6 +214,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.replace.$1", "type": "CompoundType", "label": "pathOrLocation", "isRequired": true, @@ -224,6 +230,7 @@ } }, { + "id": "def-public.ScopedHistory.replace.$2", "type": "Uncategorized", "label": "state", "isRequired": false, @@ -258,6 +265,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.go.$1", "type": "number", "label": "n", "isRequired": true, @@ -326,6 +334,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.block.$1", "type": "CompoundType", "label": "prompt", "isRequired": false, @@ -363,6 +372,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.listen.$1", "type": "Function", "label": "listener", "isRequired": true, @@ -406,6 +416,7 @@ "type": "Function", "children": [ { + "id": "def-public.ScopedHistory.createHref.$1", "type": "Object", "label": "location", "isRequired": true, @@ -420,7 +431,7 @@ } }, { - "id": "def-public.ScopedHistory.createHref.{-prependBasePath = true }", + "id": "def-public.ScopedHistory.createHref.$2.prependBasePathtrue", "type": "Object", "label": "{ prependBasePath = true }", "tags": [], @@ -428,7 +439,7 @@ "children": [ { "tags": [], - "id": "def-public.ScopedHistory.createHref.{-prependBasePath = true }.prependBasePath", + "id": "def-public.ScopedHistory.createHref.$2.prependBasePathtrue.prependBasePath", "type": "CompoundType", "label": "prependBasePath", "description": [], @@ -531,13 +542,7 @@ "lineNumber": 95 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.AppCategory", - "text": "AppCategory" - }, + "AppCategory", " | undefined" ] }, @@ -706,13 +711,7 @@ }, "signature": [ "Partial<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - }, + "Capabilities", "> | undefined" ] }, @@ -963,6 +962,7 @@ ], "children": [ { + "id": "def-public.ApplicationSetup.register.$1", "type": "Object", "label": "app", "isRequired": true, @@ -1014,6 +1014,7 @@ ], "children": [ { + "id": "def-public.ApplicationSetup.registerAppUpdater.$1", "type": "Object", "label": "appUpdater$", "isRequired": true, @@ -1120,6 +1121,7 @@ ], "children": [ { + "id": "def-public.ApplicationStart.navigateToApp.$1", "type": "string", "label": "appId", "isRequired": true, @@ -1133,6 +1135,7 @@ } }, { + "id": "def-public.ApplicationStart.navigateToApp.$2", "type": "Object", "label": "options", "isRequired": false, @@ -1174,6 +1177,7 @@ ], "children": [ { + "id": "def-public.ApplicationStart.navigateToUrl.$1", "type": "string", "label": "url", "isRequired": true, @@ -1208,6 +1212,7 @@ ], "children": [ { + "id": "def-public.ApplicationStart.getUrlForApp.$1", "type": "string", "label": "appId", "isRequired": true, @@ -1221,7 +1226,7 @@ } }, { - "id": "def-public.ApplicationStart.getUrlForApp.options", + "id": "def-public.ApplicationStart.getUrlForApp.$2.options", "type": "Object", "label": "options", "tags": [], @@ -1229,7 +1234,7 @@ "children": [ { "tags": [], - "id": "def-public.ApplicationStart.getUrlForApp.options.path", + "id": "def-public.ApplicationStart.getUrlForApp.$2.options.path", "type": "string", "label": "path", "description": [], @@ -1243,7 +1248,7 @@ }, { "tags": [], - "id": "def-public.ApplicationStart.getUrlForApp.options.absolute", + "id": "def-public.ApplicationStart.getUrlForApp.$2.options.absolute", "type": "CompoundType", "label": "absolute", "description": [], diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index cad8f16b4bd5..8fa999791ee8 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -123,6 +123,7 @@ ], "children": [ { + "id": "def-public.ChromeDocTitle.change.$1", "type": "CompoundType", "label": "newTitle", "isRequired": true, @@ -254,10 +255,10 @@ "DisambiguateSet", "<", "PropsForAnchor", - ", ", - "PropsForButton", - "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", - "DisambiguateSet" + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForButton" ], "description": [], "tags": [ @@ -332,10 +333,10 @@ "DisambiguateSet", "<", "PropsForAnchor", - ", ", - "PropsForButton", - "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", - "DisambiguateSet" + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForButton" ], "description": [], "tags": [ @@ -394,10 +395,10 @@ "DisambiguateSet", "<", "PropsForAnchor", - ", ", - "PropsForButton", - "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", - "DisambiguateSet" + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForButton" ], "description": [], "tags": [ @@ -456,10 +457,10 @@ "DisambiguateSet", "<", "PropsForAnchor", - ", ", - "PropsForButton", - "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", - "DisambiguateSet" + "<", + "CommonEuiButtonEmptyProps", + ", {}>, ", + "PropsForButton" ], "description": [], "tags": [ @@ -603,6 +604,7 @@ ], "children": [ { + "id": "def-public.ChromeNavControls.registerLeft.$1", "type": "Object", "label": "navControl", "isRequired": true, @@ -649,6 +651,7 @@ ], "children": [ { + "id": "def-public.ChromeNavControls.registerRight.$1", "type": "Object", "label": "navControl", "isRequired": true, @@ -695,6 +698,7 @@ ], "children": [ { + "id": "def-public.ChromeNavControls.registerCenter.$1", "type": "Object", "label": "navControl", "isRequired": true, @@ -776,13 +780,7 @@ "lineNumber": 29 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.AppCategory", - "text": "AppCategory" - }, + "AppCategory", " | undefined" ] }, @@ -990,6 +988,7 @@ ], "children": [ { + "id": "def-public.ChromeNavLinks.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -1048,6 +1047,7 @@ ], "children": [ { + "id": "def-public.ChromeNavLinks.has.$1", "type": "string", "label": "id", "isRequired": true, @@ -1080,6 +1080,7 @@ ], "children": [ { + "id": "def-public.ChromeNavLinks.showOnly.$1", "type": "string", "label": "id", "isRequired": true, @@ -1128,6 +1129,7 @@ ], "children": [ { + "id": "def-public.ChromeNavLinks.update.$1", "type": "string", "label": "id", "isRequired": true, @@ -1141,6 +1143,7 @@ } }, { + "id": "def-public.ChromeNavLinks.update.$2", "type": "Object", "label": "values", "isRequired": true, @@ -1239,6 +1242,7 @@ ], "children": [ { + "id": "def-public.ChromeRecentlyAccessed.add.$1", "type": "string", "label": "link", "isRequired": true, @@ -1254,6 +1258,7 @@ } }, { + "id": "def-public.ChromeRecentlyAccessed.add.$2", "type": "string", "label": "label", "isRequired": true, @@ -1269,6 +1274,7 @@ } }, { + "id": "def-public.ChromeRecentlyAccessed.add.$3", "type": "string", "label": "id", "isRequired": true, @@ -1512,6 +1518,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setAppTitle.$1", "type": "string", "label": "appTitle", "isRequired": true, @@ -1580,6 +1587,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setBrand.$1", "type": "Object", "label": "brand", "isRequired": true, @@ -1638,6 +1646,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setIsVisible.$1", "type": "boolean", "label": "isVisible", "isRequired": true, @@ -1690,6 +1699,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.addApplicationClass.$1", "type": "string", "label": "className", "isRequired": true, @@ -1722,6 +1732,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.removeApplicationClass.$1", "type": "string", "label": "className", "isRequired": true, @@ -1790,6 +1801,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setBadge.$1", "type": "Object", "label": "badge", "isRequired": false, @@ -1853,6 +1865,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setBreadcrumbs.$1", "type": "Array", "label": "newBreadcrumbs", "isRequired": true, @@ -1882,13 +1895,7 @@ "() => ", "Observable", "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreChromePluginApi", - "section": "def-public.ChromeBreadcrumbsAppendExtension", - "text": "ChromeBreadcrumbsAppendExtension" - }, + "ChromeBreadcrumbsAppendExtension", " | undefined>" ], "description": [ @@ -1908,13 +1915,7 @@ "label": "setBreadcrumbsAppendExtension", "signature": [ "(breadcrumbsAppendExtension?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreChromePluginApi", - "section": "def-public.ChromeBreadcrumbsAppendExtension", - "text": "ChromeBreadcrumbsAppendExtension" - }, + "ChromeBreadcrumbsAppendExtension", " | undefined) => void" ], "description": [ @@ -1922,17 +1923,12 @@ ], "children": [ { + "id": "def-public.ChromeStart.setBreadcrumbsAppendExtension.$1", "type": "Object", "label": "breadcrumbsAppendExtension", "isRequired": false, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreChromePluginApi", - "section": "def-public.ChromeBreadcrumbsAppendExtension", - "text": "ChromeBreadcrumbsAppendExtension" - }, + "ChromeBreadcrumbsAppendExtension", " | undefined" ], "description": [], @@ -1997,6 +1993,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setCustomNavLink.$1", "type": "Object", "label": "newCustomNavLink", "isRequired": false, @@ -2073,6 +2070,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setHelpExtension.$1", "type": "Object", "label": "helpExtension", "isRequired": false, @@ -2112,6 +2110,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setHelpSupportUrl.$1", "type": "string", "label": "url", "isRequired": true, @@ -2174,6 +2173,7 @@ ], "children": [ { + "id": "def-public.ChromeStart.setHeaderBanner.$1", "type": "Object", "label": "headerBanner", "isRequired": false, diff --git a/api_docs/core_http.json b/api_docs/core_http.json index ce5ceb2840ec..c65171153a6f 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -372,6 +372,7 @@ ], "children": [ { + "id": "def-public.HttpInterceptor.request.$1", "type": "Object", "label": "fetchOptions", "isRequired": true, @@ -393,6 +394,7 @@ } }, { + "id": "def-public.HttpInterceptor.request.$2", "type": "Object", "label": "controller", "isRequired": true, @@ -463,6 +465,7 @@ ], "children": [ { + "id": "def-public.HttpInterceptor.requestError.$1", "type": "Object", "label": "httpErrorRequest", "isRequired": true, @@ -482,6 +485,7 @@ } }, { + "id": "def-public.HttpInterceptor.requestError.$2", "type": "Object", "label": "controller", "isRequired": true, @@ -552,6 +556,7 @@ ], "children": [ { + "id": "def-public.HttpInterceptor.response.$1", "type": "Object", "label": "httpResponse", "isRequired": true, @@ -572,6 +577,7 @@ } }, { + "id": "def-public.HttpInterceptor.response.$2", "type": "Object", "label": "controller", "isRequired": true, @@ -642,6 +648,7 @@ ], "children": [ { + "id": "def-public.HttpInterceptor.responseError.$1", "type": "Object", "label": "httpErrorResponse", "isRequired": true, @@ -661,6 +668,7 @@ } }, { + "id": "def-public.HttpInterceptor.responseError.$2", "type": "Object", "label": "controller", "isRequired": true, @@ -1239,6 +1247,7 @@ ], "children": [ { + "id": "def-public.HttpSetup.intercept.$1", "type": "Object", "label": "interceptor", "isRequired": true, @@ -1459,6 +1468,7 @@ ], "children": [ { + "id": "def-public.HttpSetup.addLoadingCountSource.$1", "type": "Object", "label": "countSource$", "isRequired": true, @@ -1530,6 +1540,7 @@ ], "children": [ { + "id": "def-public.IAnonymousPaths.isAnonymous.$1", "type": "string", "label": "path", "isRequired": true, @@ -1562,6 +1573,7 @@ ], "children": [ { + "id": "def-public.IAnonymousPaths.register.$1", "type": "string", "label": "path", "isRequired": true, @@ -1707,6 +1719,7 @@ ], "children": [ { + "id": "def-public.IExternalUrl.validateUrl.$1", "type": "string", "label": "relativeOrAbsoluteUrl", "isRequired": true, @@ -2026,6 +2039,7 @@ "type": "Function", "children": [ { + "id": "def-server.BasePath.get.$1", "type": "CompoundType", "label": "request", "isRequired": true, @@ -2088,6 +2102,7 @@ "type": "Function", "children": [ { + "id": "def-server.BasePath.set.$1", "type": "CompoundType", "label": "request", "isRequired": true, @@ -2115,6 +2130,7 @@ } }, { + "id": "def-server.BasePath.set.$2", "type": "string", "label": "requestSpecificBasePath", "isRequired": true, @@ -2165,6 +2181,7 @@ "type": "Function", "children": [ { + "id": "def-server.BasePath.prepend.$1", "type": "string", "label": "path", "isRequired": true, @@ -2197,6 +2214,7 @@ "type": "Function", "children": [ { + "id": "def-server.BasePath.remove.$1", "type": "string", "label": "path", "isRequired": true, @@ -2442,6 +2460,7 @@ "description": [], "children": [ { + "id": "def-server.KibanaRequest.Unnamed.$1", "type": "Object", "label": "request", "isRequired": true, @@ -2455,6 +2474,7 @@ } }, { + "id": "def-server.KibanaRequest.Unnamed.$2", "type": "Uncategorized", "label": "params", "isRequired": true, @@ -2468,6 +2488,7 @@ } }, { + "id": "def-server.KibanaRequest.Unnamed.$3", "type": "Uncategorized", "label": "query", "isRequired": true, @@ -2481,6 +2502,7 @@ } }, { + "id": "def-server.KibanaRequest.Unnamed.$4", "type": "Uncategorized", "label": "body", "isRequired": true, @@ -2494,6 +2516,7 @@ } }, { + "id": "def-server.KibanaRequest.Unnamed.$5", "type": "boolean", "label": "withoutSecretHeaders", "isRequired": true, @@ -2553,6 +2576,7 @@ "description": [], "children": [ { + "id": "def-server.RouteValidationError.Unnamed.$1", "type": "CompoundType", "label": "error", "isRequired": true, @@ -2566,6 +2590,7 @@ } }, { + "id": "def-server.RouteValidationError.Unnamed.$2", "type": "Array", "label": "path", "isRequired": true, @@ -3777,6 +3802,7 @@ "description": [], "children": [ { + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "boolean", "label": "detailed", "isRequired": true, @@ -3815,6 +3841,7 @@ "description": [], "children": [ { + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "boolean", "label": "detailed", "isRequired": true, @@ -3855,6 +3882,7 @@ ], "children": [ { + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "CompoundType", "label": "detailed", "isRequired": false, @@ -3909,7 +3937,7 @@ ], "children": [ { - "id": "def-server.IKibanaSocket.renegotiate.options", + "id": "def-server.IKibanaSocket.renegotiate.$1.options", "type": "Object", "label": "options", "tags": [], @@ -3917,7 +3945,7 @@ "children": [ { "tags": [], - "id": "def-server.IKibanaSocket.renegotiate.options.rejectUnauthorized", + "id": "def-server.IKibanaSocket.renegotiate.$1.options.rejectUnauthorized", "type": "CompoundType", "label": "rejectUnauthorized", "description": [], @@ -3931,7 +3959,7 @@ }, { "tags": [], - "id": "def-server.IKibanaSocket.renegotiate.options.requestCert", + "id": "def-server.IKibanaSocket.renegotiate.$1.options.requestCert", "type": "CompoundType", "label": "requestCert", "description": [], @@ -5230,6 +5258,7 @@ ], "children": [ { + "id": "def-server.SessionStorage.set.$1", "type": "Uncategorized", "label": "sessionValue", "isRequired": true, @@ -6521,6 +6550,7 @@ "type": "Function", "children": [ { + "id": "def-server.kibanaResponseFactory.custom.$1", "type": "Object", "label": "options", "isRequired": true, @@ -6553,13 +6583,7 @@ "text": "CustomHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - }, + "KibanaResponse", "" ], "description": [ diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index 54f13f3911be..693916de32d3 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -18,6 +18,7 @@ "type": "Function", "children": [ { + "id": "def-public.SavedObjectsClient.create.$1", "type": "string", "label": "type", "isRequired": true, @@ -31,6 +32,7 @@ } }, { + "id": "def-public.SavedObjectsClient.create.$2", "type": "Uncategorized", "label": "attributes", "isRequired": true, @@ -44,6 +46,7 @@ } }, { + "id": "def-public.SavedObjectsClient.create.$3", "type": "Object", "label": "options", "isRequired": true, @@ -98,6 +101,7 @@ "type": "Function", "children": [ { + "id": "def-public.SavedObjectsClient.bulkCreate.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -118,6 +122,7 @@ } }, { + "id": "def-public.SavedObjectsClient.bulkCreate.$2", "type": "Object", "label": "options", "isRequired": true, @@ -184,6 +189,7 @@ "type": "Function", "children": [ { + "id": "def-public.SavedObjectsClient.delete.$1", "type": "string", "label": "type", "isRequired": true, @@ -197,6 +203,7 @@ } }, { + "id": "def-public.SavedObjectsClient.delete.$2", "type": "string", "label": "id", "isRequired": true, @@ -210,17 +217,12 @@ } }, { + "id": "def-public.SavedObjectsClient.delete.$3", "type": "Object", "label": "options", "isRequired": false, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, + "SavedObjectsDeleteOptions", " | undefined" ], "description": [], @@ -232,13 +234,7 @@ ], "signature": [ "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, + "SavedObjectsDeleteOptions", " | undefined) => Promise<{}>" ], "description": [ @@ -257,6 +253,7 @@ "type": "Function", "children": [ { + "id": "def-public.SavedObjectsClient.find.$1", "type": "Object", "label": "options", "isRequired": true, @@ -317,6 +314,7 @@ "type": "Function", "children": [ { + "id": "def-public.SavedObjectsClient.get.$1", "type": "string", "label": "type", "isRequired": true, @@ -330,6 +328,7 @@ } }, { + "id": "def-public.SavedObjectsClient.get.$2", "type": "string", "label": "id", "isRequired": true, @@ -372,6 +371,7 @@ "type": "Function", "children": [ { + "id": "def-public.SavedObjectsClient.bulkGet.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -437,6 +437,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsClient.update.$1", "type": "string", "label": "type", "isRequired": true, @@ -450,6 +451,7 @@ } }, { + "id": "def-public.SavedObjectsClient.update.$2", "type": "string", "label": "id", "isRequired": true, @@ -463,6 +465,7 @@ } }, { + "id": "def-public.SavedObjectsClient.update.$3", "type": "Uncategorized", "label": "attributes", "isRequired": true, @@ -476,6 +479,7 @@ } }, { + "id": "def-public.SavedObjectsClient.update.$4", "type": "Object", "label": "{ version, migrationVersion, references }", "isRequired": true, @@ -532,6 +536,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsClient.bulkUpdate.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -652,13 +657,7 @@ "lineNumber": 29 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -687,13 +686,7 @@ "lineNumber": 31 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, + "SavedObjectError", " | undefined" ] }, @@ -708,13 +701,7 @@ "lineNumber": 32 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ] }, @@ -728,6 +715,7 @@ "description": [], "children": [ { + "id": "def-public.SimpleSavedObject.Unnamed.$1", "type": "Object", "label": "client", "isRequired": true, @@ -740,7 +728,7 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ], "description": [], "source": { @@ -749,17 +737,12 @@ } }, { + "id": "def-public.SimpleSavedObject.Unnamed.$2", "type": "Object", "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "" ], "description": [], @@ -786,6 +769,7 @@ "description": [], "children": [ { + "id": "def-public.SimpleSavedObject.get.$1", "type": "string", "label": "key", "isRequired": true, @@ -816,6 +800,7 @@ "description": [], "children": [ { + "id": "def-public.SimpleSavedObject.set.$1", "type": "string", "label": "key", "isRequired": true, @@ -829,6 +814,7 @@ } }, { + "id": "def-public.SimpleSavedObject.set.$2", "type": "Any", "label": "value", "isRequired": true, @@ -859,6 +845,7 @@ "description": [], "children": [ { + "id": "def-public.SimpleSavedObject.has.$1", "type": "string", "label": "key", "isRequired": true, @@ -1146,13 +1133,7 @@ "lineNumber": 71 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] } @@ -1247,13 +1228,7 @@ "lineNumber": 42 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -1284,13 +1259,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] } @@ -1400,7 +1369,7 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ] } ], @@ -1446,13 +1415,7 @@ "lineNumber": 83 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -1467,13 +1430,7 @@ "lineNumber": 84 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] } @@ -1502,7 +1459,7 @@ "lineNumber": 138 }, "signature": [ - "{ get: (type: string, id: string) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; find: (options: Pick) => Promise>; update: (type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions) => Promise>; bulkCreate: (objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" + "{ 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, migrationVersion, references }?: SavedObjectsUpdateOptions) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" ], "initialIsOpen": false } @@ -1578,13 +1535,7 @@ "text": "SavedObjectsCreateOptions" }, " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ], "description": [ @@ -1592,6 +1543,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.create.$1", "type": "string", "label": "type", "isRequired": true, @@ -1605,6 +1557,7 @@ } }, { + "id": "def-server.SavedObjectsClient.create.$2", "type": "Uncategorized", "label": "attributes", "isRequired": true, @@ -1618,6 +1571,7 @@ } }, { + "id": "def-server.SavedObjectsClient.create.$3", "type": "Object", "label": "options", "isRequired": false, @@ -1681,6 +1635,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.bulkCreate.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -1701,6 +1656,7 @@ } }, { + "id": "def-server.SavedObjectsClient.bulkCreate.$2", "type": "Object", "label": "options", "isRequired": false, @@ -1764,6 +1720,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.checkConflicts.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -1784,6 +1741,7 @@ } }, { + "id": "def-server.SavedObjectsClient.checkConflicts.$2", "type": "Object", "label": "options", "isRequired": true, @@ -1830,6 +1788,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.delete.$1", "type": "string", "label": "type", "isRequired": true, @@ -1843,6 +1802,7 @@ } }, { + "id": "def-server.SavedObjectsClient.delete.$2", "type": "string", "label": "id", "isRequired": true, @@ -1856,6 +1816,7 @@ } }, { + "id": "def-server.SavedObjectsClient.delete.$3", "type": "Object", "label": "options", "isRequired": true, @@ -1910,6 +1871,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.find.$1", "type": "Object", "label": "options", "isRequired": true, @@ -1972,6 +1934,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.bulkGet.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -1994,6 +1957,7 @@ } }, { + "id": "def-server.SavedObjectsClient.bulkGet.$2", "type": "Object", "label": "options", "isRequired": true, @@ -2034,13 +1998,7 @@ "text": "SavedObjectsBaseOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ], "description": [ @@ -2048,6 +2006,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.get.$1", "type": "string", "label": "type", "isRequired": true, @@ -2063,6 +2022,7 @@ } }, { + "id": "def-server.SavedObjectsClient.get.$2", "type": "string", "label": "id", "isRequired": true, @@ -2078,6 +2038,7 @@ } }, { + "id": "def-server.SavedObjectsClient.get.$3", "type": "Object", "label": "options", "isRequired": true, @@ -2132,6 +2093,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.resolve.$1", "type": "string", "label": "type", "isRequired": true, @@ -2147,6 +2109,7 @@ } }, { + "id": "def-server.SavedObjectsClient.resolve.$2", "type": "string", "label": "id", "isRequired": true, @@ -2162,6 +2125,7 @@ } }, { + "id": "def-server.SavedObjectsClient.resolve.$3", "type": "Object", "label": "options", "isRequired": true, @@ -2216,6 +2180,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.update.$1", "type": "string", "label": "type", "isRequired": true, @@ -2229,6 +2194,7 @@ } }, { + "id": "def-server.SavedObjectsClient.update.$2", "type": "string", "label": "id", "isRequired": true, @@ -2242,6 +2208,7 @@ } }, { + "id": "def-server.SavedObjectsClient.update.$3", "type": "Object", "label": "attributes", "isRequired": true, @@ -2255,6 +2222,7 @@ } }, { + "id": "def-server.SavedObjectsClient.update.$4", "type": "Object", "label": "options", "isRequired": true, @@ -2309,6 +2277,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.addToNamespaces.$1", "type": "string", "label": "type", "isRequired": true, @@ -2322,6 +2291,7 @@ } }, { + "id": "def-server.SavedObjectsClient.addToNamespaces.$2", "type": "string", "label": "id", "isRequired": true, @@ -2335,6 +2305,7 @@ } }, { + "id": "def-server.SavedObjectsClient.addToNamespaces.$3", "type": "Array", "label": "namespaces", "isRequired": true, @@ -2348,6 +2319,7 @@ } }, { + "id": "def-server.SavedObjectsClient.addToNamespaces.$4", "type": "Object", "label": "options", "isRequired": true, @@ -2402,6 +2374,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$1", "type": "string", "label": "type", "isRequired": true, @@ -2415,6 +2388,7 @@ } }, { + "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$2", "type": "string", "label": "id", "isRequired": true, @@ -2428,6 +2402,7 @@ } }, { + "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$3", "type": "Array", "label": "namespaces", "isRequired": true, @@ -2441,6 +2416,7 @@ } }, { + "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$4", "type": "Object", "label": "options", "isRequired": true, @@ -2503,6 +2479,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.bulkUpdate.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -2523,6 +2500,7 @@ } }, { + "id": "def-server.SavedObjectsClient.bulkUpdate.$2", "type": "Object", "label": "options", "isRequired": false, @@ -2578,6 +2556,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.removeReferencesTo.$1", "type": "string", "label": "type", "isRequired": true, @@ -2591,6 +2570,7 @@ } }, { + "id": "def-server.SavedObjectsClient.removeReferencesTo.$2", "type": "string", "label": "id", "isRequired": true, @@ -2604,6 +2584,7 @@ } }, { + "id": "def-server.SavedObjectsClient.removeReferencesTo.$3", "type": "Object", "label": "options", "isRequired": false, @@ -2659,6 +2640,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.openPointInTimeForType.$1", "type": "CompoundType", "label": "type", "isRequired": true, @@ -2672,6 +2654,7 @@ } }, { + "id": "def-server.SavedObjectsClient.openPointInTimeForType.$2", "type": "Object", "label": "options", "isRequired": true, @@ -2726,6 +2709,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.closePointInTime.$1", "type": "string", "label": "id", "isRequired": true, @@ -2739,6 +2723,7 @@ } }, { + "id": "def-server.SavedObjectsClient.closePointInTime.$2", "type": "Object", "label": "options", "isRequired": false, @@ -2801,6 +2786,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$1", "type": "Object", "label": "findOptions", "isRequired": true, @@ -2822,6 +2808,7 @@ } }, { + "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$2", "type": "Object", "label": "dependencies", "isRequired": false, @@ -2883,6 +2870,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError.$1", "type": "Any", "label": "error", "isRequired": true, @@ -2921,6 +2909,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -2934,6 +2923,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -2972,6 +2962,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError.$1", "type": "string", "label": "reason", "isRequired": false, @@ -3010,6 +3001,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError.$1", "type": "string", "label": "type", "isRequired": true, @@ -3048,18 +3040,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3093,6 +3080,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError.$1", "type": "string", "label": "versionInput", "isRequired": false, @@ -3131,18 +3119,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3176,6 +3159,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3189,6 +3173,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -3227,18 +3212,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3272,6 +3252,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3285,6 +3266,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -3323,18 +3305,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3368,6 +3345,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3381,6 +3359,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -3419,18 +3398,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3464,6 +3438,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$1", "type": "CompoundType", "label": "type", "isRequired": false, @@ -3477,6 +3452,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$2", "type": "CompoundType", "label": "id", "isRequired": false, @@ -3515,6 +3491,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError.$1", "type": "string", "label": "alias", "isRequired": true, @@ -3553,6 +3530,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3566,6 +3544,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$2", "type": "string", "label": "alias", "isRequired": true, @@ -3604,18 +3583,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3649,6 +3623,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3662,6 +3637,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -3700,6 +3676,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$1", "type": "string", "label": "type", "isRequired": true, @@ -3713,6 +3690,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$2", "type": "string", "label": "id", "isRequired": true, @@ -3726,6 +3704,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$3", "type": "string", "label": "reason", "isRequired": false, @@ -3764,18 +3743,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isConflictError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3809,6 +3783,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3822,6 +3797,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -3860,6 +3836,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$1", "type": "string", "label": "type", "isRequired": true, @@ -3873,6 +3850,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$2", "type": "string", "label": "id", "isRequired": true, @@ -3911,18 +3889,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -3956,6 +3929,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -3969,6 +3943,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -4007,18 +3982,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -4052,6 +4022,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -4065,6 +4036,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -4103,18 +4075,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -4148,6 +4115,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -4161,6 +4129,7 @@ } }, { + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$2", "type": "string", "label": "reason", "isRequired": false, @@ -4199,18 +4168,13 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -4244,7 +4208,7 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsExporter.#savedObjectsClient", + "id": "def-server.SavedObjectsExporter.savedObjectsClient", "type": "Object", "label": "#savedObjectsClient", "description": [], @@ -4261,12 +4225,12 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsExporter.#exportTransforms", + "id": "def-server.SavedObjectsExporter.exportTransforms", "type": "Object", "label": "#exportTransforms", "description": [], @@ -4288,7 +4252,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsExporter.#exportSizeLimit", + "id": "def-server.SavedObjectsExporter.exportSizeLimit", "type": "number", "label": "#exportSizeLimit", "description": [], @@ -4299,7 +4263,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsExporter.#log", + "id": "def-server.SavedObjectsExporter.log", "type": "Object", "label": "#log", "description": [], @@ -4321,7 +4285,7 @@ "description": [], "children": [ { - "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger", "type": "Object", "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", "tags": [], @@ -4329,7 +4293,7 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.savedObjectsClient", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.savedObjectsClient", "type": "Object", "label": "savedObjectsClient", "description": [], @@ -4346,12 +4310,12 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.typeRegistry", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.typeRegistry", "type": "Object", "label": "typeRegistry", "description": [], @@ -4373,7 +4337,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.exportSizeLimit", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.exportSizeLimit", "type": "number", "label": "exportSizeLimit", "description": [], @@ -4384,7 +4348,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.logger", + "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClienttypeRegistryexportSizeLimitlogger.logger", "type": "Object", "label": "logger", "description": [], @@ -4432,6 +4396,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsExporter.exportByTypes.$1", "type": "Object", "label": "options", "isRequired": true, @@ -4482,6 +4447,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsExporter.exportByObjects.$1", "type": "Object", "label": "options", "isRequired": true, @@ -4546,6 +4512,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsExportError.Unnamed.$1", "type": "string", "label": "type", "isRequired": true, @@ -4559,6 +4526,7 @@ } }, { + "id": "def-server.SavedObjectsExportError.Unnamed.$2", "type": "string", "label": "message", "isRequired": true, @@ -4572,6 +4540,7 @@ } }, { + "id": "def-server.SavedObjectsExportError.Unnamed.$3", "type": "Object", "label": "attributes", "isRequired": false, @@ -4610,6 +4579,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", "type": "number", "label": "limit", "isRequired": true, @@ -4648,17 +4618,12 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsExportError.objectFetchError.$1", "type": "Array", "label": "objects", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]" ], "description": [], @@ -4695,17 +4660,12 @@ ], "children": [ { + "id": "def-server.SavedObjectsExportError.objectTransformError.$1", "type": "Array", "label": "objects", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]" ], "description": [], @@ -4715,6 +4675,7 @@ } }, { + "id": "def-server.SavedObjectsExportError.objectTransformError.$2", "type": "Object", "label": "cause", "isRequired": true, @@ -4755,6 +4716,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", "type": "Array", "label": "objectKeys", "isRequired": true, @@ -4793,7 +4755,7 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImporter.#savedObjectsClient", + "id": "def-server.SavedObjectsImporter.savedObjectsClient", "type": "Object", "label": "#savedObjectsClient", "description": [], @@ -4810,12 +4772,12 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsImporter.#typeRegistry", + "id": "def-server.SavedObjectsImporter.typeRegistry", "type": "Object", "label": "#typeRegistry", "description": [], @@ -4837,7 +4799,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsImporter.#importSizeLimit", + "id": "def-server.SavedObjectsImporter.importSizeLimit", "type": "number", "label": "#importSizeLimit", "description": [], @@ -4848,7 +4810,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsImporter.#importHooks", + "id": "def-server.SavedObjectsImporter.importHooks", "type": "Object", "label": "#importHooks", "description": [], @@ -4878,7 +4840,7 @@ "description": [], "children": [ { - "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit", "type": "Object", "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", "tags": [], @@ -4886,7 +4848,7 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.savedObjectsClient", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.savedObjectsClient", "type": "Object", "label": "savedObjectsClient", "description": [], @@ -4903,12 +4865,12 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.typeRegistry", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.typeRegistry", "type": "Object", "label": "typeRegistry", "description": [], @@ -4930,7 +4892,7 @@ }, { "tags": [], - "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.importSizeLimit", + "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClienttypeRegistryimportSizeLimit.importSizeLimit", "type": "number", "label": "importSizeLimit", "description": [], @@ -4981,6 +4943,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsImporter.import.$1", "type": "Object", "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", "isRequired": true, @@ -5037,6 +5000,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsImporter.resolveImportErrors.$1", "type": "Object", "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", "isRequired": true, @@ -5109,6 +5073,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", "type": "number", "label": "limit", "isRequired": true, @@ -5147,6 +5112,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1", "type": "Array", "label": "nonUniqueEntries", "isRequired": true, @@ -5185,6 +5151,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1", "type": "Array", "label": "nonUniqueRetryObjects", "isRequired": true, @@ -5223,6 +5190,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", "type": "Array", "label": "nonUniqueRetryDestinations", "isRequired": true, @@ -5261,17 +5229,12 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsImportError.referencesFetchError.$1", "type": "Array", "label": "objects", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]" ], "description": [], @@ -5318,13 +5281,7 @@ "text": "SavedObjectsCreateOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ], "description": [ @@ -5332,6 +5289,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.create.$1", "type": "string", "label": "type", "isRequired": true, @@ -5345,6 +5303,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.create.$2", "type": "Uncategorized", "label": "attributes", "isRequired": true, @@ -5358,6 +5317,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.create.$3", "type": "Object", "label": "options", "isRequired": true, @@ -5424,6 +5384,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.bulkCreate.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -5446,6 +5407,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.bulkCreate.$2", "type": "Object", "label": "options", "isRequired": true, @@ -5512,6 +5474,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.checkConflicts.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -5532,6 +5495,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.checkConflicts.$2", "type": "Object", "label": "options", "isRequired": true, @@ -5578,6 +5542,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.delete.$1", "type": "string", "label": "type", "isRequired": true, @@ -5591,6 +5556,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.delete.$2", "type": "string", "label": "id", "isRequired": true, @@ -5604,6 +5570,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.delete.$3", "type": "Object", "label": "options", "isRequired": true, @@ -5652,6 +5619,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", "type": "string", "label": "namespace", "isRequired": true, @@ -5665,6 +5633,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", "type": "Object", "label": "options", "isRequired": true, @@ -5719,6 +5688,7 @@ "description": [], "children": [ { + "id": "def-server.SavedObjectsRepository.find.$1", "type": "Object", "label": "options", "isRequired": true, @@ -5785,6 +5755,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.bulkGet.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -5807,6 +5778,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.bulkGet.$2", "type": "Object", "label": "options", "isRequired": true, @@ -5851,13 +5823,7 @@ "text": "SavedObjectsBaseOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ], "description": [ @@ -5865,6 +5831,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.get.$1", "type": "string", "label": "type", "isRequired": true, @@ -5878,6 +5845,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.get.$2", "type": "string", "label": "id", "isRequired": true, @@ -5891,6 +5859,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.get.$3", "type": "Object", "label": "options", "isRequired": true, @@ -5949,6 +5918,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.resolve.$1", "type": "string", "label": "type", "isRequired": true, @@ -5962,6 +5932,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.resolve.$2", "type": "string", "label": "id", "isRequired": true, @@ -5975,6 +5946,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.resolve.$3", "type": "Object", "label": "options", "isRequired": true, @@ -6033,6 +6005,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.update.$1", "type": "string", "label": "type", "isRequired": true, @@ -6046,6 +6019,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.update.$2", "type": "string", "label": "id", "isRequired": true, @@ -6059,6 +6033,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.update.$3", "type": "Object", "label": "attributes", "isRequired": true, @@ -6072,6 +6047,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.update.$4", "type": "Object", "label": "options", "isRequired": true, @@ -6128,6 +6104,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.addToNamespaces.$1", "type": "string", "label": "type", "isRequired": true, @@ -6141,6 +6118,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.addToNamespaces.$2", "type": "string", "label": "id", "isRequired": true, @@ -6154,6 +6132,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.addToNamespaces.$3", "type": "Array", "label": "namespaces", "isRequired": true, @@ -6167,6 +6146,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.addToNamespaces.$4", "type": "Object", "label": "options", "isRequired": true, @@ -6221,6 +6201,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$1", "type": "string", "label": "type", "isRequired": true, @@ -6234,6 +6215,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$2", "type": "string", "label": "id", "isRequired": true, @@ -6247,6 +6229,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$3", "type": "Array", "label": "namespaces", "isRequired": true, @@ -6260,6 +6243,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$4", "type": "Object", "label": "options", "isRequired": true, @@ -6322,6 +6306,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", "type": "Array", "label": "objects", "isRequired": true, @@ -6344,6 +6329,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", "type": "Object", "label": "options", "isRequired": true, @@ -6402,6 +6388,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", "type": "string", "label": "type", "isRequired": true, @@ -6415,6 +6402,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$2", "type": "string", "label": "id", "isRequired": true, @@ -6428,6 +6416,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", "type": "Object", "label": "options", "isRequired": true, @@ -6476,13 +6465,7 @@ "text": "SavedObjectsIncrementCounterOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ], "description": [ @@ -6490,6 +6473,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.incrementCounter.$1", "type": "string", "label": "type", "isRequired": true, @@ -6505,6 +6489,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.incrementCounter.$2", "type": "string", "label": "id", "isRequired": true, @@ -6520,6 +6505,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.incrementCounter.$3", "type": "Array", "label": "counterFields", "isRequired": true, @@ -6543,6 +6529,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.incrementCounter.$4", "type": "Object", "label": "options", "isRequired": true, @@ -6602,6 +6589,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1", "type": "CompoundType", "label": "type", "isRequired": true, @@ -6615,6 +6603,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2", "type": "Object", "label": "{ keepAlive = '5m', preference }", "isRequired": true, @@ -6673,6 +6662,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.closePointInTime.$1", "type": "string", "label": "id", "isRequired": true, @@ -6686,6 +6676,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.closePointInTime.$2", "type": "Object", "label": "options", "isRequired": false, @@ -6752,6 +6743,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1", "type": "Object", "label": "findOptions", "isRequired": true, @@ -6773,6 +6765,7 @@ } }, { + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", "type": "Object", "label": "dependencies", "isRequired": false, @@ -6846,6 +6839,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1", "type": "Object", "label": "doc", "isRequired": true, @@ -6867,6 +6861,7 @@ } }, { + "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2", "type": "Object", "label": "options", "isRequired": true, @@ -6931,6 +6926,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1", "type": "Object", "label": "doc", "isRequired": true, @@ -6952,6 +6948,7 @@ } }, { + "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2", "type": "Object", "label": "options", "isRequired": true, @@ -7007,6 +7004,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1", "type": "CompoundType", "label": "savedObj", "isRequired": true, @@ -7048,6 +7046,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsSerializer.generateRawId.$1", "type": "string", "label": "namespace", "isRequired": false, @@ -7063,6 +7062,7 @@ } }, { + "id": "def-server.SavedObjectsSerializer.generateRawId.$2", "type": "string", "label": "type", "isRequired": true, @@ -7078,6 +7078,7 @@ } }, { + "id": "def-server.SavedObjectsSerializer.generateRawId.$3", "type": "string", "label": "id", "isRequired": true, @@ -7112,6 +7113,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1", "type": "string", "label": "namespace", "isRequired": true, @@ -7127,6 +7129,7 @@ } }, { + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2", "type": "string", "label": "type", "isRequired": true, @@ -7142,6 +7145,7 @@ } }, { + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3", "type": "string", "label": "id", "isRequired": true, @@ -7185,6 +7189,7 @@ "type": "Function", "children": [ { + "id": "def-server.SavedObjectsUtils.namespaceIdToString.$1", "type": "string", "label": "namespace", "isRequired": false, @@ -7217,6 +7222,7 @@ "type": "Function", "children": [ { + "id": "def-server.SavedObjectsUtils.namespaceStringToId.$1", "type": "string", "label": "namespace", "isRequired": true, @@ -7249,6 +7255,7 @@ "type": "Function", "children": [ { + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", "type": "Object", "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", "isRequired": true, @@ -7344,6 +7351,7 @@ ], "children": [ { + "id": "def-server.SavedObjectsUtils.isRandomId.$1", "type": "string", "label": "id", "isRequired": false, @@ -7406,6 +7414,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.registerType.$1", "type": "Object", "label": "type", "isRequired": true, @@ -7452,6 +7461,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.getType.$1", "type": "string", "label": "type", "isRequired": true, @@ -7562,6 +7572,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1", "type": "string", "label": "type", "isRequired": true, @@ -7594,6 +7605,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1", "type": "string", "label": "type", "isRequired": true, @@ -7626,6 +7638,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1", "type": "string", "label": "type", "isRequired": true, @@ -7658,6 +7671,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.isShareable.$1", "type": "string", "label": "type", "isRequired": true, @@ -7690,6 +7704,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.isHidden.$1", "type": "string", "label": "type", "isRequired": true, @@ -7722,6 +7737,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.getIndex.$1", "type": "string", "label": "type", "isRequired": true, @@ -7754,6 +7770,7 @@ ], "children": [ { + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", "type": "string", "label": "type", "isRequired": true, @@ -8248,13 +8265,7 @@ "lineNumber": 75 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] }, @@ -8271,13 +8282,7 @@ "lineNumber": 77 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -8424,13 +8429,7 @@ "lineNumber": 125 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]" ] } @@ -8473,13 +8472,7 @@ "lineNumber": 310 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]" ] } @@ -8747,13 +8740,7 @@ }, "signature": [ "{ id: string; type: string; error: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, + "SavedObjectError", "; }[]" ] } @@ -8840,7 +8827,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { @@ -9205,13 +9192,7 @@ "lineNumber": 41 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -9242,13 +9223,7 @@ "lineNumber": 52 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] }, @@ -9335,7 +9310,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, \"find\" | \"openPointInTimeForType\" | \"closePointInTime\">" ] } ], @@ -11313,13 +11288,7 @@ "lineNumber": 115 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -11652,13 +11621,7 @@ "lineNumber": 18 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocSource", - "text": "SavedObjectsRawDocSource" - } + "SavedObjectsRawDocSource" ] }, { @@ -11869,7 +11832,7 @@ "section": "def-server.SavedObjectsRepository", "text": "SavedObjectsRepository" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"deleteByNamespace\" | \"incrementCounter\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ] }, { @@ -11893,7 +11856,7 @@ "section": "def-server.SavedObjectsRepository", "text": "SavedObjectsRepository" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"deleteByNamespace\" | \"incrementCounter\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ] } ], @@ -12021,13 +11984,7 @@ "lineNumber": 336 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "" ] }, @@ -12208,7 +12165,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { @@ -12240,7 +12197,7 @@ "section": "def-server.SavedObjectsRepository", "text": "SavedObjectsRepository" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"deleteByNamespace\" | \"incrementCounter\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ] }, { @@ -12264,7 +12221,7 @@ "section": "def-server.SavedObjectsRepository", "text": "SavedObjectsRepository" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"deleteByNamespace\" | \"incrementCounter\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ] }, { @@ -12311,7 +12268,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">) => Pick<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", { "pluginId": "core", "scope": "server", @@ -12343,7 +12300,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">) => Pick<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", { "pluginId": "core", "scope": "server", @@ -12678,13 +12635,7 @@ }, "signature": [ "((savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ") => string) | undefined" ] }, @@ -12702,13 +12653,7 @@ }, "signature": [ "((savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ") => string) | undefined" ] }, @@ -12726,13 +12671,7 @@ }, "signature": [ "((savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ") => { path: string; uiCapabilitiesPath: string; }) | undefined" ] }, @@ -12902,13 +12841,7 @@ "lineNumber": 213 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] }, @@ -12983,13 +12916,7 @@ "lineNumber": 328 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] } @@ -13056,7 +12983,7 @@ "lineNumber": 143 }, "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>; find: (options: SavedObjectsFindOptions) => Promise>; update: (type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions) => Promise>; bulkCreate: (objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsCreateOptions) => Promise>; bulkGet: (objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise>; bulkUpdate: (objects: SavedObjectsBulkUpdateObject[], options?: SavedObjectsBulkUpdateOptions) => Promise>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise; resolve: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise; createPointInTimeFinder: (findOptions: Pick, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies | undefined) => ISavedObjectsPointInTimeFinder; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise; incrementCounter: (type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise>; }" + "{ 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>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise; 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; }" ], "initialIsOpen": false }, @@ -13191,29 +13118,29 @@ "section": "def-server.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, - " | undefined) => Promise>; find: (options: SavedObjectsFindOptions) => Promise<", + " | undefined) => Promise>; bulkCreate: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - ") => Promise<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" } ], "initialIsOpen": false @@ -13249,7 +13176,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "initialIsOpen": false }, @@ -13318,7 +13245,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "initialIsOpen": false }, diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json index b14f24625ed6..36091a64a414 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -106,6 +106,7 @@ "description": [], "children": [ { + "id": "def-public.DashboardContainer.Unnamed.$1", "type": "Object", "label": "initialInput", "isRequired": true, @@ -125,17 +126,12 @@ } }, { + "id": "def-public.DashboardContainer.Unnamed.$2", "type": "Object", "label": "services", "isRequired": true, "signature": [ - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.DashboardContainerServices", - "text": "DashboardContainerServices" - } + "DashboardContainerServices" ], "description": [], "source": { @@ -144,6 +140,7 @@ } }, { + "id": "def-public.DashboardContainer.Unnamed.$3", "type": "Object", "label": "parent", "isRequired": false, @@ -217,25 +214,14 @@ "text": "EmbeddableFactory" }, ", partial?: Partial) => ", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.DashboardPanelState", - "text": "DashboardPanelState" - } + "DashboardPanelState" ], "description": [], "children": [ { + "id": "def-public.DashboardContainer.createNewPanelState.$1", "type": "Object", "label": "factory", "isRequired": true, @@ -248,13 +234,7 @@ "text": "EmbeddableFactory" }, "" ], "description": [], @@ -264,6 +244,7 @@ } }, { + "id": "def-public.DashboardContainer.createNewPanelState.$2", "type": "Object", "label": "partial", "isRequired": true, @@ -290,13 +271,7 @@ "label": "showPlaceholderUntil", "signature": [ "(newStateComplete: Promise>>, placementMethod?: ", - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.PanelPlacementMethod", - "text": "PanelPlacementMethod" - }, + "PanelPlacementMethod", " | undefined, placementArgs?: TPlacementMethodArgs | undefined) => void" ], "description": [], "children": [ { + "id": "def-public.DashboardContainer.showPlaceholderUntil.$1", "type": "Object", "label": "newStateComplete", "isRequired": true, @@ -339,17 +309,12 @@ } }, { + "id": "def-public.DashboardContainer.showPlaceholderUntil.$2", "type": "Function", "label": "placementMethod", "isRequired": false, "signature": [ - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.PanelPlacementMethod", - "text": "PanelPlacementMethod" - }, + "PanelPlacementMethod", " | undefined" ], "description": [], @@ -359,6 +324,7 @@ } }, { + "id": "def-public.DashboardContainer.showPlaceholderUntil.$3", "type": "Uncategorized", "label": "placementArgs", "isRequired": false, @@ -385,13 +351,7 @@ "label": "replacePanel", "signature": [ "(previousPanelState: ", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.DashboardPanelState", - "text": "DashboardPanelState" - }, + "DashboardPanelState", "<", { "pluginId": "embeddable", @@ -413,17 +373,12 @@ "description": [], "children": [ { + "id": "def-public.DashboardContainer.replacePanel.$1", "type": "Object", "label": "previousPanelState", "isRequired": true, "signature": [ - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.DashboardPanelState", - "text": "DashboardPanelState" - }, + "DashboardPanelState", "<", { "pluginId": "embeddable", @@ -441,6 +396,7 @@ } }, { + "id": "def-public.DashboardContainer.replacePanel.$2", "type": "Object", "label": "newPanelState", "isRequired": true, @@ -462,6 +418,7 @@ } }, { + "id": "def-public.DashboardContainer.replacePanel.$3", "type": "CompoundType", "label": "generateNewId", "isRequired": false, @@ -531,6 +488,7 @@ "description": [], "children": [ { + "id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$1", "type": "string", "label": "type", "isRequired": true, @@ -544,6 +502,7 @@ } }, { + "id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$2", "type": "Object", "label": "explicitInput", "isRequired": true, @@ -557,6 +516,7 @@ } }, { + "id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$3", "type": "string", "label": "embeddableId", "isRequired": false, @@ -587,6 +547,7 @@ "description": [], "children": [ { + "id": "def-public.DashboardContainer.render.$1", "type": "Object", "label": "dom", "isRequired": true, @@ -613,17 +574,12 @@ "label": "getInheritedInput", "signature": [ "(id: string) => ", - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.InheritedChildInput", - "text": "InheritedChildInput" - } + "InheritedChildInput" ], "description": [], "children": [ { + "id": "def-public.DashboardContainer.getInheritedInput.$1", "type": "string", "label": "id", "isRequired": true, @@ -737,18 +693,13 @@ "description": [], "children": [ { + "id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$1", "type": "Function", "label": "getStartServices", "isRequired": true, "signature": [ "() => Promise<", - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.DashboardContainerServices", - "text": "DashboardContainerServices" - }, + "DashboardContainerServices", ">" ], "description": [], @@ -826,6 +777,7 @@ "type": "Function", "children": [ { + "id": "def-public.DashboardContainerFactoryDefinition.create.$1", "type": "Object", "label": "initialInput", "isRequired": true, @@ -845,6 +797,7 @@ } }, { + "id": "def-public.DashboardContainerFactoryDefinition.create.$2", "type": "Object", "label": "parent", "isRequired": false, @@ -951,6 +904,7 @@ "description": [], "children": [ { + "id": "def-public.createDashboardEditUrl.$1", "type": "string", "label": "id", "isRequired": false, @@ -964,6 +918,7 @@ } }, { + "id": "def-public.createDashboardEditUrl.$2", "type": "CompoundType", "label": "editMode", "isRequired": false, @@ -990,6 +945,7 @@ "type": "Function", "children": [ { + "id": "def-public.createDashboardUrlGenerator.$1", "type": "Function", "label": "getStartServices", "isRequired": true, @@ -1078,13 +1034,7 @@ "lineNumber": 43 }, "signature": [ - { - "pluginId": "dashboard", - "scope": "public", - "docId": "kibDashboardPluginApi", - "section": "def-public.DashboardCapabilities", - "text": "DashboardCapabilities" - }, + "DashboardCapabilities", " | undefined" ] }, @@ -1291,13 +1241,7 @@ }, "signature": [ "{ [panelId: string]: ", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.DashboardPanelState", - "text": "DashboardPanelState" - }, + "DashboardPanelState", "<", { "pluginId": "embeddable", @@ -2105,11 +2049,102 @@ }, "server": { "classes": [], - "functions": [], + "functions": [ + { + "id": "def-server.findByValueEmbeddables", + "type": "Function", + "children": [ + { + "id": "def-server.findByValueEmbeddables.$1", + "type": "Object", + "label": "savedObjectClient", + "isRequired": true, + "signature": [ + "Pick, \"find\">" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", + "lineNumber": 13 + } + }, + { + "id": "def-server.findByValueEmbeddables.$2", + "type": "string", + "label": "embeddableType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", + "lineNumber": 14 + } + } + ], + "signature": [ + "(savedObjectClient: Pick, \"find\">, embeddableType: string) => Promise<{ [key: string]: unknown; }[]>" + ], + "description": [], + "label": "findByValueEmbeddables", + "source": { + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", + "lineNumber": 12 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [], "enums": [], "misc": [], - "objects": [] + "objects": [], + "setup": { + "id": "def-server.DashboardPluginSetup", + "type": "Interface", + "label": "DashboardPluginSetup", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "src/plugins/dashboard/server/types.ts", + "lineNumber": 10 + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.DashboardPluginStart", + "type": "Interface", + "label": "DashboardPluginStart", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "src/plugins/dashboard/server/types.ts", + "lineNumber": 12 + }, + "lifecycle": "start", + "initialIsOpen": true + } }, "common": { "classes": [], @@ -2139,42 +2174,19 @@ "description": [], "children": [ { + "id": "def-common.migratePanelsTo730.$1", "type": "Array", "label": "panels", "isRequired": true, "signature": [ "(", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.RawSavedDashboardPanelTo60", - "text": "RawSavedDashboardPanelTo60" - }, + "RawSavedDashboardPanelTo60", " | ", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.RawSavedDashboardPanel610", - "text": "RawSavedDashboardPanel610" - }, + "RawSavedDashboardPanel610", " | ", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.RawSavedDashboardPanel620", - "text": "RawSavedDashboardPanel620" - }, + "RawSavedDashboardPanel620", " | Pick<", - { - "pluginId": "dashboard", - "scope": "common", - "docId": "kibDashboardPluginApi", - "section": "def-common.RawSavedDashboardPanel620", - "text": "RawSavedDashboardPanel620" - }, + "RawSavedDashboardPanel620", ", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ", { "pluginId": "dashboard", @@ -2191,6 +2203,7 @@ } }, { + "id": "def-common.migratePanelsTo730.$2", "type": "string", "label": "version", "isRequired": true, @@ -2204,6 +2217,7 @@ } }, { + "id": "def-common.migratePanelsTo730.$3", "type": "boolean", "label": "useMargins", "isRequired": true, @@ -2217,14 +2231,14 @@ } }, { - "id": "def-common.migratePanelsTo730.uiState", + "id": "def-common.migratePanelsTo730.$4.uiState", "type": "Object", "label": "uiState", "tags": [], "description": [], "children": [ { - "id": "def-common.migratePanelsTo730.uiState.Unnamed", + "id": "def-common.migratePanelsTo730.$4.uiState.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 3c592a41e2f8..324a38971340 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -34,6 +34,17 @@ import dashboardObj from './dashboard.json'; ### Consts, variables and types +## Server + +### Setup + + +### Start + + +### Functions + + ## Common ### Functions diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json index 31c54684e50a..fc41872fc4dc 100644 --- a/api_docs/dashboard_enhanced.json +++ b/api_docs/dashboard_enhanced.json @@ -53,6 +53,7 @@ "description": [], "children": [ { + "id": "def-public.AbstractDashboardDrilldown.Unnamed.$1", "type": "Object", "label": "params", "isRequired": true, @@ -130,6 +131,7 @@ "description": [], "children": [ { + "id": "def-public.AbstractDashboardDrilldown.getURL.$1", "type": "Object", "label": "config", "isRequired": true, @@ -149,6 +151,7 @@ } }, { + "id": "def-public.AbstractDashboardDrilldown.getURL.$2", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -279,6 +282,7 @@ "type": "Function", "children": [ { + "id": "def-public.AbstractDashboardDrilldown.isConfigValid.$1", "type": "Object", "label": "config", "isRequired": true, @@ -330,6 +334,7 @@ "type": "Function", "children": [ { + "id": "def-public.AbstractDashboardDrilldown.getHref.$1", "type": "Object", "label": "config", "isRequired": true, @@ -349,6 +354,7 @@ } }, { + "id": "def-public.AbstractDashboardDrilldown.getHref.$2", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -387,6 +393,7 @@ "type": "Function", "children": [ { + "id": "def-public.AbstractDashboardDrilldown.execute.$1", "type": "Object", "label": "config", "isRequired": true, @@ -406,6 +413,7 @@ } }, { + "id": "def-public.AbstractDashboardDrilldown.execute.$2", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -879,7 +887,7 @@ "type": "Function", "children": [ { - "id": "def-common.createExtract.{\n- drilldownId,\n}", + "id": "def-common.createExtract.$1.drilldownId", "type": "Object", "label": "{\n drilldownId,\n}", "tags": [], @@ -887,7 +895,7 @@ "children": [ { "tags": [], - "id": "def-common.createExtract.{\n- drilldownId,\n}.drilldownId", + "id": "def-common.createExtract.$1.drilldownId.drilldownId", "type": "string", "label": "drilldownId", "description": [], @@ -939,7 +947,7 @@ "type": "Function", "children": [ { - "id": "def-common.createInject.{\n- drilldownId,\n}", + "id": "def-common.createInject.$1.drilldownId", "type": "Object", "label": "{\n drilldownId,\n}", "tags": [], @@ -947,7 +955,7 @@ "children": [ { "tags": [], - "id": "def-common.createInject.{\n- drilldownId,\n}.drilldownId", + "id": "def-common.createInject.$1.drilldownId.drilldownId", "type": "string", "label": "drilldownId", "description": [], diff --git a/api_docs/dashboard_mode.json b/api_docs/dashboard_mode.json index dab407a79d7c..1ad7905f9a65 100644 --- a/api_docs/dashboard_mode.json +++ b/api_docs/dashboard_mode.json @@ -45,6 +45,7 @@ "description": [], "children": [ { + "id": "def-server.DashboardModeServerPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -90,6 +91,7 @@ "description": [], "children": [ { + "id": "def-server.DashboardModeServerPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -110,6 +112,7 @@ } }, { + "id": "def-server.DashboardModeServerPlugin.setup.$2", "type": "Object", "label": "{ security }", "isRequired": true, @@ -148,6 +151,7 @@ "description": [], "children": [ { + "id": "def-server.DashboardModeServerPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, diff --git a/api_docs/data.json b/api_docs/data.json index a51ad465fe90..629e2aee35eb 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -29,6 +29,7 @@ ], "children": [ { + "id": "def-public.AggConfig.ensureIds.$1", "type": "Array", "label": "list", "isRequired": true, @@ -75,6 +76,7 @@ ], "children": [ { + "id": "def-public.AggConfig.nextId.$1", "type": "Array", "label": "list", "isRequired": true, @@ -221,6 +223,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.Unnamed.$1", "type": "Object", "label": "aggConfigs", "isRequired": true, @@ -240,18 +243,13 @@ } }, { + "id": "def-public.AggConfig.Unnamed.$2", "type": "Object", "label": "opts", "isRequired": true, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", @@ -296,6 +294,7 @@ ], "children": [ { + "id": "def-public.AggConfig.setParams.$1", "type": "Any", "label": "from", "isRequired": true, @@ -330,6 +329,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.getParam.$1", "type": "string", "label": "key", "isRequired": true, @@ -368,6 +368,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.write.$1", "type": "Object", "label": "aggs", "isRequired": false, @@ -421,6 +422,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.createFilter.$1", "type": "string", "label": "key", "isRequired": true, @@ -434,6 +436,7 @@ } }, { + "id": "def-public.AggConfig.createFilter.$2", "type": "Object", "label": "params", "isRequired": true, @@ -482,6 +485,7 @@ ], "children": [ { + "id": "def-public.AggConfig.onSearchRequestStart.$1", "type": "Object", "label": "searchSource", "isRequired": true, @@ -503,6 +507,7 @@ } }, { + "id": "def-public.AggConfig.onSearchRequestStart.$2", "type": "Object", "label": "options", "isRequired": false, @@ -552,6 +557,7 @@ ], "children": [ { + "id": "def-public.AggConfig.toDsl.$1", "type": "Object", "label": "aggConfigs", "isRequired": false, @@ -591,13 +597,7 @@ "label": "serialize", "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; }" ], "description": [], @@ -617,13 +617,7 @@ "label": "toJSON", "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; }" ], "description": [], @@ -773,6 +767,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.getValue.$1", "type": "Any", "label": "bucket", "isRequired": true, @@ -803,6 +798,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.getKey.$1", "type": "Any", "label": "bucket", "isRequired": true, @@ -816,6 +812,7 @@ } }, { + "id": "def-public.AggConfig.getKey.$2", "type": "string", "label": "key", "isRequired": false, @@ -896,6 +893,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.makeLabel.$1", "type": "boolean", "label": "percentageMode", "isRequired": true, @@ -984,7 +982,7 @@ "type": "Function", "label": "fieldIsTimeField", "signature": [ - "() => boolean | \"\" | undefined" + "() => boolean" ], "description": [], "children": [], @@ -1003,7 +1001,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 448 + "lineNumber": 452 }, "signature": [ { @@ -1023,7 +1021,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 452 + "lineNumber": 456 }, "signature": [ { @@ -1053,6 +1051,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfig.setType.$1", "type": "Object", "label": "type", "isRequired": true, @@ -1068,7 +1067,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 482 + "lineNumber": 486 } } ], @@ -1076,7 +1075,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 482 + "lineNumber": 486 } } ], @@ -1134,6 +1133,20 @@ " | undefined" ] }, + { + "tags": [], + "id": "def-public.AggConfigs.timeFields", + "type": "Array", + "label": "timeFields", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67 + }, + "signature": [ + "string[] | undefined" + ] + }, { "tags": [], "id": "def-public.AggConfigs.aggs", @@ -1142,7 +1155,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 69 + "lineNumber": 70 }, "signature": [ { @@ -1165,6 +1178,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.Unnamed.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -1180,22 +1194,17 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 72 + "lineNumber": 73 } }, { + "id": "def-public.AggConfigs.Unnamed.$2", "type": "Array", "label": "configStates", "isRequired": true, "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", @@ -1217,10 +1226,11 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 + "lineNumber": 74 } }, { + "id": "def-public.AggConfigs.Unnamed.$3", "type": "Object", "label": "opts", "isRequired": true, @@ -1236,7 +1246,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 74 + "lineNumber": 75 } } ], @@ -1244,7 +1254,38 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 71 + "lineNumber": 72 + } + }, + { + "id": "def-public.AggConfigs.setTimeFields", + "type": "Function", + "label": "setTimeFields", + "signature": [ + "(timeFields: string[] | undefined) => void" + ], + "description": [], + "children": [ + { + "id": "def-public.AggConfigs.setTimeFields.$1", + "type": "Array", + "label": "timeFields", + "isRequired": false, + "signature": [ + "string[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 87 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 87 } }, { @@ -1265,6 +1306,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.setTimeRange.$1", "type": "Object", "label": "timeRange", "isRequired": true, @@ -1280,7 +1322,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 86 + "lineNumber": 91 } } ], @@ -1288,7 +1330,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 86 + "lineNumber": 91 } }, { @@ -1308,6 +1350,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.clone.$1", "type": "Object", "label": "{ enabledOnly = true }", "isRequired": true, @@ -1317,7 +1360,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 104 + "lineNumber": 109 } } ], @@ -1325,7 +1368,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 104 + "lineNumber": 109 } }, { @@ -1333,18 +1376,13 @@ "type": "Function", "children": [ { + "id": "def-public.AggConfigs.createAggConfig.$1", "type": "Object", "label": "params", "isRequired": true, "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", @@ -1366,10 +1404,11 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 118 + "lineNumber": 123 } }, { + "id": "def-public.AggConfigs.createAggConfig.$2", "type": "Object", "label": "{ addToAggConfigs = true }", "isRequired": true, @@ -1379,7 +1418,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 119 + "lineNumber": 124 } } ], @@ -1401,13 +1440,7 @@ "text": "AggConfig" }, ">(params: Pick & Pick<{ type: string | ", { "pluginId": "data", @@ -1429,7 +1462,7 @@ "label": "createAggConfig", "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 117 + "lineNumber": 122 }, "tags": [], "returnComment": [] @@ -1454,6 +1487,7 @@ ], "children": [ { + "id": "def-public.AggConfigs.jsonDataEquals.$1", "type": "Array", "label": "aggConfigs", "isRequired": true, @@ -1472,7 +1506,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 160 + "lineNumber": 165 } } ], @@ -1480,7 +1514,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 160 + "lineNumber": 165 } }, { @@ -1493,6 +1527,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.toDsl.$1", "type": "boolean", "label": "hierarchical", "isRequired": true, @@ -1502,7 +1537,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 172 + "lineNumber": 177 } } ], @@ -1510,7 +1545,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 172 + "lineNumber": 177 } }, { @@ -1534,7 +1569,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 241 + "lineNumber": 246 } }, { @@ -1554,6 +1589,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.byIndex.$1", "type": "number", "label": "index", "isRequired": true, @@ -1563,7 +1599,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 245 + "lineNumber": 250 } } ], @@ -1571,7 +1607,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 245 + "lineNumber": 250 } }, { @@ -1592,6 +1628,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.byId.$1", "type": "string", "label": "id", "isRequired": true, @@ -1601,7 +1638,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 249 + "lineNumber": 254 } } ], @@ -1609,7 +1646,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 249 + "lineNumber": 254 } }, { @@ -1630,6 +1667,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.byName.$1", "type": "string", "label": "name", "isRequired": true, @@ -1639,7 +1677,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 253 + "lineNumber": 258 } } ], @@ -1647,7 +1685,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 253 + "lineNumber": 258 } }, { @@ -1668,6 +1706,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.byType.$1", "type": "string", "label": "type", "isRequired": true, @@ -1677,7 +1716,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 257 + "lineNumber": 262 } } ], @@ -1685,7 +1724,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 257 + "lineNumber": 262 } }, { @@ -1706,6 +1745,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.byTypeName.$1", "type": "string", "label": "type", "isRequired": true, @@ -1715,7 +1755,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 261 + "lineNumber": 266 } } ], @@ -1723,7 +1763,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 261 + "lineNumber": 266 } }, { @@ -1744,6 +1784,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.bySchemaName.$1", "type": "string", "label": "schema", "isRequired": true, @@ -1753,7 +1794,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 265 + "lineNumber": 270 } } ], @@ -1761,7 +1802,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 265 + "lineNumber": 270 } }, { @@ -1785,7 +1826,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 269 + "lineNumber": 274 } }, { @@ -1806,6 +1847,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.getRequestAggById.$1", "type": "string", "label": "id", "isRequired": true, @@ -1815,7 +1857,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 283 + "lineNumber": 288 } } ], @@ -1823,7 +1865,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 283 + "lineNumber": 288 } }, { @@ -1851,7 +1893,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 298 + "lineNumber": 303 } }, { @@ -1874,6 +1916,7 @@ ], "children": [ { + "id": "def-public.AggConfigs.getResponseAggById.$1", "type": "string", "label": "id", "isRequired": true, @@ -1885,7 +1928,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 312 + "lineNumber": 317 } } ], @@ -1895,7 +1938,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 312 + "lineNumber": 317 } }, { @@ -1924,6 +1967,7 @@ "description": [], "children": [ { + "id": "def-public.AggConfigs.onSearchRequestStart.$1", "type": "Object", "label": "searchSource", "isRequired": true, @@ -1941,10 +1985,11 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 326 } }, { + "id": "def-public.AggConfigs.onSearchRequestStart.$2", "type": "Object", "label": "options", "isRequired": false, @@ -1961,7 +2006,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 326 } } ], @@ -1969,7 +2014,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 326 } } ], @@ -2016,13 +2061,7 @@ }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" ] }, @@ -2050,6 +2089,7 @@ "description": [], "children": [ { + "id": "def-public.AggParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -2129,6 +2169,7 @@ "description": [], "children": [ { + "id": "def-public.DataPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -2170,13 +2211,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataStartDependencies", - "text": "DataStartDependencies" - }, + "DataStartDependencies", ", ", { "pluginId": "data", @@ -2186,13 +2221,7 @@ "text": "DataPublicPluginStart" }, ">, { bfetch, expressions, uiActions, usageCollection, inspector }: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataSetupDependencies", - "text": "DataSetupDependencies" - }, + "DataSetupDependencies", ") => ", { "pluginId": "data", @@ -2205,6 +2234,7 @@ "description": [], "children": [ { + "id": "def-public.DataPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -2217,13 +2247,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataStartDependencies", - "text": "DataStartDependencies" - }, + "DataStartDependencies", ", ", { "pluginId": "data", @@ -2241,17 +2265,12 @@ } }, { + "id": "def-public.DataPublicPlugin.setup.$2", "type": "Object", "label": "{ bfetch, expressions, uiActions, usageCollection, inspector }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataSetupDependencies", - "text": "DataSetupDependencies" - } + "DataSetupDependencies" ], "description": [], "source": { @@ -2281,13 +2300,7 @@ "text": "CoreStart" }, ", { uiActions }: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataStartDependencies", - "text": "DataStartDependencies" - }, + "DataStartDependencies", ") => ", { "pluginId": "data", @@ -2300,6 +2313,7 @@ "description": [], "children": [ { + "id": "def-public.DataPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -2319,17 +2333,12 @@ } }, { + "id": "def-public.DataPublicPlugin.start.$2", "type": "Object", "label": "{ uiActions }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataStartDependencies", - "text": "DataStartDependencies" - } + "DataStartDependencies" ], "description": [], "source": { @@ -2395,6 +2404,7 @@ "description": [], "children": [ { + "id": "def-public.DuplicateIndexPatternError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -2490,13 +2500,7 @@ "lineNumber": 52 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvert", - "text": "FieldFormatConvert" - }, + "FieldFormatConvert", " | undefined" ] }, @@ -2514,13 +2518,7 @@ "lineNumber": 60 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeConvert", - "text": "HtmlContextTypeConvert" - }, + "HtmlContextTypeConvert", " | undefined" ] }, @@ -2538,13 +2536,7 @@ "lineNumber": 68 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.TextContextTypeConvert", - "text": "TextContextTypeConvert" - }, + "TextContextTypeConvert", " | undefined" ] }, @@ -2624,17 +2616,12 @@ "description": [], "children": [ { + "id": "def-public.FieldFormat.Unnamed.$1", "type": "Object", "label": "_params", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.IFieldFormatMetaParams", - "text": "IFieldFormatMetaParams" - } + "IFieldFormatMetaParams" ], "description": [], "source": { @@ -2643,6 +2630,7 @@ } }, { + "id": "def-public.FieldFormat.Unnamed.$2", "type": "Function", "label": "getConfig", "isRequired": false, @@ -2684,13 +2672,7 @@ "text": "FieldFormatsContentType" }, ", options?: Record | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined) => string" ], "description": [ @@ -2698,6 +2680,7 @@ ], "children": [ { + "id": "def-public.FieldFormat.convert.$1", "type": "Any", "label": "value", "isRequired": true, @@ -2711,6 +2694,7 @@ } }, { + "id": "def-public.FieldFormat.convert.$2", "type": "CompoundType", "label": "contentType", "isRequired": true, @@ -2732,18 +2716,13 @@ } }, { + "id": "def-public.FieldFormat.convert.$3", "type": "CompoundType", "label": "options", "isRequired": false, "signature": [ "Record | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined" ], "description": [], @@ -2779,19 +2758,14 @@ "text": "FieldFormatsContentType" }, ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" - } + "FieldFormatConvertFunction" ], "description": [ "\nGet a convert function that is bound to a specific contentType" ], "children": [ { + "id": "def-public.FieldFormat.getConverterFor.$1", "type": "CompoundType", "label": "contentType", "isRequired": true, @@ -2858,6 +2832,7 @@ ], "children": [ { + "id": "def-public.FieldFormat.param.$1", "type": "string", "label": "name", "isRequired": true, @@ -2943,17 +2918,12 @@ "description": [], "children": [ { + "id": "def-public.FieldFormat.from.$1", "type": "Function", "label": "convertFn", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" - } + "FieldFormatConvertFunction" ], "description": [], "source": { @@ -2975,13 +2945,7 @@ "label": "setupContentType", "signature": [ "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvert", - "text": "FieldFormatConvert" - } + "FieldFormatConvert" ], "description": [], "children": [], @@ -3010,6 +2974,7 @@ "description": [], "children": [ { + "id": "def-public.FieldFormat.isInstanceOfFieldFormat.$1", "type": "Any", "label": "fieldFormat", "isRequired": true, @@ -3314,6 +3279,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPattern.Unnamed.$1", "type": "Object", "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", "isRequired": true, @@ -3473,6 +3439,7 @@ ], "children": [ { + "id": "def-public.IndexPattern.addScriptedField.$1", "type": "string", "label": "name", "isRequired": true, @@ -3488,6 +3455,7 @@ } }, { + "id": "def-public.IndexPattern.addScriptedField.$2", "type": "string", "label": "script", "isRequired": true, @@ -3503,6 +3471,7 @@ } }, { + "id": "def-public.IndexPattern.addScriptedField.$3", "type": "string", "label": "fieldType", "isRequired": true, @@ -3535,6 +3504,7 @@ ], "children": [ { + "id": "def-public.IndexPattern.removeScriptedField.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -3677,6 +3647,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPattern.getFieldByName.$1", "type": "string", "label": "name", "isRequired": true, @@ -3774,6 +3745,7 @@ ], "children": [ { + "id": "def-public.IndexPattern.getFormatterForField.$1", "type": "CompoundType", "label": "field", "isRequired": true, @@ -3836,6 +3808,7 @@ ], "children": [ { + "id": "def-public.IndexPattern.addRuntimeField.$1", "type": "string", "label": "name", "isRequired": true, @@ -3851,6 +3824,7 @@ } }, { + "id": "def-public.IndexPattern.addRuntimeField.$2", "type": "Object", "label": "runtimeField", "isRequired": true, @@ -3891,6 +3865,7 @@ ], "children": [ { + "id": "def-public.IndexPattern.removeRuntimeField.$1", "type": "string", "label": "name", "isRequired": true, @@ -3933,6 +3908,7 @@ ], "children": [ { + "id": "def-public.IndexPattern.getFormatterForFieldNoDefault.$1", "type": "string", "label": "fieldname", "isRequired": true, @@ -3971,6 +3947,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPattern.setFieldAttrs.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -3984,6 +3961,7 @@ } }, { + "id": "def-public.IndexPattern.setFieldAttrs.$2", "type": "Uncategorized", "label": "attrName", "isRequired": true, @@ -3997,6 +3975,7 @@ } }, { + "id": "def-public.IndexPattern.setFieldAttrs.$3", "type": "Uncategorized", "label": "value", "isRequired": true, @@ -4034,6 +4013,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPattern.setFieldCustomLabel.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -4047,6 +4027,7 @@ } }, { + "id": "def-public.IndexPattern.setFieldCustomLabel.$2", "type": "CompoundType", "label": "customLabel", "isRequired": false, @@ -4077,6 +4058,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPattern.setFieldCount.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -4090,6 +4072,7 @@ } }, { + "id": "def-public.IndexPattern.setFieldCount.$2", "type": "CompoundType", "label": "count", "isRequired": false, @@ -4115,6 +4098,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPattern.setFieldFormat.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -4128,6 +4112,7 @@ } }, { + "id": "def-public.IndexPattern.setFieldFormat.$2", "type": "Object", "label": "format", "isRequired": true, @@ -4173,6 +4158,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPattern.deleteFieldFormat.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -4259,6 +4245,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPatternField.Unnamed.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -4719,7 +4706,7 @@ "description": [], "children": [ { - "id": "def-public.IndexPatternField.toSpec.{\n- getFormatterForField,\n }", + "id": "def-public.IndexPatternField.toSpec.$1.getFormatterForField", "type": "Object", "label": "{\n getFormatterForField,\n }", "tags": [], @@ -4727,7 +4714,7 @@ "children": [ { "tags": [], - "id": "def-public.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField", + "id": "def-public.IndexPatternField.toSpec.$1.getFormatterForField.getFormatterForField", "type": "Function", "label": "getFormatterForField", "description": [], @@ -4810,13 +4797,7 @@ "lineNumber": 67 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.EnsureDefaultIndexPattern", - "text": "EnsureDefaultIndexPattern" - } + "EnsureDefaultIndexPattern" ] }, { @@ -4829,6 +4810,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPatternsService.Unnamed.$1", "type": "Object", "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, @@ -4854,6 +4836,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.getIds.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -4886,6 +4869,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.getTitles.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -4918,6 +4902,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.find.$1", "type": "string", "label": "search", "isRequired": true, @@ -4931,6 +4916,7 @@ } }, { + "id": "def-public.IndexPatternsService.find.$2", "type": "number", "label": "size", "isRequired": true, @@ -4973,6 +4959,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -5005,6 +4992,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.clearCache.$1", "type": "string", "label": "id", "isRequired": false, @@ -5038,21 +5026,9 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSavedObjectAttrs", - "text": "IndexPatternSavedObjectAttrs" - }, + "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], "description": [], @@ -5095,6 +5071,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.setDefault.$1", "type": "string", "label": "id", "isRequired": true, @@ -5108,6 +5085,7 @@ } }, { + "id": "def-public.IndexPatternsService.setDefault.$2", "type": "boolean", "label": "force", "isRequired": true, @@ -5140,6 +5118,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", "label": "options", "isRequired": true, @@ -5188,6 +5167,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", "label": "indexPattern", "isRequired": true, @@ -5215,6 +5195,7 @@ } }, { + "id": "def-public.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", "label": "options", "isRequired": false, @@ -5280,6 +5261,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.refreshFields.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -5326,6 +5308,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", "label": "fields", "isRequired": true, @@ -5346,6 +5329,7 @@ } }, { + "id": "def-public.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", "label": "fieldAttrs", "isRequired": false, @@ -5411,17 +5395,12 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -5441,13 +5420,7 @@ ], "signature": [ "(savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -5483,6 +5456,7 @@ "type": "Function", "children": [ { + "id": "def-public.IndexPatternsService.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -5546,6 +5520,7 @@ ], "children": [ { + "id": "def-public.IndexPatternsService.create.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -5565,6 +5540,7 @@ } }, { + "id": "def-public.IndexPatternsService.create.$2", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -5615,6 +5591,7 @@ ], "children": [ { + "id": "def-public.IndexPatternsService.createAndSave.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -5634,6 +5611,7 @@ } }, { + "id": "def-public.IndexPatternsService.createAndSave.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -5649,6 +5627,7 @@ } }, { + "id": "def-public.IndexPatternsService.createAndSave.$3", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -5699,6 +5678,7 @@ ], "children": [ { + "id": "def-public.IndexPatternsService.createSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -5718,6 +5698,7 @@ } }, { + "id": "def-public.IndexPatternsService.createSavedObject.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -5760,6 +5741,7 @@ ], "children": [ { + "id": "def-public.IndexPatternsService.updateSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -5775,10 +5757,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 548 + "lineNumber": 551 } }, { + "id": "def-public.IndexPatternsService.updateSavedObject.$2", "type": "number", "label": "saveAttempts", "isRequired": true, @@ -5788,10 +5771,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 549 + "lineNumber": 552 } }, { + "id": "def-public.IndexPatternsService.updateSavedObject.$3", "type": "boolean", "label": "ignoreErrors", "isRequired": true, @@ -5801,7 +5785,7 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 + "lineNumber": 553 } } ], @@ -5809,7 +5793,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 547 + "lineNumber": 550 } }, { @@ -5824,6 +5808,7 @@ ], "children": [ { + "id": "def-public.IndexPatternsService.delete.$1", "type": "string", "label": "indexPatternId", "isRequired": true, @@ -5835,7 +5820,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -5843,7 +5828,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -5917,6 +5902,7 @@ "description": [], "children": [ { + "id": "def-public.OptionedParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -5977,6 +5963,7 @@ "description": [], "children": [ { + "id": "def-public.SearchSource.Unnamed.$1", "type": "Object", "label": "fields", "isRequired": true, @@ -5996,6 +5983,7 @@ } }, { + "id": "def-public.SearchSource.Unnamed.$2", "type": "Object", "label": "dependencies", "isRequired": true, @@ -6034,6 +6022,7 @@ ], "children": [ { + "id": "def-public.SearchSource.setPreferredSearchStrategyId.$1", "type": "string", "label": "searchStrategyId", "isRequired": true, @@ -6074,6 +6063,7 @@ ], "children": [ { + "id": "def-public.SearchSource.setField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6089,6 +6079,7 @@ } }, { + "id": "def-public.SearchSource.setField.$2", "type": "Uncategorized", "label": "value", "isRequired": true, @@ -6130,6 +6121,7 @@ ], "children": [ { + "id": "def-public.SearchSource.removeField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6172,6 +6164,7 @@ ], "children": [ { + "id": "def-public.SearchSource.setFields.$1", "type": "Object", "label": "newFields", "isRequired": true, @@ -6265,6 +6258,7 @@ ], "children": [ { + "id": "def-public.SearchSource.getField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6278,6 +6272,7 @@ } }, { + "id": "def-public.SearchSource.getField.$2", "type": "boolean", "label": "recurse", "isRequired": true, @@ -6318,6 +6313,7 @@ ], "children": [ { + "id": "def-public.SearchSource.getOwnField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6407,6 +6403,7 @@ ], "children": [ { + "id": "def-public.SearchSource.createChild.$1", "type": "Object", "label": "options", "isRequired": true, @@ -6455,6 +6452,7 @@ ], "children": [ { + "id": "def-public.SearchSource.setParent.$1", "type": "Object", "label": "parent", "isRequired": false, @@ -6478,6 +6476,7 @@ } }, { + "id": "def-public.SearchSource.setParent.$2", "type": "Object", "label": "options", "isRequired": true, @@ -6562,6 +6561,7 @@ ], "children": [ { + "id": "def-public.SearchSource.fetch$.$1", "type": "Object", "label": "options", "isRequired": true, @@ -6610,6 +6610,7 @@ ], "children": [ { + "id": "def-public.SearchSource.fetch.$1", "type": "Object", "label": "options", "isRequired": true, @@ -6666,6 +6667,7 @@ ], "children": [ { + "id": "def-public.SearchSource.onRequestStart.$1", "type": "Function", "label": "handler", "isRequired": true, @@ -6761,6 +6763,7 @@ ], "children": [ { + "id": "def-public.SearchSource.getSerializedFields.$1", "type": "boolean", "label": "recurse", "isRequired": true, @@ -6787,13 +6790,7 @@ "label": "serialize", "signature": [ "() => { searchSourceJSON: string; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [ @@ -6823,6 +6820,7 @@ "type": "Function", "children": [ { + "id": "def-public.castEsToKbnFieldTypeName.$1", "type": "string", "label": "esType", "isRequired": true, @@ -6865,6 +6863,7 @@ "type": "Function", "children": [ { + "id": "def-public.extractReferences.$1", "type": "Object", "label": "state", "isRequired": true, @@ -6920,6 +6919,7 @@ "type": "Function", "children": [ { + "id": "def-public.fieldList.$1", "type": "Array", "label": "specs", "isRequired": true, @@ -6940,6 +6940,7 @@ } }, { + "id": "def-public.fieldList.$2", "type": "boolean", "label": "shortDotsEnable", "isRequired": true, @@ -7027,6 +7028,7 @@ "description": [], "children": [ { + "id": "def-public.getSearchParamsFromRequest.$1", "type": "Object", "label": "searchRequest", "isRequired": true, @@ -7040,7 +7042,7 @@ } }, { - "id": "def-public.getSearchParamsFromRequest.dependencies", + "id": "def-public.getSearchParamsFromRequest.$2.dependencies", "type": "Object", "label": "dependencies", "tags": [], @@ -7048,7 +7050,7 @@ "children": [ { "tags": [], - "id": "def-public.getSearchParamsFromRequest.dependencies.getConfig", + "id": "def-public.getSearchParamsFromRequest.$2.dependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], @@ -7117,6 +7119,7 @@ "description": [], "children": [ { + "id": "def-public.getTime.$1", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -7137,6 +7140,7 @@ } }, { + "id": "def-public.getTime.$2", "type": "Object", "label": "timeRange", "isRequired": true, @@ -7156,7 +7160,7 @@ } }, { - "id": "def-public.getTime.options", + "id": "def-public.getTime.$3.options", "type": "Object", "label": "options", "tags": [], @@ -7164,7 +7168,7 @@ "children": [ { "tags": [], - "id": "def-public.getTime.options.forceNow", + "id": "def-public.getTime.$3.options.forceNow", "type": "Object", "label": "forceNow", "description": [], @@ -7178,7 +7182,7 @@ }, { "tags": [], - "id": "def-public.getTime.options.fieldName", + "id": "def-public.getTime.$3.options.fieldName", "type": "string", "label": "fieldName", "description": [], @@ -7210,6 +7214,7 @@ "type": "Function", "children": [ { + "id": "def-public.injectReferences.$1", "type": "CompoundType", "label": "searchSourceFields", "isRequired": true, @@ -7230,17 +7235,12 @@ } }, { + "id": "def-public.injectReferences.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -7285,6 +7285,7 @@ "type": "Function", "children": [ { + "id": "def-public.isCompleteResponse.$1", "type": "Object", "label": "response", "isRequired": false, @@ -7333,6 +7334,7 @@ "type": "Function", "children": [ { + "id": "def-public.isErrorResponse.$1", "type": "Object", "label": "response", "isRequired": false, @@ -7381,6 +7383,7 @@ "type": "Function", "children": [ { + "id": "def-public.isFilter.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -7419,6 +7422,7 @@ "type": "Function", "children": [ { + "id": "def-public.isFilters.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -7458,6 +7462,7 @@ "type": "Function", "children": [ { + "id": "def-public.isPartialResponse.$1", "type": "Object", "label": "response", "isRequired": false, @@ -7506,6 +7511,7 @@ "type": "Function", "children": [ { + "id": "def-public.isQuery.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -7544,6 +7550,7 @@ "type": "Function", "children": [ { + "id": "def-public.isTimeRange.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -7582,6 +7589,7 @@ "type": "Function", "children": [ { + "id": "def-public.parseSearchSourceJSON.$1", "type": "string", "label": "searchSourceJSON", "isRequired": true, @@ -7634,7 +7642,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 207 + "lineNumber": 196 }, "signature": [ "FunctionDefinition" @@ -7648,7 +7656,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 + "lineNumber": 197 }, "signature": [ "FunctionDefinition" @@ -7662,7 +7670,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 209 + "lineNumber": 198 }, "signature": [ "FunctionDefinition" @@ -7676,7 +7684,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 210 + "lineNumber": 199 }, "signature": [ "FunctionDefinition" @@ -7690,7 +7698,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 211 + "lineNumber": 200 }, "signature": [ "FunctionDefinition" @@ -7704,7 +7712,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 212 + "lineNumber": 201 }, "signature": [ "FunctionDefinition" @@ -7718,7 +7726,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 + "lineNumber": 202 }, "signature": [ "FunctionDefinition" @@ -7732,7 +7740,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 214 + "lineNumber": 203 }, "signature": [ "FunctionDefinition" @@ -7746,7 +7754,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 215 + "lineNumber": 204 }, "signature": [ "FunctionDefinition" @@ -7760,7 +7768,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 216 + "lineNumber": 205 }, "signature": [ "FunctionDefinition" @@ -7774,7 +7782,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 217 + "lineNumber": 206 }, "signature": [ "FunctionDefinition" @@ -7788,7 +7796,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 218 + "lineNumber": 207 }, "signature": [ "FunctionDefinition" @@ -7802,7 +7810,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 219 + "lineNumber": 208 }, "signature": [ "FunctionDefinition" @@ -7816,7 +7824,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 220 + "lineNumber": 209 }, "signature": [ "FunctionDefinition" @@ -7830,7 +7838,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 221 + "lineNumber": 210 }, "signature": [ "FunctionDefinition" @@ -7844,7 +7852,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 222 + "lineNumber": 211 }, "signature": [ "FunctionDefinition" @@ -7858,7 +7866,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 223 + "lineNumber": 212 }, "signature": [ "FunctionDefinition" @@ -7872,7 +7880,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 224 + "lineNumber": 213 }, "signature": [ "FunctionDefinition" @@ -7886,7 +7894,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 225 + "lineNumber": 214 }, "signature": [ "FunctionDefinition" @@ -7900,7 +7908,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 226 + "lineNumber": 215 }, "signature": [ "FunctionDefinition" @@ -7914,7 +7922,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 227 + "lineNumber": 216 }, "signature": [ "FunctionDefinition" @@ -7928,7 +7936,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 228 + "lineNumber": 217 }, "signature": [ "FunctionDefinition" @@ -7942,7 +7950,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 229 + "lineNumber": 218 }, "signature": [ "FunctionDefinition" @@ -7956,7 +7964,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 230 + "lineNumber": 219 }, "signature": [ "FunctionDefinition" @@ -7970,7 +7978,21 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 231 + "lineNumber": 220 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggSinglePercentile", + "type": "Object", + "label": "aggSinglePercentile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221 }, "signature": [ "FunctionDefinition" @@ -7984,7 +8006,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 232 + "lineNumber": 222 }, "signature": [ "FunctionDefinition" @@ -7998,7 +8020,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 233 + "lineNumber": 223 }, "signature": [ "FunctionDefinition" @@ -8012,7 +8034,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 234 + "lineNumber": 224 }, "signature": [ "FunctionDefinition" @@ -8026,7 +8048,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 235 + "lineNumber": 225 }, "signature": [ "FunctionDefinition" @@ -8040,7 +8062,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 236 + "lineNumber": 226 }, "signature": [ "FunctionDefinition" @@ -8054,7 +8076,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 237 + "lineNumber": 227 }, "signature": [ "FunctionDefinition" @@ -8068,7 +8090,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 238 + "lineNumber": 228 }, "signature": [ "FunctionDefinition" @@ -8082,7 +8104,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 239 + "lineNumber": 229 }, "signature": [ "FunctionDefinition" @@ -8091,7 +8113,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 206 + "lineNumber": 195 }, "initialIsOpen": false }, @@ -8142,6 +8164,7 @@ "description": [], "children": [ { + "id": "def-public.AggParamOption.enabled.$1", "type": "Object", "label": "agg", "isRequired": true, @@ -8259,13 +8282,7 @@ }, "signature": [ "({ data, negate, }: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.ValueClickDataContext", - "text": "ValueClickDataContext" - }, + "ValueClickDataContext", ") => Promise<", { "pluginId": "data", @@ -8289,13 +8306,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.createFiltersFromRangeSelectAction", - "text": "createFiltersFromRangeSelectAction" - } + "createFiltersFromRangeSelectAction" ] } ], @@ -9298,6 +9309,7 @@ "description": [], "children": [ { + "id": "def-public.IIndexPatternFieldList.add.$1", "type": "Object", "label": "field", "isRequired": true, @@ -9366,6 +9378,7 @@ "description": [], "children": [ { + "id": "def-public.IIndexPatternFieldList.getByName.$1", "type": "string", "label": "name", "isRequired": true, @@ -9404,6 +9417,7 @@ "description": [], "children": [ { + "id": "def-public.IIndexPatternFieldList.getByType.$1", "type": "string", "label": "type", "isRequired": true, @@ -9442,6 +9456,7 @@ "description": [], "children": [ { + "id": "def-public.IIndexPatternFieldList.remove.$1", "type": "Object", "label": "field", "isRequired": true, @@ -9502,6 +9517,7 @@ "description": [], "children": [ { + "id": "def-public.IIndexPatternFieldList.replaceAll.$1", "type": "Array", "label": "specs", "isRequired": true, @@ -9547,6 +9563,7 @@ "description": [], "children": [ { + "id": "def-public.IIndexPatternFieldList.update.$1", "type": "Object", "label": "field", "isRequired": true, @@ -9622,7 +9639,7 @@ "description": [], "children": [ { - "id": "def-public.IIndexPatternFieldList.toSpec.options", + "id": "def-public.IIndexPatternFieldList.toSpec.$1.options", "type": "Object", "label": "options", "tags": [], @@ -9630,7 +9647,7 @@ "children": [ { "tags": [], - "id": "def-public.IIndexPatternFieldList.toSpec.options.getFormatterForField", + "id": "def-public.IIndexPatternFieldList.toSpec.$1.options.getFormatterForField", "type": "Function", "label": "getFormatterForField", "description": [], @@ -11420,10 +11437,18 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 141 + "lineNumber": 129 }, "signature": [ - "{ calculateAutoTimeExpression: (range: TimeRange) => string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", { @@ -11523,6 +11548,54 @@ ], "initialIsOpen": false }, + { + "id": "def-public.EsdslExpressionFunctionDefinition", + "type": "Type", + "label": "EsdslExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 29 + }, + "signature": [ + "ExpressionFunctionDefinition<\"esdsl\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + "> | null, Arguments, Output, ", + { + "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" + ], + "initialIsOpen": false + }, { "id": "def-public.EsQuerySortValue", "type": "Type", @@ -11538,6 +11611,21 @@ ], "initialIsOpen": false }, + { + "id": "def-public.EsRawResponseExpressionTypeDefinition", + "type": "Type", + "label": "EsRawResponseExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 57 + }, + "signature": [ + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + ], + "initialIsOpen": false + }, { "id": "def-public.ExecutionContextSearch", "type": "Type", @@ -11816,7 +11904,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 21 + "lineNumber": 24 }, "signature": [ "FieldParamType" @@ -11879,10 +11967,10 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 639 + "lineNumber": 642 }, "signature": [ - "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; find: (search: string, size?: number) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + "{ get: (id: string) => Promise; 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; setDefault: (id: string, 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; }" ], "initialIsOpen": false }, @@ -12095,7 +12183,7 @@ "children": [ { "tags": [], - "id": "def-public.AggGroupLabels.[AggGroupNames.Buckets]", + "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", "type": "string", "label": "[AggGroupNames.Buckets]", "description": [], @@ -12106,7 +12194,7 @@ }, { "tags": [], - "id": "def-public.AggGroupLabels.[AggGroupNames.Metrics]", + "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", "type": "string", "label": "[AggGroupNames.Metrics]", "description": [], @@ -12117,7 +12205,7 @@ }, { "tags": [], - "id": "def-public.AggGroupLabels.[AggGroupNames.None]", + "id": "def-public.AggGroupLabels.AggGroupNames.None", "type": "string", "label": "[AggGroupNames.None]", "description": [], @@ -12167,13 +12255,7 @@ }, "signature": [ "(props: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.FilterLabelProps", - "text": "FilterLabelProps" - }, + "FilterLabelProps", ") => JSX.Element" ] }, @@ -12189,13 +12271,7 @@ }, "signature": [ "(props: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.FilterItemProps", - "text": "FilterItemProps" - }, + "FilterItemProps", ") => JSX.Element" ] }, @@ -12817,13 +12893,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.generateFilters", - "text": "generateFilters" - } + "generateFilters" ] }, { @@ -12868,13 +12938,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.changeTimeFilter", - "text": "changeTimeFilter" - } + "changeTimeFilter" ] }, { @@ -12889,13 +12953,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.convertRangeFilterToTimeRangeString", - "text": "convertRangeFilterToTimeRangeString" - } + "convertRangeFilterToTimeRangeString" ] }, { @@ -12940,13 +12998,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.extractTimeFilter", - "text": "extractTimeFilter" - } + "extractTimeFilter" ] }, { @@ -12961,13 +13013,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.extractTimeRange", - "text": "extractTimeRange" - } + "extractTimeRange" ] } ], @@ -12995,13 +13041,7 @@ "lineNumber": 124 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.NodeTypes", - "text": "NodeTypes" - } + "NodeTypes" ] }, { @@ -13466,13 +13506,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-public.DateFormat", - "text": "DateFormat" - } + "DateFormat" ] }, { @@ -13487,13 +13521,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.DateNanosFormat", - "text": "DateNanosFormat" - } + "DateNanosFormat" ] }, { @@ -13867,13 +13895,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.validateIndexPattern", - "text": "validateIndexPattern" - } + "validateIndexPattern" ] }, { @@ -13888,13 +13910,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.flattenHitWrapper", - "text": "flattenHitWrapper" - } + "flattenHitWrapper" ] }, { @@ -13909,13 +13925,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.formatHitProvider", - "text": "formatHitProvider" - } + "formatHitProvider" ] } ], @@ -13945,7 +13955,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 405 + "lineNumber": 408 }, "signature": [ "typeof ", @@ -13966,7 +13976,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 406 + "lineNumber": 409 }, "signature": [ "typeof ", @@ -13987,7 +13997,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 407 + "lineNumber": 410 }, "signature": [ "({ display: string; val: string; enabled(agg: ", @@ -13998,7 +14008,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" + "): boolean; } | { display: string; val: string; })[]" ] }, { @@ -14009,7 +14019,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 408 + "lineNumber": 411 }, "signature": [ "typeof ", @@ -14030,7 +14040,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 409 + "lineNumber": 412 }, "signature": [ "typeof ", @@ -14051,7 +14061,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 410 + "lineNumber": 413 }, "signature": [ "typeof ", @@ -14072,7 +14082,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 411 + "lineNumber": 414 }, "signature": [ "typeof ", @@ -14093,7 +14103,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 412 + "lineNumber": 415 }, "signature": [ "(agg: ", @@ -14115,7 +14125,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 413 + "lineNumber": 416 }, "signature": [ "(agg: ", @@ -14137,7 +14147,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 414 + "lineNumber": 417 }, "signature": [ "(...types: string[]) => (agg: ", @@ -14159,7 +14169,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 415 + "lineNumber": 418 }, "signature": [ "typeof ", @@ -14180,7 +14190,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 416 + "lineNumber": 419 }, "signature": [ "typeof ", @@ -14201,7 +14211,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 417 + "lineNumber": 420 } }, { @@ -14212,7 +14222,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 418 + "lineNumber": 421 }, "signature": [ "typeof ", @@ -14233,7 +14243,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 419 + "lineNumber": 422 }, "signature": [ "typeof ", @@ -14254,7 +14264,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 420 + "lineNumber": 423 }, "signature": [ "typeof ", @@ -14275,7 +14285,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 421 + "lineNumber": 424 } }, { @@ -14286,7 +14296,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 422 + "lineNumber": 425 }, "signature": [ "string[]" @@ -14300,7 +14310,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 423 + "lineNumber": 426 }, "signature": [ "typeof ", @@ -14321,7 +14331,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 424 + "lineNumber": 427 }, "signature": [ "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" @@ -14335,7 +14345,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 425 + "lineNumber": 428 }, "signature": [ "(column: ", @@ -14348,13 +14358,43 @@ }, ") => number | undefined" ] + }, + { + "tags": [], + "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn", + "type": "Function", + "label": "getDateHistogramMetaDataByDatatableColumn", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 429 + }, + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => { interval: string | undefined; timeZone: string | undefined; timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; } | undefined" + ] } ], "description": [], "label": "aggs", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 404 + "lineNumber": 407 } }, { @@ -14365,7 +14405,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 427 + "lineNumber": 431 }, "signature": [ "typeof ", @@ -14386,7 +14426,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 428 + "lineNumber": 432 }, "signature": [ "typeof ", @@ -14407,7 +14447,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 429 + "lineNumber": 433 }, "signature": [ "typeof ", @@ -14428,7 +14468,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 430 + "lineNumber": 434 }, "signature": [ "typeof ", @@ -14446,7 +14486,7 @@ "label": "search", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 403 + "lineNumber": 406 }, "initialIsOpen": false }, @@ -14458,7 +14498,7 @@ "description": [], "source": { "path": "src/plugins/data/common/constants.ts", - "lineNumber": 11 + "lineNumber": 12 }, "signature": [ "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" @@ -14548,32 +14588,20 @@ "source": { "path": "src/plugins/data/public/types.ts", "lineNumber": 49 - }, - "signature": [ - "{ filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: Pick<", + }, + "signature": [ + "{ filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringManager", - "text": "QueryStringManager" + "section": "def-public.FilterManager", + "text": "FilterManager" }, + "; timefilter: ", + "TimefilterSetup", + "; queryString: Pick<", + "QueryStringManager", ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ", "Observable", "<{ changes: ", @@ -14647,13 +14675,7 @@ "text": "QuerySuggestionGetFn" }, "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.ValueSuggestionsGetFn", - "text": "ValueSuggestionsGetFn" - }, + "ValueSuggestionsGetFn", "; }" ] }, @@ -14678,7 +14700,7 @@ "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, - ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ] }, { @@ -14755,13 +14777,7 @@ "text": "FilterManager" }, "; queryString: Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringManager", - "text": "QueryStringManager" - }, + "QueryStringManager", ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", { "pluginId": "data", @@ -14808,13 +14824,7 @@ }, "signature": [ "Pick, \"get\">" ] } @@ -14866,13 +14876,7 @@ }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" ] }, @@ -14900,6 +14904,7 @@ "description": [], "children": [ { + "id": "def-server.AggParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -14979,6 +14984,7 @@ "description": [], "children": [ { + "id": "def-server.DataServerPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -14995,7 +15001,7 @@ "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 69 + "lineNumber": 71 } } ], @@ -15003,7 +15009,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 69 + "lineNumber": 71 } }, { @@ -15020,13 +15026,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStartDependencies", - "text": "DataPluginStartDependencies" - }, + "DataPluginStartDependencies", ", ", { "pluginId": "data", @@ -15036,25 +15036,14 @@ "text": "DataPluginStart" }, ">, { bfetch, expressions, usageCollection }: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginSetupDependencies", - "text": "DataPluginSetupDependencies" - }, + "DataPluginSetupDependencies", ") => { __enhance: (enhancements: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataEnhancements", - "text": "DataEnhancements" - } + "DataEnhancements" ], "description": [], "children": [ { + "id": "def-server.DataServerPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -15067,13 +15056,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStartDependencies", - "text": "DataPluginStartDependencies" - }, + "DataPluginStartDependencies", ", ", { "pluginId": "data", @@ -15087,26 +15070,21 @@ "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 78 + "lineNumber": 80 } }, { + "id": "def-server.DataServerPlugin.setup.$2", "type": "Object", "label": "{ bfetch, expressions, usageCollection }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginSetupDependencies", - "text": "DataPluginSetupDependencies" - } + "DataPluginSetupDependencies" ], "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 79 + "lineNumber": 81 } } ], @@ -15114,7 +15092,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 77 + "lineNumber": 79 } }, { @@ -15154,7 +15132,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, elasticsearchClient: ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, elasticsearchClient: ", { "pluginId": "core", "scope": "server", @@ -15166,6 +15144,7 @@ "description": [], "children": [ { + "id": "def-server.DataServerPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -15181,7 +15160,7 @@ "description": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 104 + "lineNumber": 110 } } ], @@ -15189,7 +15168,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 104 + "lineNumber": 110 } }, { @@ -15205,13 +15184,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 118 + "lineNumber": 124 } } ], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 52 + "lineNumber": 54 }, "initialIsOpen": false }, @@ -15492,6 +15471,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPattern.Unnamed.$1", "type": "Object", "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", "isRequired": true, @@ -15651,6 +15631,7 @@ ], "children": [ { + "id": "def-server.IndexPattern.addScriptedField.$1", "type": "string", "label": "name", "isRequired": true, @@ -15666,6 +15647,7 @@ } }, { + "id": "def-server.IndexPattern.addScriptedField.$2", "type": "string", "label": "script", "isRequired": true, @@ -15681,6 +15663,7 @@ } }, { + "id": "def-server.IndexPattern.addScriptedField.$3", "type": "string", "label": "fieldType", "isRequired": true, @@ -15713,6 +15696,7 @@ ], "children": [ { + "id": "def-server.IndexPattern.removeScriptedField.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -15855,6 +15839,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPattern.getFieldByName.$1", "type": "string", "label": "name", "isRequired": true, @@ -15952,6 +15937,7 @@ ], "children": [ { + "id": "def-server.IndexPattern.getFormatterForField.$1", "type": "CompoundType", "label": "field", "isRequired": true, @@ -16014,6 +16000,7 @@ ], "children": [ { + "id": "def-server.IndexPattern.addRuntimeField.$1", "type": "string", "label": "name", "isRequired": true, @@ -16029,6 +16016,7 @@ } }, { + "id": "def-server.IndexPattern.addRuntimeField.$2", "type": "Object", "label": "runtimeField", "isRequired": true, @@ -16069,6 +16057,7 @@ ], "children": [ { + "id": "def-server.IndexPattern.removeRuntimeField.$1", "type": "string", "label": "name", "isRequired": true, @@ -16111,6 +16100,7 @@ ], "children": [ { + "id": "def-server.IndexPattern.getFormatterForFieldNoDefault.$1", "type": "string", "label": "fieldname", "isRequired": true, @@ -16149,6 +16139,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPattern.setFieldAttrs.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -16162,6 +16153,7 @@ } }, { + "id": "def-server.IndexPattern.setFieldAttrs.$2", "type": "Uncategorized", "label": "attrName", "isRequired": true, @@ -16175,6 +16167,7 @@ } }, { + "id": "def-server.IndexPattern.setFieldAttrs.$3", "type": "Uncategorized", "label": "value", "isRequired": true, @@ -16212,6 +16205,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPattern.setFieldCustomLabel.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -16225,6 +16219,7 @@ } }, { + "id": "def-server.IndexPattern.setFieldCustomLabel.$2", "type": "CompoundType", "label": "customLabel", "isRequired": false, @@ -16255,6 +16250,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPattern.setFieldCount.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -16268,6 +16264,7 @@ } }, { + "id": "def-server.IndexPattern.setFieldCount.$2", "type": "CompoundType", "label": "count", "isRequired": false, @@ -16293,6 +16290,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPattern.setFieldFormat.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -16306,6 +16304,7 @@ } }, { + "id": "def-server.IndexPattern.setFieldFormat.$2", "type": "Object", "label": "format", "isRequired": true, @@ -16351,6 +16350,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPattern.deleteFieldFormat.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -16401,13 +16401,7 @@ "lineNumber": 67 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.EnsureDefaultIndexPattern", - "text": "EnsureDefaultIndexPattern" - } + "EnsureDefaultIndexPattern" ] }, { @@ -16420,6 +16414,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPatternsService.Unnamed.$1", "type": "Object", "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, @@ -16445,6 +16440,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getIds.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -16477,6 +16473,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getTitles.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -16509,6 +16506,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.find.$1", "type": "string", "label": "search", "isRequired": true, @@ -16522,6 +16520,7 @@ } }, { + "id": "def-server.IndexPatternsService.find.$2", "type": "number", "label": "size", "isRequired": true, @@ -16564,6 +16563,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -16596,6 +16596,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.clearCache.$1", "type": "string", "label": "id", "isRequired": false, @@ -16629,21 +16630,9 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSavedObjectAttrs", - "text": "IndexPatternSavedObjectAttrs" - }, + "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], "description": [], @@ -16686,6 +16675,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.setDefault.$1", "type": "string", "label": "id", "isRequired": true, @@ -16699,6 +16689,7 @@ } }, { + "id": "def-server.IndexPatternsService.setDefault.$2", "type": "boolean", "label": "force", "isRequired": true, @@ -16731,6 +16722,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", "label": "options", "isRequired": true, @@ -16779,6 +16771,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", "label": "indexPattern", "isRequired": true, @@ -16806,6 +16799,7 @@ } }, { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", "label": "options", "isRequired": false, @@ -16871,6 +16865,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.refreshFields.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -16917,6 +16912,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", "label": "fields", "isRequired": true, @@ -16937,6 +16933,7 @@ } }, { + "id": "def-server.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", "label": "fieldAttrs", "isRequired": false, @@ -17002,17 +16999,12 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -17032,13 +17024,7 @@ ], "signature": [ "(savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -17074,6 +17060,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -17137,6 +17124,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.create.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -17156,6 +17144,7 @@ } }, { + "id": "def-server.IndexPatternsService.create.$2", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -17206,6 +17195,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.createAndSave.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -17225,6 +17215,7 @@ } }, { + "id": "def-server.IndexPatternsService.createAndSave.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -17240,6 +17231,7 @@ } }, { + "id": "def-server.IndexPatternsService.createAndSave.$3", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -17290,6 +17282,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.createSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -17309,6 +17302,7 @@ } }, { + "id": "def-server.IndexPatternsService.createSavedObject.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -17351,6 +17345,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.updateSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -17366,10 +17361,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 548 + "lineNumber": 551 } }, { + "id": "def-server.IndexPatternsService.updateSavedObject.$2", "type": "number", "label": "saveAttempts", "isRequired": true, @@ -17379,10 +17375,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 549 + "lineNumber": 552 } }, { + "id": "def-server.IndexPatternsService.updateSavedObject.$3", "type": "boolean", "label": "ignoreErrors", "isRequired": true, @@ -17392,7 +17389,7 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 + "lineNumber": 553 } } ], @@ -17400,7 +17397,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 547 + "lineNumber": 550 } }, { @@ -17415,6 +17412,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.delete.$1", "type": "string", "label": "indexPatternId", "isRequired": true, @@ -17426,7 +17424,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -17434,7 +17432,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -17462,13 +17460,7 @@ "lineNumber": 67 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.EnsureDefaultIndexPattern", - "text": "EnsureDefaultIndexPattern" - } + "EnsureDefaultIndexPattern" ] }, { @@ -17481,6 +17473,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPatternsService.Unnamed.$1", "type": "Object", "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, @@ -17506,6 +17499,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getIds.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -17538,6 +17532,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getTitles.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -17570,6 +17565,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.find.$1", "type": "string", "label": "search", "isRequired": true, @@ -17583,6 +17579,7 @@ } }, { + "id": "def-server.IndexPatternsService.find.$2", "type": "number", "label": "size", "isRequired": true, @@ -17625,6 +17622,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -17657,6 +17655,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.clearCache.$1", "type": "string", "label": "id", "isRequired": false, @@ -17690,21 +17689,9 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSavedObjectAttrs", - "text": "IndexPatternSavedObjectAttrs" - }, + "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], "description": [], @@ -17747,6 +17734,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.setDefault.$1", "type": "string", "label": "id", "isRequired": true, @@ -17760,6 +17748,7 @@ } }, { + "id": "def-server.IndexPatternsService.setDefault.$2", "type": "boolean", "label": "force", "isRequired": true, @@ -17792,6 +17781,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", "label": "options", "isRequired": true, @@ -17840,6 +17830,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", "label": "indexPattern", "isRequired": true, @@ -17867,6 +17858,7 @@ } }, { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", "label": "options", "isRequired": false, @@ -17932,6 +17924,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.refreshFields.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -17978,6 +17971,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", "label": "fields", "isRequired": true, @@ -17998,6 +17992,7 @@ } }, { + "id": "def-server.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", "label": "fieldAttrs", "isRequired": false, @@ -18063,17 +18058,12 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -18093,13 +18083,7 @@ ], "signature": [ "(savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -18135,6 +18119,7 @@ "type": "Function", "children": [ { + "id": "def-server.IndexPatternsService.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -18198,6 +18183,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.create.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -18217,6 +18203,7 @@ } }, { + "id": "def-server.IndexPatternsService.create.$2", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -18267,6 +18254,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.createAndSave.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -18286,6 +18274,7 @@ } }, { + "id": "def-server.IndexPatternsService.createAndSave.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -18301,6 +18290,7 @@ } }, { + "id": "def-server.IndexPatternsService.createAndSave.$3", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -18351,6 +18341,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.createSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -18370,6 +18361,7 @@ } }, { + "id": "def-server.IndexPatternsService.createSavedObject.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -18412,6 +18404,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.updateSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -18427,10 +18420,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 548 + "lineNumber": 551 } }, { + "id": "def-server.IndexPatternsService.updateSavedObject.$2", "type": "number", "label": "saveAttempts", "isRequired": true, @@ -18440,10 +18434,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 549 + "lineNumber": 552 } }, { + "id": "def-server.IndexPatternsService.updateSavedObject.$3", "type": "boolean", "label": "ignoreErrors", "isRequired": true, @@ -18453,7 +18448,7 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 + "lineNumber": 553 } } ], @@ -18461,7 +18456,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 547 + "lineNumber": 550 } }, { @@ -18476,6 +18471,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsService.delete.$1", "type": "string", "label": "indexPatternId", "isRequired": true, @@ -18487,7 +18483,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -18495,7 +18491,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -18569,6 +18565,7 @@ "description": [], "children": [ { + "id": "def-server.OptionedParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -18603,6 +18600,7 @@ "type": "Function", "children": [ { + "id": "def-server.castEsToKbnFieldTypeName.$1", "type": "string", "label": "esType", "isRequired": true, @@ -18674,6 +18672,7 @@ "description": [], "children": [ { + "id": "def-server.getTime.$1", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -18694,6 +18693,7 @@ } }, { + "id": "def-server.getTime.$2", "type": "Object", "label": "timeRange", "isRequired": true, @@ -18713,7 +18713,7 @@ } }, { - "id": "def-server.getTime.options", + "id": "def-server.getTime.$3.options", "type": "Object", "label": "options", "tags": [], @@ -18721,7 +18721,7 @@ "children": [ { "tags": [], - "id": "def-server.getTime.options.forceNow", + "id": "def-server.getTime.$3.options.forceNow", "type": "Object", "label": "forceNow", "description": [], @@ -18735,7 +18735,7 @@ }, { "tags": [], - "id": "def-server.getTime.options.fieldName", + "id": "def-server.getTime.$3.options.fieldName", "type": "string", "label": "fieldName", "description": [], @@ -18772,6 +18772,7 @@ "description": [], "children": [ { + "id": "def-server.parseInterval.$1", "type": "string", "label": "interval", "isRequired": true, @@ -18812,7 +18813,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 207 + "lineNumber": 196 }, "signature": [ "FunctionDefinition" @@ -18826,7 +18827,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 + "lineNumber": 197 }, "signature": [ "FunctionDefinition" @@ -18840,7 +18841,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 209 + "lineNumber": 198 }, "signature": [ "FunctionDefinition" @@ -18854,7 +18855,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 210 + "lineNumber": 199 }, "signature": [ "FunctionDefinition" @@ -18868,7 +18869,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 211 + "lineNumber": 200 }, "signature": [ "FunctionDefinition" @@ -18882,7 +18883,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 212 + "lineNumber": 201 }, "signature": [ "FunctionDefinition" @@ -18896,7 +18897,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 + "lineNumber": 202 }, "signature": [ "FunctionDefinition" @@ -18910,7 +18911,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 214 + "lineNumber": 203 }, "signature": [ "FunctionDefinition" @@ -18924,7 +18925,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 215 + "lineNumber": 204 }, "signature": [ "FunctionDefinition" @@ -18938,7 +18939,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 216 + "lineNumber": 205 }, "signature": [ "FunctionDefinition" @@ -18952,7 +18953,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 217 + "lineNumber": 206 }, "signature": [ "FunctionDefinition" @@ -18966,7 +18967,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 218 + "lineNumber": 207 }, "signature": [ "FunctionDefinition" @@ -18980,7 +18981,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 219 + "lineNumber": 208 }, "signature": [ "FunctionDefinition" @@ -18994,7 +18995,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 220 + "lineNumber": 209 }, "signature": [ "FunctionDefinition" @@ -19008,7 +19009,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 221 + "lineNumber": 210 }, "signature": [ "FunctionDefinition" @@ -19022,7 +19023,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 222 + "lineNumber": 211 }, "signature": [ "FunctionDefinition" @@ -19036,7 +19037,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 223 + "lineNumber": 212 }, "signature": [ "FunctionDefinition" @@ -19050,7 +19051,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 224 + "lineNumber": 213 }, "signature": [ "FunctionDefinition" @@ -19064,7 +19065,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 225 + "lineNumber": 214 }, "signature": [ "FunctionDefinition" @@ -19078,7 +19079,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 226 + "lineNumber": 215 }, "signature": [ "FunctionDefinition" @@ -19092,7 +19093,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 227 + "lineNumber": 216 }, "signature": [ "FunctionDefinition" @@ -19106,7 +19107,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 228 + "lineNumber": 217 }, "signature": [ "FunctionDefinition" @@ -19120,7 +19121,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 229 + "lineNumber": 218 }, "signature": [ "FunctionDefinition" @@ -19134,7 +19135,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 230 + "lineNumber": 219 }, "signature": [ "FunctionDefinition" @@ -19148,7 +19149,21 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 231 + "lineNumber": 220 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggSinglePercentile", + "type": "Object", + "label": "aggSinglePercentile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221 }, "signature": [ "FunctionDefinition" @@ -19162,7 +19177,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 232 + "lineNumber": 222 }, "signature": [ "FunctionDefinition" @@ -19176,7 +19191,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 233 + "lineNumber": 223 }, "signature": [ "FunctionDefinition" @@ -19190,7 +19205,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 234 + "lineNumber": 224 }, "signature": [ "FunctionDefinition" @@ -19204,7 +19219,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 235 + "lineNumber": 225 }, "signature": [ "FunctionDefinition" @@ -19218,7 +19233,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 236 + "lineNumber": 226 }, "signature": [ "FunctionDefinition" @@ -19232,7 +19247,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 237 + "lineNumber": 227 }, "signature": [ "FunctionDefinition" @@ -19246,7 +19261,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 238 + "lineNumber": 228 }, "signature": [ "FunctionDefinition" @@ -19260,7 +19275,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 239 + "lineNumber": 229 }, "signature": [ "FunctionDefinition" @@ -19269,7 +19284,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 206 + "lineNumber": 195 }, "initialIsOpen": false }, @@ -19320,6 +19335,7 @@ "description": [], "children": [ { + "id": "def-server.AggParamOption.enabled.$1", "type": "Object", "label": "agg", "isRequired": true, @@ -20678,7 +20694,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 21 + "lineNumber": 24 }, "signature": [ "FieldParamType" @@ -20802,7 +20818,7 @@ "children": [ { "tags": [], - "id": "def-server.AggGroupLabels.[AggGroupNames.Buckets]", + "id": "def-server.AggGroupLabels.AggGroupNames.Buckets", "type": "string", "label": "[AggGroupNames.Buckets]", "description": [], @@ -20813,7 +20829,7 @@ }, { "tags": [], - "id": "def-server.AggGroupLabels.[AggGroupNames.Metrics]", + "id": "def-server.AggGroupLabels.AggGroupNames.Metrics", "type": "string", "label": "[AggGroupNames.Metrics]", "description": [], @@ -20824,7 +20840,7 @@ }, { "tags": [], - "id": "def-server.AggGroupLabels.[AggGroupNames.None]", + "id": "def-server.AggGroupLabels.AggGroupNames.None", "type": "string", "label": "[AggGroupNames.None]", "description": [], @@ -21149,13 +21165,7 @@ "lineNumber": 65 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.NodeTypes", - "text": "NodeTypes" - } + "NodeTypes" ] }, { @@ -21858,7 +21868,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" + "): boolean; } | { display: string; val: string; })[]" ] }, { @@ -22282,7 +22292,7 @@ "description": [], "source": { "path": "src/plugins/data/common/constants.ts", - "lineNumber": 11 + "lineNumber": 12 }, "signature": [ "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" @@ -22329,13 +22339,7 @@ }, "signature": [ "{ register: (customFieldFormat: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", ") => number; }" ] } @@ -22432,13 +22436,7 @@ "lineNumber": 40 }, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.IndexPatternsServiceStart", - "text": "IndexPatternsServiceStart" - } + "IndexPatternsServiceStart" ] } ], @@ -22524,6 +22522,7 @@ "description": [], "children": [ { + "id": "def-common.KbnFieldType.Unnamed.$1", "type": "Object", "label": "options", "isRequired": true, @@ -22597,6 +22596,7 @@ "description": [], "children": [ { + "id": "def-common.KQLSyntaxError.Unnamed.$1", "type": "Object", "label": "error", "isRequired": true, @@ -22610,6 +22610,7 @@ } }, { + "id": "def-common.KQLSyntaxError.Unnamed.$2", "type": "Any", "label": "expression", "isRequired": true, @@ -22664,6 +22665,7 @@ "description": [], "children": [ { + "id": "def-common.buildCustomFilter.$1", "type": "string", "label": "indexPatternString", "isRequired": true, @@ -22677,6 +22679,7 @@ } }, { + "id": "def-common.buildCustomFilter.$2", "type": "Any", "label": "queryDsl", "isRequired": true, @@ -22690,6 +22693,7 @@ } }, { + "id": "def-common.buildCustomFilter.$3", "type": "boolean", "label": "disabled", "isRequired": true, @@ -22703,6 +22707,7 @@ } }, { + "id": "def-common.buildCustomFilter.$4", "type": "boolean", "label": "negate", "isRequired": true, @@ -22716,6 +22721,7 @@ } }, { + "id": "def-common.buildCustomFilter.$5", "type": "CompoundType", "label": "alias", "isRequired": false, @@ -22729,6 +22735,7 @@ } }, { + "id": "def-common.buildCustomFilter.$6", "type": "Enum", "label": "store", "isRequired": true, @@ -22761,6 +22768,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildEmptyFilter.$1", "type": "boolean", "label": "isPinned", "isRequired": true, @@ -22774,6 +22782,7 @@ } }, { + "id": "def-common.buildEmptyFilter.$2", "type": "string", "label": "index", "isRequired": false, @@ -22856,6 +22865,7 @@ "description": [], "children": [ { + "id": "def-common.buildEsQuery.$1", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -22876,6 +22886,7 @@ } }, { + "id": "def-common.buildEsQuery.$2", "type": "CompoundType", "label": "queries", "isRequired": true, @@ -22906,6 +22917,7 @@ } }, { + "id": "def-common.buildEsQuery.$3", "type": "CompoundType", "label": "filters", "isRequired": true, @@ -22936,6 +22948,7 @@ } }, { + "id": "def-common.buildEsQuery.$4", "type": "Object", "label": "config", "isRequired": true, @@ -22970,6 +22983,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildExistsFilter.$1", "type": "Object", "label": "field", "isRequired": true, @@ -22989,6 +23003,7 @@ } }, { + "id": "def-common.buildExistsFilter.$2", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -23093,6 +23108,7 @@ "description": [], "children": [ { + "id": "def-common.buildFilter.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -23112,6 +23128,7 @@ } }, { + "id": "def-common.buildFilter.$2", "type": "Object", "label": "field", "isRequired": true, @@ -23131,6 +23148,7 @@ } }, { + "id": "def-common.buildFilter.$3", "type": "Enum", "label": "type", "isRequired": true, @@ -23150,6 +23168,7 @@ } }, { + "id": "def-common.buildFilter.$4", "type": "boolean", "label": "negate", "isRequired": true, @@ -23163,6 +23182,7 @@ } }, { + "id": "def-common.buildFilter.$5", "type": "boolean", "label": "disabled", "isRequired": true, @@ -23176,6 +23196,7 @@ } }, { + "id": "def-common.buildFilter.$6", "type": "Any", "label": "params", "isRequired": true, @@ -23189,6 +23210,7 @@ } }, { + "id": "def-common.buildFilter.$7", "type": "CompoundType", "label": "alias", "isRequired": false, @@ -23202,6 +23224,7 @@ } }, { + "id": "def-common.buildFilter.$8", "type": "CompoundType", "label": "store", "isRequired": false, @@ -23235,6 +23258,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildPhraseFilter.$1", "type": "Object", "label": "field", "isRequired": true, @@ -23254,6 +23278,7 @@ } }, { + "id": "def-common.buildPhraseFilter.$2", "type": "Any", "label": "value", "isRequired": true, @@ -23267,6 +23292,7 @@ } }, { + "id": "def-common.buildPhraseFilter.$3", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -23327,6 +23353,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildPhrasesFilter.$1", "type": "Object", "label": "field", "isRequired": true, @@ -23346,6 +23373,7 @@ } }, { + "id": "def-common.buildPhrasesFilter.$2", "type": "Array", "label": "params", "isRequired": true, @@ -23359,6 +23387,7 @@ } }, { + "id": "def-common.buildPhrasesFilter.$3", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -23419,6 +23448,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildQueryFilter.$1", "type": "Any", "label": "query", "isRequired": true, @@ -23432,6 +23462,7 @@ } }, { + "id": "def-common.buildQueryFilter.$2", "type": "string", "label": "index", "isRequired": true, @@ -23445,6 +23476,7 @@ } }, { + "id": "def-common.buildQueryFilter.$3", "type": "string", "label": "alias", "isRequired": true, @@ -23483,6 +23515,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildQueryFromFilters.$1", "type": "Array", "label": "filters", "isRequired": true, @@ -23503,6 +23536,7 @@ } }, { + "id": "def-common.buildQueryFromFilters.$2", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -23523,6 +23557,7 @@ } }, { + "id": "def-common.buildQueryFromFilters.$3", "type": "boolean", "label": "ignoreFilterIfFieldNotInIndex", "isRequired": true, @@ -23586,6 +23621,7 @@ "type": "Function", "children": [ { + "id": "def-common.buildRangeFilter.$1", "type": "Object", "label": "field", "isRequired": true, @@ -23605,6 +23641,7 @@ } }, { + "id": "def-common.buildRangeFilter.$2", "type": "Object", "label": "params", "isRequired": true, @@ -23624,6 +23661,7 @@ } }, { + "id": "def-common.buildRangeFilter.$3", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -23643,6 +23681,7 @@ } }, { + "id": "def-common.buildRangeFilter.$4", "type": "string", "label": "formattedValue", "isRequired": false, @@ -23705,6 +23744,7 @@ "type": "Function", "children": [ { + "id": "def-common.castEsToKbnFieldTypeName.$1", "type": "string", "label": "esType", "isRequired": true, @@ -23747,6 +23787,7 @@ "type": "Function", "children": [ { + "id": "def-common.cleanFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -23814,6 +23855,7 @@ "description": [], "children": [ { + "id": "def-common.datatableToCSV.$1", "type": "Object", "label": "{ columns, rows }", "isRequired": true, @@ -23833,6 +23875,7 @@ } }, { + "id": "def-common.datatableToCSV.$2", "type": "Object", "label": "{ csvSeparator, quoteValues, formatFactory, raw }", "isRequired": true, @@ -23881,6 +23924,7 @@ ], "children": [ { + "id": "def-common.decorateQuery.$1", "type": "CompoundType", "label": "query", "isRequired": true, @@ -23902,6 +23946,7 @@ } }, { + "id": "def-common.decorateQuery.$2", "type": "CompoundType", "label": "queryStringOptions", "isRequired": true, @@ -23917,6 +23962,7 @@ } }, { + "id": "def-common.decorateQuery.$3", "type": "string", "label": "dateFormatTZ", "isRequired": false, @@ -23945,6 +23991,7 @@ "type": "Function", "children": [ { + "id": "def-common.disableFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -23997,6 +24044,7 @@ "type": "Function", "children": [ { + "id": "def-common.enableFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -24049,6 +24097,7 @@ "type": "Function", "children": [ { + "id": "def-common.fromKueryExpression.$1", "type": "Any", "label": "expression", "isRequired": true, @@ -24062,6 +24111,7 @@ } }, { + "id": "def-common.fromKueryExpression.$2", "type": "Object", "label": "parseOptions", "isRequired": true, @@ -24116,6 +24166,7 @@ "type": "Function", "children": [ { + "id": "def-common.fromLiteralExpression.$1", "type": "Any", "label": "expression", "isRequired": true, @@ -24129,6 +24180,7 @@ } }, { + "id": "def-common.fromLiteralExpression.$2", "type": "Object", "label": "parseOptions", "isRequired": true, @@ -24204,6 +24256,7 @@ "description": [], "children": [ { + "id": "def-common.getDisplayValueFromFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -24223,6 +24276,7 @@ } }, { + "id": "def-common.getDisplayValueFromFilter.$2", "type": "Array", "label": "indexPatterns", "isRequired": true, @@ -24268,6 +24322,7 @@ "description": [], "children": [ { + "id": "def-common.getEsQueryConfig.$1", "type": "Object", "label": "config", "isRequired": true, @@ -24294,6 +24349,7 @@ "type": "Function", "children": [ { + "id": "def-common.getExistsFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24360,6 +24416,7 @@ "type": "Function", "children": [ { + "id": "def-common.getFilterField.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -24418,6 +24475,7 @@ "description": [], "children": [ { + "id": "def-common.getFilterParams.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -24450,6 +24508,7 @@ "type": "Function", "children": [ { + "id": "def-common.getGeoBoundingBoxFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24495,6 +24554,7 @@ "type": "Function", "children": [ { + "id": "def-common.getGeoPolygonFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24569,6 +24629,7 @@ "description": [], "children": [ { + "id": "def-common.getIndexPatternFromFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -24588,6 +24649,7 @@ } }, { + "id": "def-common.getIndexPatternFromFilter.$2", "type": "Array", "label": "indexPatterns", "isRequired": true, @@ -24621,6 +24683,7 @@ "type": "Function", "children": [ { + "id": "def-common.getKbnFieldType.$1", "type": "string", "label": "typeName", "isRequired": true, @@ -24684,6 +24747,7 @@ "type": "Function", "children": [ { + "id": "def-common.getMissingFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24729,6 +24793,7 @@ "type": "Function", "children": [ { + "id": "def-common.getPhraseFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24774,6 +24839,7 @@ "type": "Function", "children": [ { + "id": "def-common.getPhraseFilterValue.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24819,6 +24885,7 @@ "type": "Function", "children": [ { + "id": "def-common.getPhraseScript.$1", "type": "Object", "label": "field", "isRequired": true, @@ -24838,6 +24905,7 @@ } }, { + "id": "def-common.getPhraseScript.$2", "type": "string", "label": "value", "isRequired": true, @@ -24877,6 +24945,7 @@ "type": "Function", "children": [ { + "id": "def-common.getPhrasesFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24922,6 +24991,7 @@ "type": "Function", "children": [ { + "id": "def-common.getRangeFilterField.$1", "type": "CompoundType", "label": "filter", "isRequired": true, @@ -24967,6 +25037,7 @@ "type": "Function", "children": [ { + "id": "def-common.getRangeScript.$1", "type": "Object", "label": "field", "isRequired": true, @@ -24986,6 +25057,7 @@ } }, { + "id": "def-common.getRangeScript.$2", "type": "Object", "label": "params", "isRequired": true, @@ -25047,6 +25119,7 @@ "type": "Function", "children": [ { + "id": "def-common.isExistsFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25085,6 +25158,7 @@ "type": "Function", "children": [ { + "id": "def-common.isFilter.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -25123,6 +25197,7 @@ "type": "Function", "children": [ { + "id": "def-common.isFilterDisabled.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -25168,6 +25243,7 @@ "type": "Function", "children": [ { + "id": "def-common.isFilterPinned.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -25213,6 +25289,7 @@ "type": "Function", "children": [ { + "id": "def-common.isFilters.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -25252,6 +25329,7 @@ "type": "Function", "children": [ { + "id": "def-common.isGeoBoundingBoxFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25290,6 +25368,7 @@ "type": "Function", "children": [ { + "id": "def-common.isGeoPolygonFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25328,6 +25407,7 @@ "type": "Function", "children": [ { + "id": "def-common.isMatchAllFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25366,6 +25446,7 @@ "type": "Function", "children": [ { + "id": "def-common.isMissingFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25404,6 +25485,7 @@ "type": "Function", "children": [ { + "id": "def-common.isPhraseFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25442,6 +25524,7 @@ "type": "Function", "children": [ { + "id": "def-common.isPhrasesFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25480,6 +25563,7 @@ "type": "Function", "children": [ { + "id": "def-common.isQueryStringFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25518,6 +25602,7 @@ "type": "Function", "children": [ { + "id": "def-common.isRangeFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25556,6 +25641,7 @@ "type": "Function", "children": [ { + "id": "def-common.isScriptedPhraseFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25594,6 +25680,7 @@ "type": "Function", "children": [ { + "id": "def-common.isScriptedRangeFilter.$1", "type": "Any", "label": "filter", "isRequired": true, @@ -25644,6 +25731,7 @@ "description": [], "children": [ { + "id": "def-common.luceneStringToDsl.$1", "type": "Any", "label": "query", "isRequired": true, @@ -25670,6 +25758,7 @@ "type": "Function", "children": [ { + "id": "def-common.pinFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -25729,6 +25818,7 @@ ], "children": [ { + "id": "def-common.shortenDottedString.$1", "type": "Any", "label": "input", "isRequired": true, @@ -25757,6 +25847,7 @@ "type": "Function", "children": [ { + "id": "def-common.toElasticsearchQuery.$1", "type": "Object", "label": "node", "isRequired": true, @@ -25776,6 +25867,7 @@ } }, { + "id": "def-common.toElasticsearchQuery.$2", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -25796,6 +25888,7 @@ } }, { + "id": "def-common.toElasticsearchQuery.$3", "type": "Object", "label": "config", "isRequired": false, @@ -25809,6 +25902,7 @@ } }, { + "id": "def-common.toElasticsearchQuery.$4", "type": "Object", "label": "context", "isRequired": false, @@ -25865,6 +25959,7 @@ "type": "Function", "children": [ { + "id": "def-common.toggleFilterDisabled.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -25918,6 +26013,7 @@ "type": "Function", "children": [ { + "id": "def-common.toggleFilterNegated.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -25971,6 +26067,7 @@ "type": "Function", "children": [ { + "id": "def-common.toggleFilterPinned.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -26032,6 +26129,7 @@ "type": "Function", "children": [ { + "id": "def-common.unpinFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -26725,13 +26823,7 @@ "lineNumber": 78 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, + "SavedObjectError", " | undefined" ] }, @@ -26764,13 +26856,7 @@ "lineNumber": 82 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ] }, @@ -26787,13 +26873,7 @@ "lineNumber": 84 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, + "SavedObjectsMigrationVersion", " | undefined" ] }, @@ -27173,6 +27253,21 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", + "type": "string", + "label": "KIBANA_USER_QUERY_LANGUAGE_KEY", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 10 + }, + "signature": [ + "\"kibana.userQueryLanguage\"" + ], + "initialIsOpen": false + }, { "id": "def-common.MatchAllFilter", "type": "Type", @@ -27350,6 +27445,7 @@ "type": "Function", "children": [ { + "id": "def-common.nodeBuilder.is.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -27363,6 +27459,7 @@ } }, { + "id": "def-common.nodeBuilder.is.$2", "type": "CompoundType", "label": "value", "isRequired": true, @@ -27393,13 +27490,7 @@ "text": "KueryNode" }, ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FunctionTypeBuildNode", - "text": "FunctionTypeBuildNode" - } + "FunctionTypeBuildNode" ], "description": [], "label": "is", @@ -27415,6 +27506,7 @@ "type": "Function", "children": [ { + "id": "def-common.nodeBuilder.or.$1", "type": "Array", "label": "nodes", "isRequired": true, @@ -27467,6 +27559,7 @@ "type": "Function", "children": [ { + "id": "def-common.nodeBuilder.and.$1", "type": "Array", "label": "nodes", "isRequired": true, @@ -27542,12 +27635,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/function" - } + "src/plugins/data/common/es_query/kuery/node_types/function" ] }, { @@ -27562,12 +27650,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/literal" - } + "src/plugins/data/common/es_query/kuery/node_types/literal" ] }, { @@ -27582,12 +27665,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/named_arg" - } + "src/plugins/data/common/es_query/kuery/node_types/named_arg" ] }, { @@ -27602,12 +27680,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/wildcard" - } + "src/plugins/data/common/es_query/kuery/node_types/wildcard" ] } ], @@ -27627,7 +27700,7 @@ "description": [], "source": { "path": "src/plugins/data/common/constants.ts", - "lineNumber": 11 + "lineNumber": 12 }, "signature": [ "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }" diff --git a/api_docs/data_enhanced.json b/api_docs/data_enhanced.json index 80f1d1fc15a5..6ba0ca8191d1 100644 --- a/api_docs/data_enhanced.json +++ b/api_docs/data_enhanced.json @@ -79,8 +79,10 @@ "section": "def-server.Plugin", "text": "Plugin" }, - "" ], "children": [ @@ -94,6 +96,7 @@ "description": [], "children": [ { + "id": "def-server.EnhancedDataServerPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -110,7 +113,7 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 48 + "lineNumber": 33 } } ], @@ -118,7 +121,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 48 + "lineNumber": 33 } }, { @@ -135,18 +138,15 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, - ", unknown>, deps: SetupDependencies) => void" + "DataEnhancedStartDependencies", + ", unknown>, deps: ", + "DataEnhancedSetupDependencies", + ") => void" ], "description": [], "children": [ { + "id": "def-server.EnhancedDataServerPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -159,32 +159,27 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, + "DataEnhancedStartDependencies", ", unknown>" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 53 + "lineNumber": 38 } }, { + "id": "def-server.EnhancedDataServerPlugin.setup.$2", "type": "Object", "label": "deps", "isRequired": true, "signature": [ - "SetupDependencies" + "DataEnhancedSetupDependencies" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 53 + "lineNumber": 38 } } ], @@ -192,7 +187,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 53 + "lineNumber": 38 } }, { @@ -209,18 +204,13 @@ "text": "CoreStart" }, ", { taskManager }: ", - { - "pluginId": "dataEnhanced", - "scope": "server", - "docId": "kibDataEnhancedPluginApi", - "section": "def-server.StartDependencies", - "text": "StartDependencies" - }, + "DataEnhancedStartDependencies", ") => void" ], "description": [], "children": [ { + "id": "def-server.EnhancedDataServerPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -236,26 +226,21 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 80 } }, { + "id": "def-server.EnhancedDataServerPlugin.start.$2", "type": "Object", "label": "{ taskManager }", "isRequired": true, "signature": [ - { - "pluginId": "dataEnhanced", - "scope": "server", - "docId": "kibDataEnhancedPluginApi", - "section": "def-server.StartDependencies", - "text": "StartDependencies" - } + "DataEnhancedStartDependencies" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 80 } } ], @@ -263,7 +248,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 80 } }, { @@ -279,13 +264,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 101 + "lineNumber": 86 } } ], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 42 + "lineNumber": 27 }, "initialIsOpen": false } @@ -335,6 +320,7 @@ "type": "Function", "children": [ { + "id": "def-common.pollSearch.$1", "type": "Function", "label": "search", "isRequired": true, @@ -348,6 +334,7 @@ } }, { + "id": "def-common.pollSearch.$2", "type": "Function", "label": "cancel", "isRequired": false, @@ -361,6 +348,7 @@ } }, { + "id": "def-common.pollSearch.$3", "type": "Object", "label": "{ pollInterval = 1000, abortSignal }", "isRequired": true, @@ -532,7 +520,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 73 + "lineNumber": 80 } }, { @@ -545,7 +533,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 77 + "lineNumber": 84 } }, { @@ -558,7 +546,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 81 + "lineNumber": 88 } }, { @@ -571,7 +559,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 85 + "lineNumber": 92 }, "signature": [ "string | undefined" @@ -580,7 +568,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 69 + "lineNumber": 76 }, "initialIsOpen": false }, @@ -673,6 +661,22 @@ "lineNumber": 33 } }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.completed", + "type": "CompoundType", + "label": "completed", + "description": [ + "\nTime of transition into completed state,\n\nCan be \"null\" in case already completed session\ntransitioned into in-progress session" + ], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 40 + }, + "signature": [ + "string | null | undefined" + ] + }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.status", @@ -683,7 +687,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 37 + "lineNumber": 44 }, "signature": [ { @@ -705,7 +709,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 41 + "lineNumber": 48 }, "signature": [ "string | undefined" @@ -721,7 +725,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 46 + "lineNumber": 53 }, "signature": [ "Record | undefined" @@ -737,7 +741,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 51 + "lineNumber": 58 }, "signature": [ "Record | undefined" @@ -753,7 +757,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 55 + "lineNumber": 62 }, "signature": [ "Record | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined) => string" ], "description": [ @@ -886,6 +862,7 @@ ], "children": [ { + "id": "def-common.FieldFormat.convert.$1", "type": "Any", "label": "value", "isRequired": true, @@ -899,6 +876,7 @@ } }, { + "id": "def-common.FieldFormat.convert.$2", "type": "CompoundType", "label": "contentType", "isRequired": true, @@ -920,18 +898,13 @@ } }, { + "id": "def-common.FieldFormat.convert.$3", "type": "CompoundType", "label": "options", "isRequired": false, "signature": [ "Record | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined" ], "description": [], @@ -967,19 +940,14 @@ "text": "FieldFormatsContentType" }, ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" - } + "FieldFormatConvertFunction" ], "description": [ "\nGet a convert function that is bound to a specific contentType" ], "children": [ { + "id": "def-common.FieldFormat.getConverterFor.$1", "type": "CompoundType", "label": "contentType", "isRequired": true, @@ -1046,6 +1014,7 @@ ], "children": [ { + "id": "def-common.FieldFormat.param.$1", "type": "string", "label": "name", "isRequired": true, @@ -1131,17 +1100,12 @@ "description": [], "children": [ { + "id": "def-common.FieldFormat.from.$1", "type": "Function", "label": "convertFn", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" - } + "FieldFormatConvertFunction" ], "description": [], "source": { @@ -1163,13 +1127,7 @@ "label": "setupContentType", "signature": [ "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvert", - "text": "FieldFormatConvert" - } + "FieldFormatConvert" ], "description": [], "children": [], @@ -1198,6 +1156,7 @@ "description": [], "children": [ { + "id": "def-common.FieldFormat.isInstanceOfFieldFormat.$1", "type": "Any", "label": "fieldFormat", "isRequired": true, @@ -1263,6 +1222,7 @@ "description": [], "children": [ { + "id": "def-common.FieldFormatNotFoundError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -1276,6 +1236,7 @@ } }, { + "id": "def-common.FieldFormatNotFoundError.Unnamed.$2", "type": "string", "label": "formatId", "isRequired": true, @@ -1322,13 +1283,7 @@ }, "signature": [ "Map" ] }, @@ -1382,6 +1337,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.deserialize.$1", "type": "Object", "label": "mapping", "isRequired": false, @@ -1443,18 +1399,13 @@ "text": "GetConfigFn" }, ", metaParamsOptions?: Record, defaultFieldConverters?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", "[]) => void" ], "description": [], "children": [ { + "id": "def-common.FieldFormatsRegistry.init.$1", "type": "Function", "label": "getConfig", "isRequired": true, @@ -1474,6 +1425,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.init.$2", "type": "Object", "label": "metaParamsOptions", "isRequired": true, @@ -1487,17 +1439,12 @@ } }, { + "id": "def-common.FieldFormatsRegistry.init.$3", "type": "Array", "label": "defaultFieldConverters", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", "[]" ], "description": [], @@ -1519,6 +1466,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getDefaultConfig.$1", "type": "Enum", "label": "fieldType", "isRequired": true, @@ -1538,6 +1486,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.getDefaultConfig.$2", "type": "Array", "label": "esTypes", "isRequired": false, @@ -1602,6 +1551,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getType.$1", "type": "string", "label": "formatId", "isRequired": true, @@ -1617,13 +1567,7 @@ ], "signature": [ "(formatId: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", " | undefined" ], "description": [ @@ -1644,6 +1588,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams.$1", "type": "string", "label": "formatId", "isRequired": true, @@ -1659,13 +1604,7 @@ ], "signature": [ "(formatId: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", " | undefined" ], "description": [], @@ -1682,6 +1621,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getDefaultType.$1", "type": "Enum", "label": "fieldType", "isRequired": true, @@ -1701,6 +1641,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.getDefaultType.$2", "type": "Array", "label": "esTypes", "isRequired": false, @@ -1739,13 +1680,7 @@ "text": "ES_FIELD_TYPES" }, "[] | undefined) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", " | undefined" ], "description": [ @@ -1766,6 +1701,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes.$1", "type": "Array", "label": "esTypes", "isRequired": false, @@ -1823,6 +1759,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getDefaultTypeName.$1", "type": "Enum", "label": "fieldType", "isRequired": true, @@ -1842,6 +1779,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.getDefaultTypeName.$2", "type": "Array", "label": "esTypes", "isRequired": false, @@ -1940,6 +1878,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$1", "type": "Enum", "label": "fieldType", "isRequired": true, @@ -1959,6 +1898,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$2", "type": "Array", "label": "esTypes", "isRequired": false, @@ -1979,6 +1919,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$3", "type": "Object", "label": "params", "isRequired": true, @@ -2059,6 +2000,7 @@ ], "children": [ { + "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver.$1", "type": "Enum", "label": "fieldType", "isRequired": true, @@ -2078,6 +2020,7 @@ } }, { + "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver.$2", "type": "Array", "label": "esTypes", "isRequired": true, @@ -2121,13 +2064,7 @@ "text": "KBN_FIELD_TYPES" }, ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", "[]" ], "description": [ @@ -2135,6 +2072,7 @@ ], "children": [ { + "id": "def-common.FieldFormatsRegistry.getByFieldType.$1", "type": "Enum", "label": "fieldType", "isRequired": true, @@ -2215,6 +2153,7 @@ "description": [], "children": [ { + "id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap.$1", "type": "Any", "label": "value", "isRequired": true, @@ -2241,29 +2180,18 @@ "label": "register", "signature": [ "(fieldFormats: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", "[]) => void" ], "description": [], "children": [ { + "id": "def-common.FieldFormatsRegistry.register.$1", "type": "Array", "label": "fieldFormats", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, + "FieldFormatInstanceType", "[]" ], "description": [], @@ -2425,6 +2353,7 @@ "type": "Function", "children": [ { + "id": "def-common.HistogramFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -2537,6 +2466,7 @@ "type": "Function", "children": [ { + "id": "def-common.IpFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -2779,6 +2709,7 @@ "type": "Function", "children": [ { + "id": "def-common.PercentFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -2891,6 +2822,7 @@ "type": "Function", "children": [ { + "id": "def-common.RelativeDateFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -2954,8 +2886,8 @@ "label": "id", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 45 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 39 }, "signature": [ { @@ -2974,8 +2906,8 @@ "label": "title", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 46 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 40 } }, { @@ -2985,8 +2917,8 @@ "label": "fieldType", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 47 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 41 }, "signature": [ { @@ -3003,6 +2935,7 @@ "type": "Function", "children": [ { + "id": "def-common.SourceFormat.textConvert.$1", "type": "Any", "label": "value", "isRequired": true, @@ -3011,8 +2944,8 @@ ], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 49 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 43 } } ], @@ -3022,8 +2955,8 @@ "description": [], "label": "textConvert", "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 49 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 43 }, "tags": [], "returnComment": [] @@ -3033,6 +2966,7 @@ "type": "Function", "children": [ { + "id": "def-common.SourceFormat.htmlConvert.$1", "type": "Any", "label": "value", "isRequired": true, @@ -3041,55 +2975,44 @@ ], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 51 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 45 } }, { + "id": "def-common.SourceFormat.htmlConvert.$2", "type": "Object", "label": "options", "isRequired": false, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined" ], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 51 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 45 } } ], "signature": [ "(value: any, options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined) => string" ], "description": [], "label": "htmlConvert", "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 51 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 45 }, "tags": [], "returnComment": [] } ], "source": { - "path": "src/plugins/data/common/field_formats/converters/source.ts", - "lineNumber": 44 + "path": "src/plugins/data/common/field_formats/converters/source.tsx", + "lineNumber": 38 }, "initialIsOpen": false }, @@ -3190,6 +3113,7 @@ "type": "Function", "children": [ { + "id": "def-common.StaticLookupFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -3333,6 +3257,7 @@ "type": "Function", "children": [ { + "id": "def-common.StringFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -3445,6 +3370,7 @@ "type": "Function", "children": [ { + "id": "def-common.TruncateFormat.textConvert.$1", "type": "Any", "label": "val", "isRequired": true, @@ -3577,17 +3503,12 @@ "description": [], "children": [ { + "id": "def-common.UrlFormat.Unnamed.$1", "type": "Object", "label": "params", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.IFieldFormatMetaParams", - "text": "IFieldFormatMetaParams" - } + "IFieldFormatMetaParams" ], "description": [], "source": { @@ -3624,6 +3545,7 @@ "type": "Function", "children": [ { + "id": "def-common.UrlFormat.textConvert.$1", "type": "Any", "label": "value", "isRequired": true, @@ -3654,6 +3576,7 @@ "type": "Function", "children": [ { + "id": "def-common.UrlFormat.htmlConvert.$1", "type": "Any", "label": "rawValue", "isRequired": true, @@ -3667,17 +3590,12 @@ } }, { + "id": "def-common.UrlFormat.htmlConvert.$2", "type": "Object", "label": "options", "isRequired": false, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined" ], "description": [], @@ -3689,13 +3607,7 @@ ], "signature": [ "(rawValue: any, options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, + "HtmlContextTypeOptions", " | undefined) => string" ], "description": [], @@ -3726,6 +3638,7 @@ "description": [], "children": [ { + "id": "def-common.getHighlightRequest.$1", "type": "Any", "label": "query", "isRequired": true, @@ -3739,6 +3652,7 @@ } }, { + "id": "def-common.getHighlightRequest.$2", "type": "boolean", "label": "shouldHighlight", "isRequired": true, diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json index 8058f6a72f9c..243f7d3a0087 100644 --- a/api_docs/data_index_patterns.json +++ b/api_docs/data_index_patterns.json @@ -27,6 +27,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPatternsFetcher.Unnamed.$1", "type": "CompoundType", "label": "elasticsearchClient", "isRequired": true, @@ -46,6 +47,7 @@ } }, { + "id": "def-server.IndexPatternsFetcher.Unnamed.$2", "type": "boolean", "label": "allowNoIndices", "isRequired": true, @@ -86,7 +88,7 @@ ], "children": [ { - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options", "type": "Object", "label": "options", "tags": [], @@ -94,7 +96,7 @@ "children": [ { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.pattern", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.pattern", "type": "CompoundType", "label": "pattern", "description": [], @@ -108,7 +110,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.metaFields", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.metaFields", "type": "Array", "label": "metaFields", "description": [], @@ -122,7 +124,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.fieldCapsOptions", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.fieldCapsOptions", "type": "Object", "label": "fieldCapsOptions", "description": [], @@ -136,7 +138,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.type", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.type", "type": "string", "label": "type", "description": [], @@ -150,7 +152,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.rollupIndex", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.rollupIndex", "type": "string", "label": "rollupIndex", "description": [], @@ -199,7 +201,7 @@ ], "children": [ { - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options", + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options", "type": "Object", "label": "options", "tags": [], @@ -207,7 +209,7 @@ "children": [ { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.pattern", + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.pattern", "type": "string", "label": "pattern", "description": [], @@ -218,7 +220,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.metaFields", + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.metaFields", "type": "Array", "label": "metaFields", "description": [], @@ -232,7 +234,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.lookBack", + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.lookBack", "type": "number", "label": "lookBack", "description": [], @@ -243,7 +245,7 @@ }, { "tags": [], - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.interval", + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.interval", "type": "string", "label": "interval", "description": [], @@ -281,6 +283,7 @@ ], "children": [ { + "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", "type": "Array", "label": "patternList", "isRequired": true, @@ -353,13 +356,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStartDependencies", - "text": "DataPluginStartDependencies" - }, + "IndexPatternsServiceStartDeps", ", ", { "pluginId": "data", @@ -368,19 +365,14 @@ "section": "def-server.DataPluginStart", "text": "DataPluginStart" }, - ">, { expressions }: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.IndexPatternsServiceSetupDeps", - "text": "IndexPatternsServiceSetupDeps" - }, + ">, { expressions, usageCollection }: ", + "IndexPatternsServiceSetupDeps", ") => void" ], "description": [], "children": [ { + "id": "def-server.IndexPatternsServiceProvider.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -393,13 +385,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStartDependencies", - "text": "DataPluginStartDependencies" - }, + "IndexPatternsServiceStartDeps", ", ", { "pluginId": "data", @@ -413,26 +399,21 @@ "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 47 + "lineNumber": 81 } }, { + "id": "def-server.IndexPatternsServiceProvider.setup.$2", "type": "Object", - "label": "{ expressions }", + "label": "{ expressions, usageCollection }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.IndexPatternsServiceSetupDeps", - "text": "IndexPatternsServiceSetupDeps" - } + "IndexPatternsServiceSetupDeps" ], "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 48 + "lineNumber": 82 } } ], @@ -440,7 +421,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 46 + "lineNumber": 80 } }, { @@ -457,13 +438,7 @@ "text": "CoreStart" }, ", { fieldFormats, logger }: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.IndexPatternsServiceStartDeps", - "text": "IndexPatternsServiceStartDeps" - }, + "IndexPatternsServiceStartDeps", ") => { indexPatternsServiceFactory: (savedObjectsClient: Pick<", { "pluginId": "core", @@ -472,7 +447,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, elasticsearchClient: ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, elasticsearchClient: ", { "pluginId": "core", "scope": "server", @@ -492,6 +467,7 @@ "description": [], "children": [ { + "id": "def-server.IndexPatternsServiceProvider.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -507,26 +483,21 @@ "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 58 + "lineNumber": 93 } }, { + "id": "def-server.IndexPatternsServiceProvider.start.$2", "type": "Object", "label": "{ fieldFormats, logger }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-server.IndexPatternsServiceStartDeps", - "text": "IndexPatternsServiceStartDeps" - } + "IndexPatternsServiceStartDeps" ], "description": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 58 + "lineNumber": 93 } } ], @@ -534,13 +505,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 58 + "lineNumber": 93 } } ], "source": { "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", - "lineNumber": 45 + "lineNumber": 79 }, "initialIsOpen": false } @@ -556,14 +527,14 @@ "description": [], "children": [ { - "id": "def-server.getCapabilitiesForRollupIndices.indices", + "id": "def-server.getCapabilitiesForRollupIndices.$1.indices", "type": "Object", "label": "indices", "tags": [], "description": [], "children": [ { - "id": "def-server.getCapabilitiesForRollupIndices.indices.Unnamed", + "id": "def-server.getCapabilitiesForRollupIndices.$1.indices.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], @@ -596,14 +567,14 @@ "type": "Function", "children": [ { - "id": "def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities", + "id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities", "type": "Object", "label": "rollupIndexCapabilities", "tags": [], "description": [], "children": [ { - "id": "def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities.Unnamed", + "id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], @@ -623,14 +594,14 @@ } }, { - "id": "def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi", + "id": "def-server.mergeCapabilitiesWithFields.$2.fieldsFromFieldCapsApi", "type": "Object", "label": "fieldsFromFieldCapsApi", "tags": [], "description": [], "children": [ { - "id": "def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi.Unnamed", + "id": "def-server.mergeCapabilitiesWithFields.$2.fieldsFromFieldCapsApi.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], @@ -650,6 +621,7 @@ } }, { + "id": "def-server.mergeCapabilitiesWithFields.$3", "type": "Array", "label": "previousFields", "isRequired": true, @@ -709,6 +681,7 @@ "description": [], "children": [ { + "id": "def-server.shouldReadFieldFromDocValues.$1", "type": "boolean", "label": "aggregatable", "isRequired": true, @@ -722,6 +695,7 @@ } }, { + "id": "def-server.shouldReadFieldFromDocValues.$2", "type": "string", "label": "esType", "isRequired": true, @@ -973,6 +947,7 @@ "description": [], "children": [ { + "id": "def-common.DuplicateIndexPatternError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -1277,6 +1252,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPattern.Unnamed.$1", "type": "Object", "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", "isRequired": true, @@ -1436,6 +1412,7 @@ ], "children": [ { + "id": "def-common.IndexPattern.addScriptedField.$1", "type": "string", "label": "name", "isRequired": true, @@ -1451,6 +1428,7 @@ } }, { + "id": "def-common.IndexPattern.addScriptedField.$2", "type": "string", "label": "script", "isRequired": true, @@ -1466,6 +1444,7 @@ } }, { + "id": "def-common.IndexPattern.addScriptedField.$3", "type": "string", "label": "fieldType", "isRequired": true, @@ -1498,6 +1477,7 @@ ], "children": [ { + "id": "def-common.IndexPattern.removeScriptedField.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -1640,6 +1620,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPattern.getFieldByName.$1", "type": "string", "label": "name", "isRequired": true, @@ -1737,6 +1718,7 @@ ], "children": [ { + "id": "def-common.IndexPattern.getFormatterForField.$1", "type": "CompoundType", "label": "field", "isRequired": true, @@ -1799,6 +1781,7 @@ ], "children": [ { + "id": "def-common.IndexPattern.addRuntimeField.$1", "type": "string", "label": "name", "isRequired": true, @@ -1814,6 +1797,7 @@ } }, { + "id": "def-common.IndexPattern.addRuntimeField.$2", "type": "Object", "label": "runtimeField", "isRequired": true, @@ -1854,6 +1838,7 @@ ], "children": [ { + "id": "def-common.IndexPattern.removeRuntimeField.$1", "type": "string", "label": "name", "isRequired": true, @@ -1896,6 +1881,7 @@ ], "children": [ { + "id": "def-common.IndexPattern.getFormatterForFieldNoDefault.$1", "type": "string", "label": "fieldname", "isRequired": true, @@ -1934,6 +1920,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPattern.setFieldAttrs.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -1947,6 +1934,7 @@ } }, { + "id": "def-common.IndexPattern.setFieldAttrs.$2", "type": "Uncategorized", "label": "attrName", "isRequired": true, @@ -1960,6 +1948,7 @@ } }, { + "id": "def-common.IndexPattern.setFieldAttrs.$3", "type": "Uncategorized", "label": "value", "isRequired": true, @@ -1997,6 +1986,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPattern.setFieldCustomLabel.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -2010,6 +2000,7 @@ } }, { + "id": "def-common.IndexPattern.setFieldCustomLabel.$2", "type": "CompoundType", "label": "customLabel", "isRequired": false, @@ -2040,6 +2031,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPattern.setFieldCount.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -2053,6 +2045,7 @@ } }, { + "id": "def-common.IndexPattern.setFieldCount.$2", "type": "CompoundType", "label": "count", "isRequired": false, @@ -2078,6 +2071,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPattern.setFieldFormat.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -2091,6 +2085,7 @@ } }, { + "id": "def-common.IndexPattern.setFieldFormat.$2", "type": "Object", "label": "format", "isRequired": true, @@ -2136,6 +2131,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPattern.deleteFieldFormat.$1", "type": "string", "label": "fieldName", "isRequired": true, @@ -2222,6 +2218,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPatternField.Unnamed.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -2682,7 +2679,7 @@ "description": [], "children": [ { - "id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }", + "id": "def-common.IndexPatternField.toSpec.$1.getFormatterForField", "type": "Object", "label": "{\n getFormatterForField,\n }", "tags": [], @@ -2690,7 +2687,7 @@ "children": [ { "tags": [], - "id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField", + "id": "def-common.IndexPatternField.toSpec.$1.getFormatterForField.getFormatterForField", "type": "Function", "label": "getFormatterForField", "description": [], @@ -2773,13 +2770,7 @@ "lineNumber": 67 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.EnsureDefaultIndexPattern", - "text": "EnsureDefaultIndexPattern" - } + "EnsureDefaultIndexPattern" ] }, { @@ -2792,6 +2783,7 @@ "description": [], "children": [ { + "id": "def-common.IndexPatternsService.Unnamed.$1", "type": "Object", "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, @@ -2817,6 +2809,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.getIds.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -2849,6 +2842,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.getTitles.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -2881,6 +2875,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.find.$1", "type": "string", "label": "search", "isRequired": true, @@ -2894,6 +2889,7 @@ } }, { + "id": "def-common.IndexPatternsService.find.$2", "type": "number", "label": "size", "isRequired": true, @@ -2936,6 +2932,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.getIdsWithTitle.$1", "type": "boolean", "label": "refresh", "isRequired": true, @@ -2968,6 +2965,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.clearCache.$1", "type": "string", "label": "id", "isRequired": false, @@ -3001,21 +2999,9 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSavedObjectAttrs", - "text": "IndexPatternSavedObjectAttrs" - }, + "IndexPatternSavedObjectAttrs", ">[] | null | undefined>" ], "description": [], @@ -3058,6 +3044,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.setDefault.$1", "type": "string", "label": "id", "isRequired": true, @@ -3071,6 +3058,7 @@ } }, { + "id": "def-common.IndexPatternsService.setDefault.$2", "type": "boolean", "label": "force", "isRequired": true, @@ -3103,6 +3091,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.getFieldsForWildcard.$1", "type": "Object", "label": "options", "isRequired": true, @@ -3151,6 +3140,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.getFieldsForIndexPattern.$1", "type": "CompoundType", "label": "indexPattern", "isRequired": true, @@ -3178,6 +3168,7 @@ } }, { + "id": "def-common.IndexPatternsService.getFieldsForIndexPattern.$2", "type": "Object", "label": "options", "isRequired": false, @@ -3243,6 +3234,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.refreshFields.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -3289,6 +3281,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", "label": "fields", "isRequired": true, @@ -3309,6 +3302,7 @@ } }, { + "id": "def-common.IndexPatternsService.fieldArrayToMap.$2", "type": "Object", "label": "fieldAttrs", "isRequired": false, @@ -3374,17 +3368,12 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.savedObjectToSpec.$1", "type": "Object", "label": "savedObject", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -3404,13 +3393,7 @@ ], "signature": [ "(savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "<", { "pluginId": "data", @@ -3446,6 +3429,7 @@ "type": "Function", "children": [ { + "id": "def-common.IndexPatternsService.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -3509,6 +3493,7 @@ ], "children": [ { + "id": "def-common.IndexPatternsService.create.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -3528,6 +3513,7 @@ } }, { + "id": "def-common.IndexPatternsService.create.$2", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -3578,6 +3564,7 @@ ], "children": [ { + "id": "def-common.IndexPatternsService.createAndSave.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -3597,6 +3584,7 @@ } }, { + "id": "def-common.IndexPatternsService.createAndSave.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -3612,6 +3600,7 @@ } }, { + "id": "def-common.IndexPatternsService.createAndSave.$3", "type": "boolean", "label": "skipFetchFields", "isRequired": true, @@ -3662,6 +3651,7 @@ ], "children": [ { + "id": "def-common.IndexPatternsService.createSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -3681,6 +3671,7 @@ } }, { + "id": "def-common.IndexPatternsService.createSavedObject.$2", "type": "boolean", "label": "override", "isRequired": true, @@ -3723,6 +3714,7 @@ ], "children": [ { + "id": "def-common.IndexPatternsService.updateSavedObject.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -3738,10 +3730,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 548 + "lineNumber": 551 } }, { + "id": "def-common.IndexPatternsService.updateSavedObject.$2", "type": "number", "label": "saveAttempts", "isRequired": true, @@ -3751,10 +3744,11 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 549 + "lineNumber": 552 } }, { + "id": "def-common.IndexPatternsService.updateSavedObject.$3", "type": "boolean", "label": "ignoreErrors", "isRequired": true, @@ -3764,7 +3758,7 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 550 + "lineNumber": 553 } } ], @@ -3772,7 +3766,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 547 + "lineNumber": 550 } }, { @@ -3787,6 +3781,7 @@ ], "children": [ { + "id": "def-common.IndexPatternsService.delete.$1", "type": "string", "label": "indexPatternId", "isRequired": true, @@ -3798,7 +3793,7 @@ ], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -3806,7 +3801,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 633 + "lineNumber": 636 } } ], @@ -3823,6 +3818,7 @@ "type": "Function", "children": [ { + "id": "def-common.fieldList.$1", "type": "Array", "label": "specs", "isRequired": true, @@ -3843,6 +3839,7 @@ } }, { + "id": "def-common.fieldList.$2", "type": "boolean", "label": "shortDotsEnable", "isRequired": true, @@ -3927,6 +3924,7 @@ "description": [], "children": [ { + "id": "def-common.isFilterable.$1", "type": "Object", "label": "field", "isRequired": true, @@ -3972,6 +3970,7 @@ "description": [], "children": [ { + "id": "def-common.isNestedField.$1", "type": "Object", "label": "field", "isRequired": true, @@ -5307,6 +5306,7 @@ "description": [], "children": [ { + "id": "def-common.IIndexPatternFieldList.add.$1", "type": "Object", "label": "field", "isRequired": true, @@ -5375,6 +5375,7 @@ "description": [], "children": [ { + "id": "def-common.IIndexPatternFieldList.getByName.$1", "type": "string", "label": "name", "isRequired": true, @@ -5413,6 +5414,7 @@ "description": [], "children": [ { + "id": "def-common.IIndexPatternFieldList.getByType.$1", "type": "string", "label": "type", "isRequired": true, @@ -5451,6 +5453,7 @@ "description": [], "children": [ { + "id": "def-common.IIndexPatternFieldList.remove.$1", "type": "Object", "label": "field", "isRequired": true, @@ -5511,6 +5514,7 @@ "description": [], "children": [ { + "id": "def-common.IIndexPatternFieldList.replaceAll.$1", "type": "Array", "label": "specs", "isRequired": true, @@ -5556,6 +5560,7 @@ "description": [], "children": [ { + "id": "def-common.IIndexPatternFieldList.update.$1", "type": "Object", "label": "field", "isRequired": true, @@ -5631,7 +5636,7 @@ "description": [], "children": [ { - "id": "def-common.IIndexPatternFieldList.toSpec.options", + "id": "def-common.IIndexPatternFieldList.toSpec.$1.options", "type": "Object", "label": "options", "tags": [], @@ -5639,7 +5644,7 @@ "children": [ { "tags": [], - "id": "def-common.IIndexPatternFieldList.toSpec.options.getFormatterForField", + "id": "def-common.IIndexPatternFieldList.toSpec.$1.options.getFormatterForField", "type": "Function", "label": "getFormatterForField", "description": [], @@ -6288,13 +6293,7 @@ "text": "SavedObjectsClientCommonFindArgs" }, ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]>" ] }, @@ -6310,13 +6309,7 @@ }, "signature": [ "(type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ] }, @@ -6332,13 +6325,7 @@ }, "signature": [ "(type: string, id: string, attributes: Record, options: Record) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ] }, @@ -6354,13 +6341,7 @@ }, "signature": [ "(type: string, attributes: Record, options: Record) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ] }, @@ -6710,10 +6691,10 @@ "description": [], "source": { "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", - "lineNumber": 639 + "lineNumber": 642 }, "signature": [ - "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; find: (search: string, size?: number) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }" + "{ get: (id: string) => Promise; 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; setDefault: (id: string, 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; }" ], "initialIsOpen": false }, diff --git a/api_docs/data_query.json b/api_docs/data_query.json index c7af23cf107b..b9fa69bd66b2 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -19,6 +19,7 @@ "description": [], "children": [ { + "id": "def-public.FilterManager.Unnamed.$1", "type": "Object", "label": "uiSettings", "isRequired": true, @@ -123,13 +124,7 @@ "label": "getPartitionedFilters", "signature": [ "() => ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.PartitionedFilters", - "text": "PartitionedFilters" - } + "PartitionedFilters" ], "description": [], "children": [], @@ -202,6 +197,7 @@ "description": [], "children": [ { + "id": "def-public.FilterManager.addFilters.$1", "type": "CompoundType", "label": "filters", "isRequired": true, @@ -230,6 +226,7 @@ } }, { + "id": "def-public.FilterManager.addFilters.$2", "type": "boolean", "label": "pinFilterStatus", "isRequired": true, @@ -268,6 +265,7 @@ "description": [], "children": [ { + "id": "def-public.FilterManager.setFilters.$1", "type": "Array", "label": "newFilters", "isRequired": true, @@ -288,6 +286,7 @@ } }, { + "id": "def-public.FilterManager.setFilters.$2", "type": "boolean", "label": "pinFilterStatus", "isRequired": true, @@ -328,6 +327,7 @@ ], "children": [ { + "id": "def-public.FilterManager.setGlobalFilters.$1", "type": "Array", "label": "newGlobalFilters", "isRequired": true, @@ -375,6 +375,7 @@ ], "children": [ { + "id": "def-public.FilterManager.setAppFilters.$1", "type": "Array", "label": "newAppFilters", "isRequired": true, @@ -420,6 +421,7 @@ "description": [], "children": [ { + "id": "def-public.FilterManager.removeFilter.$1", "type": "Object", "label": "filter", "isRequired": true, @@ -480,6 +482,7 @@ "description": [], "children": [ { + "id": "def-public.FilterManager.setFiltersStore.$1", "type": "Array", "label": "filters", "isRequired": true, @@ -500,6 +503,7 @@ } }, { + "id": "def-public.FilterManager.setFiltersStore.$2", "type": "Enum", "label": "store", "isRequired": true, @@ -519,6 +523,7 @@ } }, { + "id": "def-public.FilterManager.setFiltersStore.$3", "type": "boolean", "label": "shouldOverrideStore", "isRequired": true, @@ -563,6 +568,7 @@ "description": [], "children": [ { + "id": "def-public.TimeHistory.Unnamed.$1", "type": "Object", "label": "storage", "isRequired": true, @@ -608,6 +614,7 @@ "description": [], "children": [ { + "id": "def-public.TimeHistory.add.$1", "type": "Object", "label": "time", "isRequired": true, @@ -672,6 +679,7 @@ "type": "Function", "children": [ { + "id": "def-public.connectToQueryState.$1", "type": "Object", "label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }", "isRequired": true, @@ -693,13 +701,7 @@ "text": "FilterManager" }, "; queryString: Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringManager", - "text": "QueryStringManager" - }, + "QueryStringManager", ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", { "pluginId": "data", @@ -718,6 +720,7 @@ } }, { + "id": "def-public.connectToQueryState.$2", "type": "Object", "label": "stateContainer", "isRequired": true, @@ -738,7 +741,7 @@ } }, { - "id": "def-public.connectToQueryState.syncConfig", + "id": "def-public.connectToQueryState.$3.syncConfig", "type": "Object", "label": "syncConfig", "tags": [], @@ -746,7 +749,7 @@ "children": [ { "tags": [], - "id": "def-public.connectToQueryState.syncConfig.time", + "id": "def-public.connectToQueryState.$3.syncConfig.time", "type": "CompoundType", "label": "time", "description": [], @@ -760,7 +763,7 @@ }, { "tags": [], - "id": "def-public.connectToQueryState.syncConfig.refreshInterval", + "id": "def-public.connectToQueryState.$3.syncConfig.refreshInterval", "type": "CompoundType", "label": "refreshInterval", "description": [], @@ -774,7 +777,7 @@ }, { "tags": [], - "id": "def-public.connectToQueryState.syncConfig.filters", + "id": "def-public.connectToQueryState.$3.syncConfig.filters", "type": "CompoundType", "label": "filters", "description": [], @@ -796,7 +799,7 @@ }, { "tags": [], - "id": "def-public.connectToQueryState.syncConfig.query", + "id": "def-public.connectToQueryState.$3.syncConfig.query", "type": "CompoundType", "label": "query", "description": [], @@ -868,6 +871,7 @@ "type": "Function", "children": [ { + "id": "def-public.createSavedQueryService.$1", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -880,7 +884,7 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ], "description": [], "source": { @@ -898,7 +902,7 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">) => ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">) => ", { "pluginId": "data", "scope": "public", @@ -931,17 +935,12 @@ "description": [], "children": [ { + "id": "def-public.getDefaultQuery.$1", "type": "CompoundType", "label": "language", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryLanguage", - "text": "QueryLanguage" - } + "QueryLanguage" ], "description": [], "source": { @@ -963,6 +962,7 @@ "type": "Function", "children": [ { + "id": "def-public.syncQueryStateWithUrl.$1", "type": "Object", "label": "query", "isRequired": true, @@ -984,13 +984,7 @@ "text": "FilterManager" }, "; queryString: Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringManager", - "text": "QueryStringManager" - }, + "QueryStringManager", ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", { "pluginId": "data", @@ -1009,6 +1003,7 @@ } }, { + "id": "def-public.syncQueryStateWithUrl.$2", "type": "Object", "label": "kbnUrlStateStorage", "isRequired": true, @@ -1253,13 +1248,7 @@ "lineNumber": 17 }, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQueryAttributes", - "text": "SavedQueryAttributes" - } + "SavedQueryAttributes" ] } ], @@ -1288,13 +1277,7 @@ }, "signature": [ "(attributes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, + "SavedQueryAttributes", ", config?: { overwrite: boolean; } | undefined) => Promise<", { "pluginId": "data", @@ -1410,6 +1393,21 @@ ], "enums": [], "misc": [ + { + "id": "def-public.AutoRefreshDoneFn", + "type": "Type", + "label": "AutoRefreshDoneFn", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/lib/auto_refresh_loop.ts", + "lineNumber": 13 + }, + "signature": [ + "() => void" + ], + "initialIsOpen": false + }, { "id": "def-public.InputTimeRange", "type": "Type", @@ -1503,7 +1501,7 @@ "description": [], "source": { "path": "src/plugins/data/public/query/timefilter/timefilter.ts", - "lineNumber": 240 + "lineNumber": 242 }, "signature": [ "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ", @@ -1514,7 +1512,7 @@ "Observable", "; getAutoRefreshFetch$: () => ", "Observable", - "; getFetch$: () => ", + "; getFetch$: () => ", "Observable" ], "initialIsOpen": false @@ -1573,6 +1571,7 @@ "description": [], "children": [ { + "id": "def-common.calculateBounds.$1", "type": "Object", "label": "timeRange", "isRequired": true, @@ -1592,6 +1591,7 @@ } }, { + "id": "def-common.calculateBounds.$2", "type": "Object", "label": "options", "isRequired": true, @@ -1618,6 +1618,7 @@ "type": "Function", "children": [ { + "id": "def-common.compareFilters.$1", "type": "CompoundType", "label": "first", "isRequired": true, @@ -1646,6 +1647,7 @@ } }, { + "id": "def-common.compareFilters.$2", "type": "CompoundType", "label": "second", "isRequired": true, @@ -1674,6 +1676,7 @@ } }, { + "id": "def-common.compareFilters.$3", "type": "Object", "label": "comparatorOptions", "isRequired": true, @@ -1754,6 +1757,7 @@ "type": "Function", "children": [ { + "id": "def-common.dedupFilters.$1", "type": "Array", "label": "existingFilters", "isRequired": true, @@ -1774,6 +1778,7 @@ } }, { + "id": "def-common.dedupFilters.$2", "type": "Array", "label": "filters", "isRequired": true, @@ -1794,6 +1799,7 @@ } }, { + "id": "def-common.dedupFilters.$3", "type": "Object", "label": "comparatorOptions", "isRequired": true, @@ -1887,6 +1893,7 @@ "description": [], "children": [ { + "id": "def-common.getAbsoluteTimeRange.$1", "type": "Object", "label": "timeRange", "isRequired": true, @@ -1906,7 +1913,7 @@ } }, { - "id": "def-common.getAbsoluteTimeRange.{-forceNow }", + "id": "def-common.getAbsoluteTimeRange.$2.forceNow", "type": "Object", "label": "{ forceNow }", "tags": [], @@ -1914,7 +1921,7 @@ "children": [ { "tags": [], - "id": "def-common.getAbsoluteTimeRange.{-forceNow }.forceNow", + "id": "def-common.getAbsoluteTimeRange.$2.forceNow.forceNow", "type": "Object", "label": "forceNow", "description": [], @@ -1975,6 +1982,7 @@ "description": [], "children": [ { + "id": "def-common.getTime.$1", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -1995,6 +2003,7 @@ } }, { + "id": "def-common.getTime.$2", "type": "Object", "label": "timeRange", "isRequired": true, @@ -2014,7 +2023,7 @@ } }, { - "id": "def-common.getTime.options", + "id": "def-common.getTime.$3.options", "type": "Object", "label": "options", "tags": [], @@ -2022,7 +2031,7 @@ "children": [ { "tags": [], - "id": "def-common.getTime.options.forceNow", + "id": "def-common.getTime.$3.options.forceNow", "type": "Object", "label": "forceNow", "description": [], @@ -2036,7 +2045,7 @@ }, { "tags": [], - "id": "def-common.getTime.options.fieldName", + "id": "def-common.getTime.$3.options.fieldName", "type": "string", "label": "fieldName", "description": [], @@ -2068,6 +2077,7 @@ "type": "Function", "children": [ { + "id": "def-common.isQuery.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -2106,6 +2116,7 @@ "type": "Function", "children": [ { + "id": "def-common.isTimeRange.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -2144,6 +2155,7 @@ "type": "Function", "children": [ { + "id": "def-common.uniqFilters.$1", "type": "Array", "label": "filters", "isRequired": true, @@ -2164,6 +2176,7 @@ } }, { + "id": "def-common.uniqFilters.$2", "type": "Any", "label": "comparatorOptions", "isRequired": true, diff --git a/api_docs/data_search.json b/api_docs/data_search.json index 53b8294de02f..b50d6d267d3f 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -65,17 +65,12 @@ "description": [], "children": [ { + "id": "def-public.PainlessError.Unnamed.$1", "type": "Object", "label": "err", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.IEsError", - "text": "IEsError" - } + "IEsError" ], "description": [], "source": { @@ -84,6 +79,7 @@ } }, { + "id": "def-public.PainlessError.Unnamed.$2", "type": "Object", "label": "indexPattern", "isRequired": false, @@ -129,6 +125,7 @@ "description": [], "children": [ { + "id": "def-public.PainlessError.getErrorMessage.$1", "type": "Object", "label": "application", "isRequired": true, @@ -179,6 +176,7 @@ "description": [], "children": [ { + "id": "def-public.SearchInterceptor.Unnamed.$1", "type": "Object", "label": "deps", "isRequired": true, @@ -194,7 +192,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 75 + "lineNumber": 65 } } ], @@ -202,7 +200,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 75 + "lineNumber": 65 } }, { @@ -225,7 +223,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 91 + "lineNumber": 81 } }, { @@ -249,7 +247,7 @@ "section": "def-common.AbortError", "text": "AbortError" }, - ", timeoutSignal: AbortSignal, options?: ", + ", options?: ", { "pluginId": "data", "scope": "common", @@ -257,11 +255,12 @@ "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, - " | undefined) => Error" + " | undefined, isTimeout?: boolean | undefined) => Error" ], "description": [], "children": [ { + "id": "def-public.SearchInterceptor.handleSearchError.$1", "type": "CompoundType", "label": "e", "isRequired": true, @@ -285,23 +284,11 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 100 - } - }, - { - "type": "Object", - "label": "timeoutSignal", - "isRequired": true, - "signature": [ - "AbortSignal" - ], - "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 101 + "lineNumber": 90 } }, { + "id": "def-public.SearchInterceptor.handleSearchError.$2", "type": "Object", "label": "options", "isRequired": false, @@ -318,7 +305,21 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 102 + "lineNumber": 91 + } + }, + { + "id": "def-public.SearchInterceptor.handleSearchError.$3", + "type": "CompoundType", + "label": "isTimeout", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 92 } } ], @@ -326,7 +327,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 99 + "lineNumber": 89 } }, { @@ -350,7 +351,7 @@ "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, - " | undefined) => ", + ") => ", "Observable", "<", { @@ -367,6 +368,7 @@ ], "children": [ { + "id": "def-public.SearchInterceptor.search.$1", "type": "Object", "label": "request", "isRequired": true, @@ -383,13 +385,14 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 247 + "lineNumber": 183 } }, { + "id": "def-public.SearchInterceptor.search.$2", "type": "Object", "label": "options", - "isRequired": false, + "isRequired": true, "signature": [ { "pluginId": "data", @@ -397,13 +400,12 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" - }, - " | undefined" + } ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 248 + "lineNumber": 184 } } ], @@ -415,7 +417,7 @@ ], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 246 + "lineNumber": 182 } }, { @@ -428,6 +430,7 @@ "description": [], "children": [ { + "id": "def-public.SearchInterceptor.showError.$1", "type": "Object", "label": "e", "isRequired": true, @@ -437,7 +440,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 275 + "lineNumber": 207 } } ], @@ -445,13 +448,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 275 + "lineNumber": 207 } } ], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 50 + "lineNumber": 46 }, "initialIsOpen": false }, @@ -511,6 +514,7 @@ "description": [], "children": [ { + "id": "def-public.SearchTimeoutError.Unnamed.$1", "type": "Object", "label": "err", "isRequired": true, @@ -524,6 +528,7 @@ } }, { + "id": "def-public.SearchTimeoutError.Unnamed.$2", "type": "Enum", "label": "mode", "isRequired": true, @@ -568,6 +573,7 @@ "description": [], "children": [ { + "id": "def-public.SearchTimeoutError.getErrorMessage.$1", "type": "Object", "label": "application", "isRequired": true, @@ -621,6 +627,7 @@ "description": [], "children": [ { + "id": "def-public.getEsPreference.$1", "type": "Object", "label": "uiSettings", "isRequired": true, @@ -640,6 +647,7 @@ } }, { + "id": "def-public.getEsPreference.$2", "type": "string", "label": "sessionId", "isRequired": true, @@ -660,6 +668,84 @@ "lineNumber": 14 }, "initialIsOpen": false + }, + { + "id": "def-public.waitUntilNextSessionCompletes$", + "type": "Function", + "label": "waitUntilNextSessionCompletes$", + "signature": [ + "(sessionService: Pick<", + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">, { waitForIdle = 1000 }: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.WaitUntilNextSessionCompletesOptions", + "text": "WaitUntilNextSessionCompletesOptions" + }, + ") => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionState", + "text": "SearchSessionState" + }, + ">" + ], + "description": [ + "\nCreates an observable that emits when next search session completes.\nThis utility is helpful to use in the application to delay some tasks until next session completes.\n" + ], + "children": [ + { + "id": "def-public.waitUntilNextSessionCompletes$.$1", + "type": "Object", + "label": "sessionService", + "isRequired": true, + "signature": [ + "Pick<", + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + ], + "description": [ + "- {@link ISessionService}" + ], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 31 + } + }, + { + "id": "def-public.waitUntilNextSessionCompletes$.$2", + "type": "Object", + "label": "{ waitForIdle = 1000 }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.WaitUntilNextSessionCompletesOptions", + "text": "WaitUntilNextSessionCompletesOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 32 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 30 + }, + "initialIsOpen": false } ], "interfaces": [ @@ -683,13 +769,7 @@ "lineNumber": 29 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonSetup", - "text": "AggsCommonSetup" - } + "AggsCommonSetup" ] }, { @@ -703,13 +783,7 @@ "lineNumber": 30 }, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SearchUsageCollector", - "text": "SearchUsageCollector" - }, + "SearchUsageCollector", " | undefined" ] }, @@ -727,14 +801,8 @@ }, "signature": [ "Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SessionService", - "text": "SessionService" - }, - ", \"start\" | \"destroy\" | \"state$\" | \"searchSessionName$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ] }, { @@ -751,13 +819,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SessionsClient", - "text": "SessionsClient" - }, + "SessionsClient", ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" ] } @@ -793,30 +855,12 @@ }, "signature": [ "Pick & Pick<{ types: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggTypesRegistryStart", - "text": "AggTypesRegistryStart" - }, + "AggsCommonStart", + ", \"calculateAutoTimeExpression\" | \"datatableUtilities\" | \"createAggConfigs\"> & Pick<{ types: ", + "AggTypesRegistryStart", "; }, \"types\"> & Pick<{ types: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggTypesRegistryStart", - "text": "AggTypesRegistryStart" - }, - "; }, never>, \"calculateAutoTimeExpression\" | \"getDateMetaByDatatableColumn\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" + "AggTypesRegistryStart", + "; }, never>, \"calculateAutoTimeExpression\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" ] }, { @@ -891,14 +935,8 @@ }, "signature": [ "Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SessionService", - "text": "SessionService" - }, - ", \"start\" | \"destroy\" | \"state$\" | \"searchSessionName$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + "SessionService", + ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ] }, { @@ -915,13 +953,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SessionsClient", - "text": "SessionsClient" - }, + "SessionsClient", ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"rename\" | \"extend\">" ] } @@ -947,7 +979,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 41 + "lineNumber": 37 }, "signature": [ { @@ -967,7 +999,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 42 + "lineNumber": 38 }, "signature": [ { @@ -987,7 +1019,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 43 + "lineNumber": 39 }, "signature": [ { @@ -1007,7 +1039,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 44 + "lineNumber": 40 }, "signature": [ "Promise<[", @@ -1029,7 +1061,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 45 + "lineNumber": 41 }, "signature": [ "Pick<", @@ -1051,16 +1083,10 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 46 + "lineNumber": 42 }, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SearchUsageCollector", - "text": "SearchUsageCollector" - }, + "SearchUsageCollector", " | undefined" ] }, @@ -1072,24 +1098,18 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 47 + "lineNumber": 43 }, "signature": [ "Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.SessionService", - "text": "SessionService" - }, - ", \"start\" | \"destroy\" | \"state$\" | \"searchSessionName$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + "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.ts", - "lineNumber": 40 + "lineNumber": 36 }, "initialIsOpen": false }, @@ -1122,7 +1142,7 @@ ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 45 + "lineNumber": 46 }, "signature": [ "() => Promise" @@ -1138,7 +1158,7 @@ ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 51 + "lineNumber": 52 }, "signature": [ "boolean | undefined" @@ -1152,7 +1172,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 53 + "lineNumber": 54 }, "signature": [ "() => Promise<{ urlGeneratorId: ID; initialState: ", @@ -1177,7 +1197,39 @@ ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 40 + "lineNumber": 41 + }, + "initialIsOpen": false + }, + { + "id": "def-public.WaitUntilNextSessionCompletesOptions", + "type": "Interface", + "label": "WaitUntilNextSessionCompletesOptions", + "description": [ + "\nOptions for {@link waitUntilNextSessionCompletes$}" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.WaitUntilNextSessionCompletesOptions.waitForIdle", + "type": "number", + "label": "waitForIdle", + "description": [ + "\nFor how long to wait between session state transitions before considering that session completed" + ], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 20 + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/search/session/session_helpers.ts", + "lineNumber": 16 }, "initialIsOpen": false } @@ -1195,7 +1247,7 @@ ], "source": { "path": "src/plugins/data/public/search/session/search_session_state.ts", - "lineNumber": 20 + "lineNumber": 21 }, "initialIsOpen": false }, @@ -1213,69 +1265,6 @@ } ], "misc": [ - { - "id": "def-public.EsdslExpressionFunctionDefinition", - "type": "Type", - "label": "EsdslExpressionFunctionDefinition", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/data/public/search/expressions/esdsl.ts", - "lineNumber": 30 - }, - "signature": [ - "ExpressionFunctionDefinition<\"esdsl\", ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"kibana_context\", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, - "> | null, Arguments, Output, ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState" - ], - "initialIsOpen": false - }, - { - "id": "def-public.EsRawResponseExpressionTypeDefinition", - "type": "Type", - "label": "EsRawResponseExpressionTypeDefinition", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/data/public/search/expressions/es_raw_response.ts", - "lineNumber": 57 - }, - "signature": [ - "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" - ], - "initialIsOpen": false - }, { "id": "def-public.ISessionsClient", "type": "Type", @@ -1299,10 +1288,10 @@ "description": [], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", - "lineNumber": 31 + "lineNumber": 32 }, "signature": [ - "{ start: () => string; destroy: () => void; readonly state$: Observable; readonly searchSessionName$: Observable; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => () => void; getSessionId: () => string | undefined; getSession$: () => Observable; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }" + "{ start: () => string; destroy: () => void; readonly state$: Observable; 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; }" ], "initialIsOpen": false }, @@ -1363,6 +1352,7 @@ "description": [], "children": [ { + "id": "def-server.getDefaultSearchParams.$1", "type": "Object", "label": "uiSettingsClient", "isRequired": true, @@ -1409,6 +1399,7 @@ "description": [], "children": [ { + "id": "def-server.getShardTimeout.$1", "type": "Object", "label": "config", "isRequired": true, @@ -1474,6 +1465,7 @@ ], "children": [ { + "id": "def-server.searchUsageObserver.$1", "type": "Object", "label": "logger", "isRequired": true, @@ -1487,6 +1479,7 @@ } }, { + "id": "def-server.searchUsageObserver.$2", "type": "Object", "label": "usage", "isRequired": false, @@ -1507,6 +1500,7 @@ } }, { + "id": "def-server.searchUsageObserver.$3", "type": "Object", "label": "{ isRestore }", "isRequired": true, @@ -1559,6 +1553,7 @@ "description": [], "children": [ { + "id": "def-server.usageProvider.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1625,13 +1620,7 @@ }, "signature": [ "(sessionId: string, attributes: Partial) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", " | undefined>" ] }, @@ -1647,13 +1636,7 @@ }, "signature": [ "(sessionId: string) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ] }, @@ -1811,13 +1794,7 @@ "text": "KibanaRequest" }, ") => ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.IScopedSearchSessionsClient", - "text": "IScopedSearchSessionsClient" - }, + "IScopedSearchSessionsClient", "" ] } @@ -1846,13 +1823,7 @@ "lineNumber": 43 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonSetup", - "text": "AggsCommonSetup" - } + "AggsCommonSetup" ] }, { @@ -1968,13 +1939,7 @@ "lineNumber": 103 }, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.AggsStart", - "text": "AggsStart" - } + "AggsStart" ] }, { @@ -2211,7 +2176,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { @@ -2265,13 +2230,7 @@ "lineNumber": 39 }, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.IScopedSearchSessionsClient", - "text": "IScopedSearchSessionsClient" - }, + "IScopedSearchSessionsClient", "" ] } @@ -2315,6 +2274,7 @@ "description": [], "children": [ { + "id": "def-server.SearchUsage.trackSuccess.$1", "type": "number", "label": "duration", "isRequired": true, @@ -2392,6 +2352,7 @@ ], "children": [ { + "id": "def-common.AggConfig.ensureIds.$1", "type": "Array", "label": "list", "isRequired": true, @@ -2438,6 +2399,7 @@ ], "children": [ { + "id": "def-common.AggConfig.nextId.$1", "type": "Array", "label": "list", "isRequired": true, @@ -2584,6 +2546,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.Unnamed.$1", "type": "Object", "label": "aggConfigs", "isRequired": true, @@ -2603,18 +2566,13 @@ } }, { + "id": "def-common.AggConfig.Unnamed.$2", "type": "Object", "label": "opts", "isRequired": true, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", @@ -2659,6 +2617,7 @@ ], "children": [ { + "id": "def-common.AggConfig.setParams.$1", "type": "Any", "label": "from", "isRequired": true, @@ -2693,6 +2652,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.getParam.$1", "type": "string", "label": "key", "isRequired": true, @@ -2731,6 +2691,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.write.$1", "type": "Object", "label": "aggs", "isRequired": false, @@ -2784,6 +2745,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.createFilter.$1", "type": "string", "label": "key", "isRequired": true, @@ -2797,6 +2759,7 @@ } }, { + "id": "def-common.AggConfig.createFilter.$2", "type": "Object", "label": "params", "isRequired": true, @@ -2845,6 +2808,7 @@ ], "children": [ { + "id": "def-common.AggConfig.onSearchRequestStart.$1", "type": "Object", "label": "searchSource", "isRequired": true, @@ -2866,6 +2830,7 @@ } }, { + "id": "def-common.AggConfig.onSearchRequestStart.$2", "type": "Object", "label": "options", "isRequired": false, @@ -2915,6 +2880,7 @@ ], "children": [ { + "id": "def-common.AggConfig.toDsl.$1", "type": "Object", "label": "aggConfigs", "isRequired": false, @@ -2954,13 +2920,7 @@ "label": "serialize", "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; }" ], "description": [], @@ -2980,13 +2940,7 @@ "label": "toJSON", "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; }" ], "description": [], @@ -3136,6 +3090,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.getValue.$1", "type": "Any", "label": "bucket", "isRequired": true, @@ -3166,6 +3121,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.getKey.$1", "type": "Any", "label": "bucket", "isRequired": true, @@ -3179,6 +3135,7 @@ } }, { + "id": "def-common.AggConfig.getKey.$2", "type": "string", "label": "key", "isRequired": false, @@ -3259,6 +3216,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.makeLabel.$1", "type": "boolean", "label": "percentageMode", "isRequired": true, @@ -3347,7 +3305,7 @@ "type": "Function", "label": "fieldIsTimeField", "signature": [ - "() => boolean | \"\" | undefined" + "() => boolean" ], "description": [], "children": [], @@ -3366,7 +3324,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 448 + "lineNumber": 452 }, "signature": [ { @@ -3386,7 +3344,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 452 + "lineNumber": 456 }, "signature": [ { @@ -3416,6 +3374,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfig.setType.$1", "type": "Object", "label": "type", "isRequired": true, @@ -3431,7 +3390,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 482 + "lineNumber": 486 } } ], @@ -3439,7 +3398,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 482 + "lineNumber": 486 } } ], @@ -3497,6 +3456,20 @@ " | undefined" ] }, + { + "tags": [], + "id": "def-common.AggConfigs.timeFields", + "type": "Array", + "label": "timeFields", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67 + }, + "signature": [ + "string[] | undefined" + ] + }, { "tags": [], "id": "def-common.AggConfigs.aggs", @@ -3505,7 +3478,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 69 + "lineNumber": 70 }, "signature": [ { @@ -3528,6 +3501,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.Unnamed.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -3543,22 +3517,17 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 72 + "lineNumber": 73 } }, { + "id": "def-common.AggConfigs.Unnamed.$2", "type": "Array", "label": "configStates", "isRequired": true, "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", @@ -3580,26 +3549,58 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 + "lineNumber": 74 } }, { - "type": "Object", - "label": "opts", - "isRequired": true, + "id": "def-common.AggConfigs.Unnamed.$3", + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigsOptions", + "text": "AggConfigsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 75 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 72 + } + }, + { + "id": "def-common.AggConfigs.setTimeFields", + "type": "Function", + "label": "setTimeFields", + "signature": [ + "(timeFields: string[] | undefined) => void" + ], + "description": [], + "children": [ + { + "id": "def-common.AggConfigs.setTimeFields.$1", + "type": "Array", + "label": "timeFields", + "isRequired": false, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigsOptions", - "text": "AggConfigsOptions" - } + "string[] | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 74 + "lineNumber": 87 } } ], @@ -3607,7 +3608,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 71 + "lineNumber": 87 } }, { @@ -3628,6 +3629,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.setTimeRange.$1", "type": "Object", "label": "timeRange", "isRequired": true, @@ -3643,7 +3645,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 86 + "lineNumber": 91 } } ], @@ -3651,7 +3653,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 86 + "lineNumber": 91 } }, { @@ -3671,6 +3673,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.clone.$1", "type": "Object", "label": "{ enabledOnly = true }", "isRequired": true, @@ -3680,7 +3683,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 104 + "lineNumber": 109 } } ], @@ -3688,7 +3691,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 104 + "lineNumber": 109 } }, { @@ -3696,18 +3699,13 @@ "type": "Function", "children": [ { + "id": "def-common.AggConfigs.createAggConfig.$1", "type": "Object", "label": "params", "isRequired": true, "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", @@ -3729,10 +3727,11 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 118 + "lineNumber": 123 } }, { + "id": "def-common.AggConfigs.createAggConfig.$2", "type": "Object", "label": "{ addToAggConfigs = true }", "isRequired": true, @@ -3742,7 +3741,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 119 + "lineNumber": 124 } } ], @@ -3764,13 +3763,7 @@ "text": "AggConfig" }, ">(params: Pick & Pick<{ type: string | ", { "pluginId": "data", @@ -3792,7 +3785,7 @@ "label": "createAggConfig", "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 117 + "lineNumber": 122 }, "tags": [], "returnComment": [] @@ -3817,6 +3810,7 @@ ], "children": [ { + "id": "def-common.AggConfigs.jsonDataEquals.$1", "type": "Array", "label": "aggConfigs", "isRequired": true, @@ -3835,7 +3829,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 160 + "lineNumber": 165 } } ], @@ -3843,7 +3837,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 160 + "lineNumber": 165 } }, { @@ -3856,6 +3850,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.toDsl.$1", "type": "boolean", "label": "hierarchical", "isRequired": true, @@ -3865,7 +3860,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 172 + "lineNumber": 177 } } ], @@ -3873,7 +3868,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 172 + "lineNumber": 177 } }, { @@ -3897,7 +3892,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 241 + "lineNumber": 246 } }, { @@ -3917,6 +3912,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.byIndex.$1", "type": "number", "label": "index", "isRequired": true, @@ -3926,7 +3922,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 245 + "lineNumber": 250 } } ], @@ -3934,7 +3930,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 245 + "lineNumber": 250 } }, { @@ -3955,6 +3951,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.byId.$1", "type": "string", "label": "id", "isRequired": true, @@ -3964,7 +3961,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 249 + "lineNumber": 254 } } ], @@ -3972,7 +3969,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 249 + "lineNumber": 254 } }, { @@ -3993,6 +3990,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.byName.$1", "type": "string", "label": "name", "isRequired": true, @@ -4002,7 +4000,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 253 + "lineNumber": 258 } } ], @@ -4010,7 +4008,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 253 + "lineNumber": 258 } }, { @@ -4031,6 +4029,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.byType.$1", "type": "string", "label": "type", "isRequired": true, @@ -4040,7 +4039,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 257 + "lineNumber": 262 } } ], @@ -4048,7 +4047,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 257 + "lineNumber": 262 } }, { @@ -4069,6 +4068,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.byTypeName.$1", "type": "string", "label": "type", "isRequired": true, @@ -4078,7 +4078,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 261 + "lineNumber": 266 } } ], @@ -4086,7 +4086,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 261 + "lineNumber": 266 } }, { @@ -4107,6 +4107,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.bySchemaName.$1", "type": "string", "label": "schema", "isRequired": true, @@ -4116,7 +4117,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 265 + "lineNumber": 270 } } ], @@ -4124,7 +4125,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 265 + "lineNumber": 270 } }, { @@ -4148,7 +4149,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 269 + "lineNumber": 274 } }, { @@ -4169,6 +4170,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.getRequestAggById.$1", "type": "string", "label": "id", "isRequired": true, @@ -4178,7 +4180,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 283 + "lineNumber": 288 } } ], @@ -4186,7 +4188,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 283 + "lineNumber": 288 } }, { @@ -4214,7 +4216,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 298 + "lineNumber": 303 } }, { @@ -4237,6 +4239,7 @@ ], "children": [ { + "id": "def-common.AggConfigs.getResponseAggById.$1", "type": "string", "label": "id", "isRequired": true, @@ -4248,7 +4251,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 312 + "lineNumber": 317 } } ], @@ -4258,7 +4261,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 312 + "lineNumber": 317 } }, { @@ -4287,6 +4290,7 @@ "description": [], "children": [ { + "id": "def-common.AggConfigs.onSearchRequestStart.$1", "type": "Object", "label": "searchSource", "isRequired": true, @@ -4304,10 +4308,11 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 326 } }, { + "id": "def-common.AggConfigs.onSearchRequestStart.$2", "type": "Object", "label": "options", "isRequired": false, @@ -4324,7 +4329,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 326 } } ], @@ -4332,7 +4337,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 + "lineNumber": 326 } } ], @@ -4379,13 +4384,7 @@ }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" ] }, @@ -4413,6 +4412,7 @@ "description": [], "children": [ { + "id": "def-common.AggParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -4455,41 +4455,24 @@ "label": "setup", "signature": [ "({ registerFunction }: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonSetupDependencies", - "text": "AggsCommonSetupDependencies" - }, + "AggsCommonSetupDependencies", ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonSetup", - "text": "AggsCommonSetup" - } + "AggsCommonSetup" ], "description": [], "children": [ { + "id": "def-common.AggsCommonService.setup.$1", "type": "Object", "label": "{ registerFunction }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonSetupDependencies", - "text": "AggsCommonSetupDependencies" - } + "AggsCommonSetupDependencies" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 56 + "lineNumber": 55 } } ], @@ -4497,7 +4480,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 56 + "lineNumber": 55 } }, { @@ -4506,41 +4489,24 @@ "label": "start", "signature": [ "({ getConfig, getIndexPattern, isDefaultTimezone, }: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStartDependencies", - "text": "AggsCommonStartDependencies" - }, + "AggsCommonStartDependencies", ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStart", - "text": "AggsCommonStart" - } + "AggsCommonStart" ], "description": [], "children": [ { + "id": "def-common.AggsCommonService.start.$1", "type": "Object", "label": "{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStartDependencies", - "text": "AggsCommonStartDependencies" - } + "AggsCommonStartDependencies" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 73 + "lineNumber": 72 } } ], @@ -4548,13 +4514,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 73 + "lineNumber": 72 } } ], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "lineNumber": 53 + "lineNumber": 52 }, "initialIsOpen": false }, @@ -4935,6 +4901,7 @@ "type": "Function", "children": [ { + "id": "def-common.AggType.paramByName.$1", "type": "string", "label": "name", "isRequired": true, @@ -4965,6 +4932,7 @@ "type": "Function", "children": [ { + "id": "def-common.AggType.getValueBucketPath.$1", "type": "Uncategorized", "label": "agg", "isRequired": true, @@ -5002,6 +4970,7 @@ ], "children": [ { + "id": "def-common.AggType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -5062,13 +5031,7 @@ "children": [], "signature": [ "() => { registerBucket: ", { "pluginId": "data", @@ -5078,13 +5041,7 @@ "text": "BucketAggType" }, ">(name: N, type: T) => void; registerMetric: ", { "pluginId": "data", @@ -5355,6 +5312,7 @@ "description": [], "children": [ { + "id": "def-common.BaseParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -5450,6 +5408,7 @@ "description": [], "children": [ { + "id": "def-common.BucketAggType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -5525,6 +5484,7 @@ "description": [], "children": [ { + "id": "def-common.CidrMask.Unnamed.$1", "type": "string", "label": "mask", "isRequired": true, @@ -5625,7 +5585,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 24 + "lineNumber": 27 } }, { @@ -5636,7 +5596,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 25 + "lineNumber": 28 } }, { @@ -5647,7 +5607,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 26 + "lineNumber": 29 }, "signature": [ { @@ -5667,7 +5627,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 27 + "lineNumber": 30 } }, { @@ -5680,6 +5640,7 @@ "description": [], "children": [ { + "id": "def-common.FieldParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -5689,7 +5650,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 29 + "lineNumber": 32 } } ], @@ -5697,7 +5658,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 29 + "lineNumber": 32 } }, { @@ -5705,6 +5666,7 @@ "type": "Function", "children": [ { + "id": "def-common.FieldParamType.getAvailableFields.$1", "type": "Object", "label": "aggConfig", "isRequired": true, @@ -5720,7 +5682,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 100 + "lineNumber": 126 } } ], @@ -5749,7 +5711,7 @@ "label": "getAvailableFields", "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 100 + "lineNumber": 126 }, "tags": [], "returnComment": [] @@ -5757,7 +5719,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 23 + "lineNumber": 26 }, "initialIsOpen": false }, @@ -5788,6 +5750,7 @@ "description": [], "children": [ { + "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$1", "type": "string", "label": "interval", "isRequired": true, @@ -5801,6 +5764,7 @@ } }, { + "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$2", "type": "number", "label": "value", "isRequired": true, @@ -5814,6 +5778,7 @@ } }, { + "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$3", "type": "CompoundType", "label": "unit", "isRequired": true, @@ -5827,6 +5792,7 @@ } }, { + "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$4", "type": "string", "label": "type", "isRequired": true, @@ -5881,6 +5847,7 @@ "description": [], "children": [ { + "id": "def-common.InvalidEsIntervalFormatError.Unnamed.$1", "type": "string", "label": "interval", "isRequired": true, @@ -5925,6 +5892,7 @@ "description": [], "children": [ { + "id": "def-common.Ipv4Address.Unnamed.$1", "type": "CompoundType", "label": "ipAddress", "isRequired": true, @@ -6027,6 +5995,7 @@ "description": [], "children": [ { + "id": "def-common.JsonParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -6149,6 +6118,7 @@ "description": [], "children": [ { + "id": "def-common.MetricAggType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -6240,6 +6210,7 @@ "description": [], "children": [ { + "id": "def-common.OptionedParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -6318,6 +6289,7 @@ "description": [], "children": [ { + "id": "def-common.RequestFailure.Unnamed.$1", "type": "CompoundType", "label": "err", "isRequired": false, @@ -6338,6 +6310,7 @@ } }, { + "id": "def-common.RequestFailure.Unnamed.$2", "type": "Object", "label": "resp", "isRequired": false, @@ -6399,6 +6372,7 @@ "description": [], "children": [ { + "id": "def-common.SearchSource.Unnamed.$1", "type": "Object", "label": "fields", "isRequired": true, @@ -6418,6 +6392,7 @@ } }, { + "id": "def-common.SearchSource.Unnamed.$2", "type": "Object", "label": "dependencies", "isRequired": true, @@ -6456,6 +6431,7 @@ ], "children": [ { + "id": "def-common.SearchSource.setPreferredSearchStrategyId.$1", "type": "string", "label": "searchStrategyId", "isRequired": true, @@ -6496,6 +6472,7 @@ ], "children": [ { + "id": "def-common.SearchSource.setField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6511,6 +6488,7 @@ } }, { + "id": "def-common.SearchSource.setField.$2", "type": "Uncategorized", "label": "value", "isRequired": true, @@ -6552,6 +6530,7 @@ ], "children": [ { + "id": "def-common.SearchSource.removeField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6594,6 +6573,7 @@ ], "children": [ { + "id": "def-common.SearchSource.setFields.$1", "type": "Object", "label": "newFields", "isRequired": true, @@ -6687,6 +6667,7 @@ ], "children": [ { + "id": "def-common.SearchSource.getField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6700,6 +6681,7 @@ } }, { + "id": "def-common.SearchSource.getField.$2", "type": "boolean", "label": "recurse", "isRequired": true, @@ -6740,6 +6722,7 @@ ], "children": [ { + "id": "def-common.SearchSource.getOwnField.$1", "type": "Uncategorized", "label": "field", "isRequired": true, @@ -6829,6 +6812,7 @@ ], "children": [ { + "id": "def-common.SearchSource.createChild.$1", "type": "Object", "label": "options", "isRequired": true, @@ -6877,6 +6861,7 @@ ], "children": [ { + "id": "def-common.SearchSource.setParent.$1", "type": "Object", "label": "parent", "isRequired": false, @@ -6900,6 +6885,7 @@ } }, { + "id": "def-common.SearchSource.setParent.$2", "type": "Object", "label": "options", "isRequired": true, @@ -6984,6 +6970,7 @@ ], "children": [ { + "id": "def-common.SearchSource.fetch$.$1", "type": "Object", "label": "options", "isRequired": true, @@ -7032,6 +7019,7 @@ ], "children": [ { + "id": "def-common.SearchSource.fetch.$1", "type": "Object", "label": "options", "isRequired": true, @@ -7088,6 +7076,7 @@ ], "children": [ { + "id": "def-common.SearchSource.onRequestStart.$1", "type": "Function", "label": "handler", "isRequired": true, @@ -7183,6 +7172,7 @@ ], "children": [ { + "id": "def-common.SearchSource.getSerializedFields.$1", "type": "boolean", "label": "recurse", "isRequired": true, @@ -7209,13 +7199,7 @@ "label": "serialize", "signature": [ "() => { searchSourceJSON: string; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [ @@ -7274,7 +7258,7 @@ "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, - ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ", + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ", { "pluginId": "data", "scope": "common", @@ -7310,6 +7294,7 @@ "description": [], "children": [ { + "id": "def-common.SearchSourceService.start.$1", "type": "Object", "label": "indexPatterns", "isRequired": true, @@ -7322,7 +7307,7 @@ "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, - ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], "description": [], "source": { @@ -7331,6 +7316,7 @@ } }, { + "id": "def-common.SearchSourceService.start.$2", "type": "Object", "label": "dependencies", "isRequired": true, @@ -7423,6 +7409,7 @@ "description": [], "children": [ { + "id": "def-common.StringParamType.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -7945,6 +7932,23 @@ "returnComment": [], "initialIsOpen": false }, + { + "id": "def-common.aggSinglePercentile", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggSinglePercentile", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts", + "lineNumber": 25 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-common.aggStdDeviation", "type": "Function", @@ -8025,6 +8029,7 @@ ], "children": [ { + "id": "def-common.calcAutoIntervalLessThan.$1", "type": "number", "label": "maxBucketCount", "isRequired": true, @@ -8040,6 +8045,7 @@ } }, { + "id": "def-common.calcAutoIntervalLessThan.$2", "type": "number", "label": "duration", "isRequired": true, @@ -8075,6 +8081,7 @@ ], "children": [ { + "id": "def-common.calcAutoIntervalNear.$1", "type": "number", "label": "targetBucketCount", "isRequired": true, @@ -8090,6 +8097,7 @@ } }, { + "id": "def-common.calcAutoIntervalNear.$2", "type": "number", "label": "duration", "isRequired": true, @@ -8131,6 +8139,7 @@ "description": [], "children": [ { + "id": "def-common.convertDateRangeToString.$1", "type": "Object", "label": "{ from, to }", "isRequired": true, @@ -8150,6 +8159,7 @@ } }, { + "id": "def-common.convertDateRangeToString.$2", "type": "Function", "label": "format", "isRequired": true, @@ -8176,6 +8186,7 @@ "type": "Function", "children": [ { + "id": "def-common.convertIPRangeToString.$1", "type": "CompoundType", "label": "range", "isRequired": true, @@ -8195,6 +8206,7 @@ } }, { + "id": "def-common.convertIPRangeToString.$2", "type": "Function", "label": "format", "isRequired": true, @@ -8234,6 +8246,7 @@ "type": "Function", "children": [ { + "id": "def-common.createSearchSource.$1", "type": "Object", "label": "indexPatterns", "isRequired": true, @@ -8246,7 +8259,7 @@ "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, - ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], "description": [], "source": { @@ -8255,6 +8268,7 @@ } }, { + "id": "def-common.createSearchSource.$2", "type": "Object", "label": "searchSourceDependencies", "isRequired": true, @@ -8283,7 +8297,7 @@ "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, - ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ", + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ", { "pluginId": "data", "scope": "common", @@ -8338,6 +8352,7 @@ ], "children": [ { + "id": "def-common.dateHistogramInterval.$1", "type": "string", "label": "interval", "isRequired": true, @@ -8366,6 +8381,7 @@ "type": "Function", "children": [ { + "id": "def-common.extractReferences.$1", "type": "Object", "label": "state", "isRequired": true, @@ -8446,6 +8462,7 @@ ], "children": [ { + "id": "def-common.fetchSoon.$1", "type": "Object", "label": "request", "isRequired": true, @@ -8459,6 +8476,7 @@ } }, { + "id": "def-common.fetchSoon.$2", "type": "Object", "label": "options", "isRequired": true, @@ -8478,6 +8496,7 @@ } }, { + "id": "def-common.fetchSoon.$3", "type": "Object", "label": "fetchHandlers", "isRequired": true, @@ -8510,6 +8529,7 @@ "type": "Function", "children": [ { + "id": "def-common.filtersToAst.$1", "type": "CompoundType", "label": "filters", "isRequired": true, @@ -8580,6 +8600,7 @@ "type": "Function", "children": [ { + "id": "def-common.functionWrapper.$1", "type": "Object", "label": "spec", "isRequired": true, @@ -8823,6 +8844,7 @@ "description": [], "children": [ { + "id": "def-common.getCalculateAutoTimeExpression.$1", "type": "Function", "label": "getConfig", "isRequired": true, @@ -8948,6 +8970,7 @@ "type": "Function", "children": [ { + "id": "def-common.getDateHistogramBucketAgg.$1", "type": "Object", "label": "{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}", "isRequired": true, @@ -8963,7 +8986,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 74 + "lineNumber": 76 } } ], @@ -8998,7 +9021,63 @@ "label": "getDateHistogramBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 74 + "lineNumber": 76 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getDateHistogramMetaDataByDatatableColumn", + "type": "Function", + "children": [ + { + "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$1", + "type": "Object", + "label": "column", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", + "lineNumber": 20 + } + } + ], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => { interval: string | undefined; timeZone: string | undefined; timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; } | undefined" + ], + "description": [ + "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." + ], + "label": "getDateHistogramMetaDataByDatatableColumn", + "source": { + "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", + "lineNumber": 20 }, "tags": [], "returnComment": [], @@ -9009,6 +9088,7 @@ "type": "Function", "children": [ { + "id": "def-common.getDateRangeBucketAgg.$1", "type": "Object", "label": "{\n isDefaultTimezone,\n getConfig,\n}", "isRequired": true, @@ -9098,12 +9178,68 @@ "returnComment": [], "initialIsOpen": false }, + { + "id": "def-common.getEsdslFn", + "type": "Function", + "children": [ + { + "id": "def-common.getEsdslFn.$1.getStartDependencies", + "type": "Object", + "label": "{\n getStartDependencies,\n}", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.getEsdslFn.$1.getStartDependencies.getStartDependencies", + "type": "Function", + "label": "getStartDependencies", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 45 + }, + "signature": [ + "(getKibanaRequest: any) => Promise<", + "EsdslStartDependencies", + ">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 44 + } + } + ], + "signature": [ + "({ getStartDependencies, }: { getStartDependencies: (getKibanaRequest: any) => Promise<", + "EsdslStartDependencies", + ">; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsdslExpressionFunctionDefinition", + "text": "EsdslExpressionFunctionDefinition" + } + ], + "description": [], + "label": "getEsdslFn", + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 42 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-common.getFilterBucketAgg", "type": "Function", "children": [ { - "id": "def-common.getFilterBucketAgg.{-getConfig }", + "id": "def-common.getFilterBucketAgg.$1.getConfig", "type": "Object", "label": "{ getConfig }", "tags": [], @@ -9111,7 +9247,7 @@ "children": [ { "tags": [], - "id": "def-common.getFilterBucketAgg.{-getConfig }.getConfig", + "id": "def-common.getFilterBucketAgg.$1.getConfig.getConfig", "type": "Function", "label": "getConfig", "description": [], @@ -9197,6 +9333,7 @@ "type": "Function", "children": [ { + "id": "def-common.getFiltersBucketAgg.$1", "type": "Object", "label": "{ getConfig }", "isRequired": true, @@ -9382,6 +9519,7 @@ "type": "Function", "children": [ { + "id": "def-common.getHistogramBucketAgg.$1", "type": "Object", "label": "{\n getConfig,\n getFieldFormatsStart,\n}", "isRequired": true, @@ -9476,6 +9614,7 @@ "type": "Function", "children": [ { + "id": "def-common.getKibanaContextFn.$1", "type": "Function", "label": "getStartDependencies", "isRequired": true, @@ -9489,13 +9628,7 @@ "text": "KibanaRequest" }, ") | undefined) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.KibanaContextStartDependencies", - "text": "KibanaContextStartDependencies" - }, + "KibanaContextStartDependencies", ">" ], "description": [], @@ -9672,6 +9805,7 @@ "type": "Function", "children": [ { + "id": "def-common.getNumberHistogramIntervalByDatatableColumn.$1", "type": "Object", "label": "column", "isRequired": true, @@ -9719,6 +9853,7 @@ "type": "Function", "children": [ { + "id": "def-common.getPercentileRanksMetricAgg.$1", "type": "Object", "label": "{\n getFieldFormatsStart,\n}", "isRequired": true, @@ -9814,6 +9949,7 @@ "description": [], "children": [ { + "id": "def-common.getPreference.$1", "type": "Function", "label": "getConfig", "isRequired": true, @@ -9846,6 +9982,7 @@ "type": "Function", "children": [ { + "id": "def-common.getRangeBucketAgg.$1", "type": "Object", "label": "{ getFieldFormatsStart }", "isRequired": true, @@ -9927,6 +10064,7 @@ "description": [], "children": [ { + "id": "def-common.getRequestInspectorStats.$1", "type": "Object", "label": "searchSource", "isRequired": true, @@ -9985,6 +10123,7 @@ "description": [], "children": [ { + "id": "def-common.getResponseInspectorStats.$1", "type": "Object", "label": "resp", "isRequired": true, @@ -9999,6 +10138,7 @@ } }, { + "id": "def-common.getResponseInspectorStats.$2", "type": "Object", "label": "searchSource", "isRequired": false, @@ -10048,6 +10188,7 @@ "description": [], "children": [ { + "id": "def-common.getSearchParams.$1", "type": "Function", "label": "getConfig", "isRequired": true, @@ -10100,6 +10241,7 @@ "description": [], "children": [ { + "id": "def-common.getSearchParamsFromRequest.$1", "type": "Object", "label": "searchRequest", "isRequired": true, @@ -10113,7 +10255,7 @@ } }, { - "id": "def-common.getSearchParamsFromRequest.dependencies", + "id": "def-common.getSearchParamsFromRequest.$2.dependencies", "type": "Object", "label": "dependencies", "tags": [], @@ -10121,7 +10263,7 @@ "children": [ { "tags": [], - "id": "def-common.getSearchParamsFromRequest.dependencies.getConfig", + "id": "def-common.getSearchParamsFromRequest.$2.dependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], @@ -10222,6 +10364,39 @@ "returnComment": [], "initialIsOpen": false }, + { + "id": "def-common.getSinglePercentileMetricAgg", + "type": "Function", + "children": [], + "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" + }, + ">" + ], + "description": [], + "label": "getSinglePercentileMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", + "lineNumber": 25 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-common.getStdDeviationMetricAgg", "type": "Function", @@ -10351,17 +10526,12 @@ "type": "Function", "children": [ { + "id": "def-common.handleRequest.$1", "type": "Object", "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n metricsAtAllLevels,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n}", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.RequestHandlerParams", - "text": "RequestHandlerParams" - } + "isRequired": true, + "signature": [ + "RequestHandlerParams" ], "description": [], "source": { @@ -10419,6 +10589,7 @@ "description": [], "children": [ { + "id": "def-common.inferTimeZone.$1", "type": "Object", "label": "params", "isRequired": true, @@ -10438,6 +10609,7 @@ } }, { + "id": "def-common.inferTimeZone.$2", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -10457,6 +10629,7 @@ } }, { + "id": "def-common.inferTimeZone.$3", "type": "Function", "label": "isDefaultTimezone", "isRequired": true, @@ -10470,6 +10643,7 @@ } }, { + "id": "def-common.inferTimeZone.$4", "type": "Function", "label": "getConfig", "isRequired": true, @@ -10496,6 +10670,7 @@ "type": "Function", "children": [ { + "id": "def-common.injectReferences.$1", "type": "CompoundType", "label": "searchSourceFields", "isRequired": true, @@ -10516,17 +10691,12 @@ } }, { + "id": "def-common.injectReferences.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -10571,6 +10741,7 @@ "type": "Function", "children": [ { + "id": "def-common.isAutoInterval.$1", "type": "Unknown", "label": "value", "isRequired": true, @@ -10607,6 +10778,7 @@ "description": [], "children": [ { + "id": "def-common.isBucketAggType.$1", "type": "Any", "label": "aggConfig", "isRequired": true, @@ -10633,6 +10805,7 @@ "type": "Function", "children": [ { + "id": "def-common.isCompleteResponse.$1", "type": "Object", "label": "response", "isRequired": false, @@ -10686,6 +10859,7 @@ "description": [], "children": [ { + "id": "def-common.isDateHistogramBucketAggConfig.$1", "type": "Any", "label": "agg", "isRequired": true, @@ -10712,6 +10886,7 @@ "type": "Function", "children": [ { + "id": "def-common.isErrorResponse.$1", "type": "Object", "label": "response", "isRequired": false, @@ -10765,6 +10940,7 @@ "description": [], "children": [ { + "id": "def-common.isMetricAggType.$1", "type": "Any", "label": "aggConfig", "isRequired": true, @@ -10814,6 +10990,7 @@ "type": "Function", "children": [ { + "id": "def-common.isPartialResponse.$1", "type": "Object", "label": "response", "isRequired": false, @@ -10908,6 +11085,7 @@ "type": "Function", "children": [ { + "id": "def-common.isType.$1", "type": "Array", "label": "types", "isRequired": true, @@ -10954,6 +11132,7 @@ ], "children": [ { + "id": "def-common.isValidEsInterval.$1", "type": "string", "label": "interval", "isRequired": true, @@ -10989,6 +11168,7 @@ "description": [], "children": [ { + "id": "def-common.isValidInterval.$1", "type": "string", "label": "value", "isRequired": true, @@ -11002,6 +11182,7 @@ } }, { + "id": "def-common.isValidInterval.$2", "type": "string", "label": "baseInterval", "isRequired": false, @@ -11037,6 +11218,7 @@ ], "children": [ { + "id": "def-common.parseEsInterval.$1", "type": "string", "label": "interval", "isRequired": true, @@ -11068,6 +11250,7 @@ "description": [], "children": [ { + "id": "def-common.parseInterval.$1", "type": "string", "label": "interval", "isRequired": true, @@ -11094,6 +11277,7 @@ "type": "Function", "children": [ { + "id": "def-common.parseSearchSourceJSON.$1", "type": "string", "label": "searchSourceJSON", "isRequired": true, @@ -11139,6 +11323,7 @@ ], "children": [ { + "id": "def-common.propFilter.$1", "type": "Uncategorized", "label": "prop", "isRequired": true, @@ -11167,6 +11352,7 @@ "type": "Function", "children": [ { + "id": "def-common.queryToAst.$1", "type": "Object", "label": "query", "isRequired": true, @@ -11219,6 +11405,7 @@ "type": "Function", "children": [ { + "id": "def-common.splitStringInterval.$1", "type": "string", "label": "interval", "isRequired": true, @@ -11252,6 +11439,7 @@ "type": "Function", "children": [ { + "id": "def-common.tabify.$1", "type": "Object", "label": "searchSource", "isRequired": true, @@ -11271,6 +11459,7 @@ } }, { + "id": "def-common.tabify.$2", "type": "Object", "label": "esResponse", "isRequired": true, @@ -11285,26 +11474,15 @@ } }, { + "id": "def-common.tabify.$3", "type": "CompoundType", "label": "opts", "isRequired": true, "signature": [ "Partial<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TabbedResponseWriterOptions", - "text": "TabbedResponseWriterOptions" - }, + "TabbedResponseWriterOptions", "> | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TabifyDocsOptions", - "text": "TabifyDocsOptions" - } + "TabifyDocsOptions" ], "description": [], "source": { @@ -11376,6 +11554,7 @@ ], "children": [ { + "id": "def-common.tabifyAggResponse.$1", "type": "Object", "label": "aggConfigs", "isRequired": true, @@ -11395,6 +11574,7 @@ } }, { + "id": "def-common.tabifyAggResponse.$2", "type": "Object", "label": "esResponse", "isRequired": true, @@ -11408,18 +11588,13 @@ } }, { + "id": "def-common.tabifyAggResponse.$3", "type": "Object", "label": "respOpts", "isRequired": false, "signature": [ "Partial<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TabbedResponseWriterOptions", - "text": "TabbedResponseWriterOptions" - }, + "TabbedResponseWriterOptions", "> | undefined" ], "description": [], @@ -11442,6 +11617,7 @@ "type": "Function", "children": [ { + "id": "def-common.tabifyDocs.$1", "type": "Object", "label": "esResponse", "isRequired": true, @@ -11456,6 +11632,7 @@ } }, { + "id": "def-common.tabifyDocs.$2", "type": "Object", "label": "index", "isRequired": false, @@ -11476,17 +11653,12 @@ } }, { + "id": "def-common.tabifyDocs.$3", "type": "Object", "label": "params", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TabifyDocsOptions", - "text": "TabifyDocsOptions" - } + "TabifyDocsOptions" ], "description": [], "source": { @@ -11549,6 +11721,7 @@ ], "children": [ { + "id": "def-common.tabifyGetColumns.$1", "type": "Array", "label": "aggs", "isRequired": true, @@ -11571,6 +11744,7 @@ } }, { + "id": "def-common.tabifyGetColumns.$2", "type": "boolean", "label": "minimalColumns", "isRequired": true, @@ -11599,6 +11773,7 @@ "type": "Function", "children": [ { + "id": "def-common.timerangeToAst.$1", "type": "Object", "label": "timerange", "isRequired": true, @@ -11673,6 +11848,7 @@ "description": [], "children": [ { + "id": "def-common.toAbsoluteDates.$1", "type": "Object", "label": "range", "isRequired": true, @@ -11720,13 +11896,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggTypesRegistryStart", - "text": "AggTypesRegistryStart" - } + "AggTypesRegistryStart" ] } ], @@ -11753,7 +11923,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 207 + "lineNumber": 196 }, "signature": [ "FunctionDefinition" @@ -11767,7 +11937,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 208 + "lineNumber": 197 }, "signature": [ "FunctionDefinition" @@ -11781,7 +11951,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 209 + "lineNumber": 198 }, "signature": [ "FunctionDefinition" @@ -11795,7 +11965,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 210 + "lineNumber": 199 }, "signature": [ "FunctionDefinition" @@ -11809,7 +11979,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 211 + "lineNumber": 200 }, "signature": [ "FunctionDefinition" @@ -11823,7 +11993,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 212 + "lineNumber": 201 }, "signature": [ "FunctionDefinition" @@ -11837,7 +12007,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 + "lineNumber": 202 }, "signature": [ "FunctionDefinition" @@ -11851,7 +12021,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 214 + "lineNumber": 203 }, "signature": [ "FunctionDefinition" @@ -11865,7 +12035,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 215 + "lineNumber": 204 }, "signature": [ "FunctionDefinition" @@ -11879,7 +12049,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 216 + "lineNumber": 205 }, "signature": [ "FunctionDefinition" @@ -11893,7 +12063,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 217 + "lineNumber": 206 }, "signature": [ "FunctionDefinition" @@ -11907,7 +12077,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 218 + "lineNumber": 207 }, "signature": [ "FunctionDefinition" @@ -11921,7 +12091,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 219 + "lineNumber": 208 }, "signature": [ "FunctionDefinition" @@ -11935,7 +12105,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 220 + "lineNumber": 209 }, "signature": [ "FunctionDefinition" @@ -11949,7 +12119,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 221 + "lineNumber": 210 }, "signature": [ "FunctionDefinition" @@ -11963,7 +12133,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 222 + "lineNumber": 211 }, "signature": [ "FunctionDefinition" @@ -11977,7 +12147,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 223 + "lineNumber": 212 }, "signature": [ "FunctionDefinition" @@ -11991,7 +12161,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 224 + "lineNumber": 213 }, "signature": [ "FunctionDefinition" @@ -12005,7 +12175,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 225 + "lineNumber": 214 }, "signature": [ "FunctionDefinition" @@ -12019,7 +12189,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 226 + "lineNumber": 215 }, "signature": [ "FunctionDefinition" @@ -12033,7 +12203,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 227 + "lineNumber": 216 }, "signature": [ "FunctionDefinition" @@ -12047,7 +12217,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 228 + "lineNumber": 217 }, "signature": [ "FunctionDefinition" @@ -12061,7 +12231,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 229 + "lineNumber": 218 }, "signature": [ "FunctionDefinition" @@ -12075,7 +12245,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 230 + "lineNumber": 219 }, "signature": [ "FunctionDefinition" @@ -12089,7 +12259,21 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 231 + "lineNumber": 220 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggSinglePercentile", + "type": "Object", + "label": "aggSinglePercentile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221 }, "signature": [ "FunctionDefinition" @@ -12103,7 +12287,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 232 + "lineNumber": 222 }, "signature": [ "FunctionDefinition" @@ -12117,7 +12301,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 233 + "lineNumber": 223 }, "signature": [ "FunctionDefinition" @@ -12131,7 +12315,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 234 + "lineNumber": 224 }, "signature": [ "FunctionDefinition" @@ -12145,7 +12329,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 235 + "lineNumber": 225 }, "signature": [ "FunctionDefinition" @@ -12159,7 +12343,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 236 + "lineNumber": 226 }, "signature": [ "FunctionDefinition" @@ -12173,7 +12357,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 237 + "lineNumber": 227 }, "signature": [ "FunctionDefinition" @@ -12187,7 +12371,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 238 + "lineNumber": 228 }, "signature": [ "FunctionDefinition" @@ -12201,7 +12385,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 239 + "lineNumber": 229 }, "signature": [ "FunctionDefinition" @@ -12210,7 +12394,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 206 + "lineNumber": 195 }, "initialIsOpen": false }, @@ -12261,6 +12445,7 @@ "description": [], "children": [ { + "id": "def-common.AggParamOption.enabled.$1", "type": "Object", "label": "agg", "isRequired": true, @@ -12360,13 +12545,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -12382,13 +12561,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] } @@ -12429,13 +12602,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -12451,13 +12618,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] } @@ -12498,13 +12659,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -12520,13 +12675,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] } @@ -12567,13 +12716,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -12589,13 +12732,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] } @@ -12686,13 +12823,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -12820,6 +12951,20 @@ "string | undefined" ] }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.used_interval", + "type": "string", + "label": "used_interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 67 + }, + "signature": [ + "string | undefined" + ] + }, { "tags": [], "id": "def-common.AggParamsDateHistogram.time_zone", @@ -12828,7 +12973,21 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 67 + "lineNumber": 68 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.used_time_zone", + "type": "string", + "label": "used_time_zone", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 69 }, "signature": [ "string | undefined" @@ -12842,7 +13001,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 68 + "lineNumber": 70 }, "signature": [ "boolean | undefined" @@ -12856,7 +13015,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 69 + "lineNumber": 71 }, "signature": [ "string | undefined" @@ -12870,7 +13029,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 70 + "lineNumber": 72 }, "signature": [ "number | undefined" @@ -12884,16 +13043,10 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "lineNumber": 71 + "lineNumber": 73 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExtendedBounds", - "text": "ExtendedBounds" - }, + "ExtendedBounds", " | undefined" ] } @@ -13022,13 +13175,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -13122,13 +13269,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -13144,13 +13285,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] } @@ -13575,13 +13710,7 @@ "lineNumber": 48 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExtendedBounds", - "text": "ExtendedBounds" - }, + "ExtendedBounds", " | undefined" ] } @@ -13859,13 +13988,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -14084,13 +14207,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -14193,6 +14310,53 @@ }, "initialIsOpen": false }, + { + "id": "def-common.AggParamsSinglePercentile", + "type": "Interface", + "label": "AggParamsSinglePercentile", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsSinglePercentile", + "text": "AggParamsSinglePercentile" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsSinglePercentile.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", + "lineNumber": 21 + } + }, + { + "tags": [], + "id": "def-common.AggParamsSinglePercentile.percentile", + "type": "number", + "label": "percentile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", + "lineNumber": 22 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", + "lineNumber": 20 + }, + "initialIsOpen": false + }, { "id": "def-common.AggParamsStdDeviation", "type": "Interface", @@ -14317,13 +14481,7 @@ }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined; schema?: string | undefined; } | undefined" ] }, @@ -15060,14 +15218,8 @@ "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 48 }, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.CalculateBoundsFn", - "text": "CalculateBoundsFn" - } + "signature": [ + "CalculateBoundsFn" ] }, { @@ -15189,6 +15341,59 @@ }, "initialIsOpen": false }, + { + "id": "def-common.EsRawResponse", + "type": "Interface", + "label": "EsRawResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EsRawResponse.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 15 + }, + "signature": [ + "\"es_raw_response\"" + ] + }, + { + "tags": [], + "id": "def-common.EsRawResponse.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 16 + }, + "signature": [ + "SearchResponse", + "" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, { "id": "def-common.FetchHandlers", "type": "Interface", @@ -15438,13 +15643,7 @@ "lineNumber": 54 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TimeBuckets", - "text": "TimeBuckets" - } + "TimeBuckets" ] } ], @@ -16770,7 +16969,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 89 + "lineNumber": 96 }, "signature": [ "number | undefined" @@ -16784,7 +16983,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 90 + "lineNumber": 97 }, "signature": [ "number | undefined" @@ -16798,7 +16997,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 91 + "lineNumber": 98 }, "signature": [ "string | undefined" @@ -16812,7 +17011,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, "signature": [ "string | undefined" @@ -16826,7 +17025,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 93 + "lineNumber": 100 }, "signature": [ "string | undefined" @@ -16835,7 +17034,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 88 + "lineNumber": 95 }, "initialIsOpen": false }, @@ -16856,7 +17055,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 73 + "lineNumber": 80 } }, { @@ -16869,7 +17068,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 77 + "lineNumber": 84 } }, { @@ -16882,7 +17081,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 81 + "lineNumber": 88 } }, { @@ -16895,7 +17094,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 85 + "lineNumber": 92 }, "signature": [ "string | undefined" @@ -16904,7 +17103,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 69 + "lineNumber": 76 }, "initialIsOpen": false }, @@ -16997,6 +17196,22 @@ "lineNumber": 33 } }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.completed", + "type": "CompoundType", + "label": "completed", + "description": [ + "\nTime of transition into completed state,\n\nCan be \"null\" in case already completed session\ntransitioned into in-progress session" + ], + "source": { + "path": "src/plugins/data/common/search/session/types.ts", + "lineNumber": 40 + }, + "signature": [ + "string | null | undefined" + ] + }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.status", @@ -17007,7 +17222,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 37 + "lineNumber": 44 }, "signature": [ { @@ -17029,7 +17244,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 41 + "lineNumber": 48 }, "signature": [ "string | undefined" @@ -17045,7 +17260,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 46 + "lineNumber": 53 }, "signature": [ "Record | undefined" @@ -17061,7 +17276,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 51 + "lineNumber": 58 }, "signature": [ "Record | undefined" @@ -17077,7 +17292,7 @@ ], "source": { "path": "src/plugins/data/common/search/session/types.ts", - "lineNumber": 55 + "lineNumber": 62 }, "signature": [ "Record string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick string | undefined; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", { @@ -18770,6 +19008,54 @@ ], "initialIsOpen": false }, + { + "id": "def-common.EsdslExpressionFunctionDefinition", + "type": "Type", + "label": "EsdslExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 29 + }, + "signature": [ + "ExpressionFunctionDefinition<\"esdsl\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + "> | null, Arguments, Output, ", + { + "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" + ], + "initialIsOpen": false + }, { "id": "def-common.EsQuerySearchAfter", "type": "Type", @@ -18804,6 +19090,21 @@ ], "initialIsOpen": false }, + { + "id": "def-common.EsRawResponseExpressionTypeDefinition", + "type": "Type", + "label": "EsRawResponseExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 57 + }, + "signature": [ + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + ], + "initialIsOpen": false + }, { "id": "def-common.ExecutionContextSearch", "type": "Type", @@ -19306,7 +19607,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 19 + "lineNumber": 22 }, "signature": [ { @@ -19407,7 +19708,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 21 + "lineNumber": 24 }, "signature": [ "FieldParamType" @@ -19448,7 +19749,7 @@ "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, - "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" + "): boolean; } | { display: string; val: string; })[]" ], "initialIsOpen": false }, @@ -19767,7 +20068,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 27 + "lineNumber": 28 }, "initialIsOpen": false }, @@ -19839,7 +20140,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 34 + "lineNumber": 35 }, "initialIsOpen": false }, @@ -19867,7 +20168,7 @@ "children": [ { "tags": [], - "id": "def-common.AggGroupLabels.[AggGroupNames.Buckets]", + "id": "def-common.AggGroupLabels.AggGroupNames.Buckets", "type": "string", "label": "[AggGroupNames.Buckets]", "description": [], @@ -19878,7 +20179,7 @@ }, { "tags": [], - "id": "def-common.AggGroupLabels.[AggGroupNames.Metrics]", + "id": "def-common.AggGroupLabels.AggGroupNames.Metrics", "type": "string", "label": "[AggGroupNames.Metrics]", "description": [], @@ -19889,7 +20190,7 @@ }, { "tags": [], - "id": "def-common.AggGroupLabels.[AggGroupNames.None]", + "id": "def-common.AggGroupLabels.AggGroupNames.None", "type": "string", "label": "[AggGroupNames.None]", "description": [], @@ -19922,6 +20223,93 @@ ], "initialIsOpen": false }, + { + "id": "def-common.esRawResponse", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.esRawResponse.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 64 + }, + "signature": [ + "\"es_raw_response\"" + ] + }, + { + "id": "def-common.esRawResponse.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.esRawResponse.to.datatable", + "type": "Function", + "children": [ + { + "id": "def-common.esRawResponse.to.datatable.$1", + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 66 + } + } + ], + "signature": [ + "(context: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsRawResponse", + "text": "EsRawResponse" + }, + ") => { type: string; meta: { type: string; source: string; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 66 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 65 + } + } + ], + "description": [], + "label": "esRawResponse", + "source": { + "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", + "lineNumber": 63 + }, + "initialIsOpen": false + }, { "id": "def-common.existsFilterFunction", "type": "Object", @@ -20123,6 +20511,7 @@ "description": [], "children": [ { + "id": "def-common.existsFilterFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -20136,6 +20525,7 @@ } }, { + "id": "def-common.existsFilterFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -20404,6 +20794,7 @@ "description": [], "children": [ { + "id": "def-common.fieldFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -20417,6 +20808,7 @@ } }, { + "id": "def-common.fieldFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -20565,6 +20957,7 @@ "description": [], "children": [ { + "id": "def-common.kibana.fn.$1", "type": "CompoundType", "label": "input", "isRequired": false, @@ -20578,6 +20971,7 @@ } }, { + "id": "def-common.kibana.fn.$2", "type": "Uncategorized", "label": "_", "isRequired": true, @@ -20591,6 +20985,7 @@ } }, { + "id": "def-common.kibana.fn.$3", "type": "Object", "label": "{ getSearchContext }", "isRequired": true, @@ -20925,6 +21320,7 @@ "description": [], "children": [ { + "id": "def-common.kibanaFilterFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -20938,6 +21334,7 @@ } }, { + "id": "def-common.kibanaFilterFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -21212,6 +21609,7 @@ "description": [], "children": [ { + "id": "def-common.kibanaTimerangeFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -21225,6 +21623,7 @@ } }, { + "id": "def-common.kibanaTimerangeFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -21407,6 +21806,7 @@ "description": [], "children": [ { + "id": "def-common.kqlFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -21420,6 +21820,7 @@ } }, { + "id": "def-common.kqlFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -21596,6 +21997,7 @@ "description": [], "children": [ { + "id": "def-common.luceneFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -21609,6 +22011,7 @@ } }, { + "id": "def-common.luceneFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -21682,7 +22085,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 35 + "lineNumber": 36 } }, { @@ -21714,7 +22117,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 36 + "lineNumber": 37 } }, { @@ -21735,6 +22138,7 @@ "description": [], "children": [ { + "id": "def-common.parentPipelineAggHelper.getSerializedFormat.$1", "type": "Object", "label": "agg", "isRequired": true, @@ -21750,7 +22154,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 64 + "lineNumber": 65 } } ], @@ -21758,7 +22162,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 64 + "lineNumber": 65 } } ], @@ -21766,7 +22170,7 @@ "label": "parentPipelineAggHelper", "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", - "lineNumber": 34 + "lineNumber": 35 }, "initialIsOpen": false }, @@ -22037,6 +22441,7 @@ "description": [], "children": [ { + "id": "def-common.phraseFilterFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -22050,6 +22455,7 @@ } }, { + "id": "def-common.phraseFilterFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -22332,6 +22738,7 @@ "description": [], "children": [ { + "id": "def-common.rangeFilterFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -22345,6 +22752,7 @@ } }, { + "id": "def-common.rangeFilterFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -22607,6 +23015,7 @@ "description": [], "children": [ { + "id": "def-common.rangeFunction.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -22620,6 +23029,7 @@ } }, { + "id": "def-common.rangeFunction.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -22662,7 +23072,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 42 + "lineNumber": 43 } }, { @@ -22691,6 +23101,7 @@ "description": [], "children": [ { + "id": "def-common.siblingPipelineAggHelper.params.$1", "type": "Array", "label": "bucketFilter", "isRequired": true, @@ -22700,7 +23111,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 43 + "lineNumber": 44 } } ], @@ -22708,7 +23119,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 43 + "lineNumber": 44 } }, { @@ -22729,6 +23140,7 @@ "description": [], "children": [ { + "id": "def-common.siblingPipelineAggHelper.getSerializedFormat.$1", "type": "Object", "label": "agg", "isRequired": true, @@ -22744,7 +23156,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 79 + "lineNumber": 80 } } ], @@ -22752,7 +23164,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 79 + "lineNumber": 80 } } ], @@ -22760,7 +23172,7 @@ "label": "siblingPipelineAggHelper", "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", - "lineNumber": 41 + "lineNumber": 42 }, "initialIsOpen": false } diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json index 63956cdcb379..e121f55bd6bb 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.QueryStringInput.$1", "type": "Object", "label": "props", "isRequired": true, @@ -65,7 +66,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 42 + "lineNumber": 43 }, "signature": [ "(string | ", @@ -87,7 +88,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 43 + "lineNumber": 44 }, "signature": [ { @@ -107,7 +108,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 44 + "lineNumber": 45 }, "signature": [ "boolean | undefined" @@ -121,7 +122,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 45 + "lineNumber": 46 }, "signature": [ "string | undefined" @@ -135,7 +136,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 46 + "lineNumber": 47 }, "signature": [ "any" @@ -149,16 +150,10 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 47 + "lineNumber": 48 }, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.PersistedLog", - "text": "PersistedLog" - }, + "PersistedLog", " | undefined" ] }, @@ -170,7 +165,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 48 + "lineNumber": 49 }, "signature": [ "boolean | undefined" @@ -184,7 +179,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 49 + "lineNumber": 50 }, "signature": [ "string | undefined" @@ -198,7 +193,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 50 + "lineNumber": 51 }, "signature": [ "boolean | undefined" @@ -212,7 +207,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 51 + "lineNumber": 52 }, "signature": [ "\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined" @@ -226,7 +221,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 52 + "lineNumber": 53 }, "signature": [ "(() => void) | undefined" @@ -240,7 +235,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 53 + "lineNumber": 54 }, "signature": [ "((query: ", @@ -262,7 +257,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 54 + "lineNumber": 55 }, "signature": [ "((isFocused: boolean) => void) | undefined" @@ -276,7 +271,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 55 + "lineNumber": 56 }, "signature": [ "((query: ", @@ -298,7 +293,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 56 + "lineNumber": 57 }, "signature": [ "boolean | undefined" @@ -312,7 +307,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 57 + "lineNumber": 58 }, "signature": [ "string | undefined" @@ -326,7 +321,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 58 + "lineNumber": 59 }, "signature": [ "\"s\" | \"l\" | undefined" @@ -340,7 +335,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 59 + "lineNumber": 60 }, "signature": [ "string | undefined" @@ -354,7 +349,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 60 + "lineNumber": 61 }, "signature": [ "boolean | undefined" @@ -368,7 +363,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 61 + "lineNumber": 62 }, "signature": [ "boolean | undefined" @@ -382,7 +377,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 62 + "lineNumber": 63 }, "signature": [ "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" @@ -396,7 +391,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 68 + "lineNumber": 69 }, "signature": [ "\"text\" | \"lucene\" | undefined" @@ -410,7 +405,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 69 + "lineNumber": 70 }, "signature": [ "string | undefined" @@ -424,7 +419,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 72 + "lineNumber": 74 }, "signature": [ "boolean | undefined" @@ -438,7 +433,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 76 + "lineNumber": 78 }, "signature": [ "string | undefined" @@ -447,7 +442,7 @@ ], "source": { "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "lineNumber": 41 + "lineNumber": 42 }, "initialIsOpen": false } @@ -465,7 +460,7 @@ "lineNumber": 17 }, "signature": [ - "Pick, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\"> & globalThis.Required, \"children\" | \"onClick\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; fieldTypes?: string[] | undefined; onNoIndexPatterns?: (() => void) | undefined; maxIndexPatterns?: number | 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; fieldTypes?: string[] | undefined; onNoIndexPatterns?: (() => void) | undefined; }" ], "initialIsOpen": false }, @@ -488,7 +483,7 @@ "section": "def-public.SearchBarProps", "text": "SearchBarProps" }, - ", \"filters\" | \"query\" | \"intl\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"storageKey\" | \"disableLanguageSwitcher\" | \"isInvalid\" | \"autoSubmit\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"storageKey\" | \"disableLanguageSwitcher\" | \"isInvalid\" | \"autoSubmit\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>; }" + ", \"filters\" | \"query\" | \"intl\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\"> & ReactIntl.InjectedIntlProps>; }" ], "initialIsOpen": false }, @@ -508,7 +503,7 @@ "description": [], "source": { "path": "src/plugins/data/public/ui/search_bar/search_bar.tsx", - "lineNumber": 84 + "lineNumber": 80 }, "signature": [ "SearchBarOwnProps & SearchBarInjectedDeps" @@ -549,4 +544,4 @@ "misc": [], "objects": [] } -} +} \ No newline at end of file diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json index 39ddaf5d93b8..a2215041f27c 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -49,26 +49,15 @@ "text": "CoreSetup" }, ", { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ", - { - "pluginId": "devTools", - "scope": "public", - "docId": "kibDevToolsPluginApi", - "section": "def-public.CreateDevToolArgs", - "text": "CreateDevToolArgs" - }, + "CreateDevToolArgs", ") => ", - { - "pluginId": "devTools", - "scope": "public", - "docId": "kibDevToolsPluginApi", - "section": "def-public.DevToolApp", - "text": "DevToolApp" - }, + "DevToolApp", "; }" ], "description": [], "children": [ { + "id": "def-public.DevToolsPlugin.setup.$1", "type": "Object", "label": "coreSetup", "isRequired": true, @@ -89,7 +78,7 @@ } }, { - "id": "def-public.DevToolsPlugin.setup.{-urlForwarding }", + "id": "def-public.DevToolsPlugin.setup.$2.urlForwarding", "type": "Object", "label": "{ urlForwarding }", "tags": [], @@ -97,7 +86,7 @@ "children": [ { "tags": [], - "id": "def-public.DevToolsPlugin.setup.{-urlForwarding }.urlForwarding", + "id": "def-public.DevToolsPlugin.setup.$2.urlForwarding.urlForwarding", "type": "Object", "label": "urlForwarding", "description": [], @@ -189,21 +178,9 @@ }, "signature": [ "(devTool: ", - { - "pluginId": "devTools", - "scope": "public", - "docId": "kibDevToolsPluginApi", - "section": "def-public.CreateDevToolArgs", - "text": "CreateDevToolArgs" - }, + "CreateDevToolArgs", ") => ", - { - "pluginId": "devTools", - "scope": "public", - "docId": "kibDevToolsPluginApi", - "section": "def-public.DevToolApp", - "text": "DevToolApp" - } + "DevToolApp" ] } ], diff --git a/api_docs/discover.json b/api_docs/discover.json index a785c254efea..246382a449fc 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -20,6 +20,7 @@ "description": [], "children": [ { + "id": "def-public.createSavedSearchesLoader.$1", "type": "Object", "label": "{ savedObjectsClient, savedObjects }", "isRequired": true, @@ -449,13 +450,7 @@ "lineNumber": 20 }, "signature": [ - { - "pluginId": "discover", - "scope": "public", - "docId": "kibDiscoverPluginApi", - "section": "def-public.SortOrder", - "text": "SortOrder" - }, + "SortOrder", "[]" ] }, @@ -470,13 +465,7 @@ "lineNumber": 21 }, "signature": [ - { - "pluginId": "discover", - "scope": "public", - "docId": "kibDiscoverPluginApi", - "section": "def-public.DiscoverGridSettings", - "text": "DiscoverGridSettings" - } + "DiscoverGridSettings" ] }, { @@ -739,13 +728,7 @@ "lineNumber": 25 }, "signature": [ - { - "pluginId": "discover", - "scope": "public", - "docId": "kibDiscoverPluginApi", - "section": "def-public.SortOrder", - "text": "SortOrder" - }, + "SortOrder", "[] | undefined" ] } @@ -812,21 +795,9 @@ }, "signature": [ "{ addDocView(docViewRaw: ", - { - "pluginId": "discover", - "scope": "public", - "docId": "kibDiscoverPluginApi", - "section": "def-public.DocViewInput", - "text": "DocViewInput" - }, + "DocViewInput", " | ", - { - "pluginId": "discover", - "scope": "public", - "docId": "kibDiscoverPluginApi", - "section": "def-public.DocViewInputFn", - "text": "DocViewInputFn" - }, + "DocViewInputFn", "): void; }" ] } diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json index ffb733e0c656..6ff98fb2b2ef 100644 --- a/api_docs/discover_enhanced.json +++ b/api_docs/discover_enhanced.json @@ -73,6 +73,7 @@ "description": [], "children": [ { + "id": "def-public.DiscoverEnhancedPlugin.Unnamed.$1", "type": "Object", "label": "context", "isRequired": true, @@ -134,6 +135,7 @@ "description": [], "children": [ { + "id": "def-public.DiscoverEnhancedPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -162,6 +164,7 @@ } }, { + "id": "def-public.DiscoverEnhancedPlugin.setup.$2", "type": "Object", "label": "{ uiActions, share }", "isRequired": true, @@ -214,6 +217,7 @@ "description": [], "children": [ { + "id": "def-public.DiscoverEnhancedPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -233,6 +237,7 @@ } }, { + "id": "def-public.DiscoverEnhancedPlugin.start.$2", "type": "Object", "label": "plugins", "isRequired": true, @@ -362,29 +367,18 @@ "label": "isCompatible", "signature": [ "(context: ", - { - "pluginId": "discoverEnhanced", - "scope": "public", - "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" - }, + "ExploreDataChartActionContext", ") => Promise" ], "description": [], "children": [ { + "id": "def-public.ExploreDataChartAction.isCompatible.$1", "type": "Object", "label": "context", "isRequired": true, "signature": [ - { - "pluginId": "discoverEnhanced", - "scope": "public", - "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" - } + "ExploreDataChartActionContext" ], "description": [], "source": { @@ -405,17 +399,12 @@ "type": "Function", "children": [ { + "id": "def-public.ExploreDataChartAction.getUrl.$1", "type": "Object", "label": "context", "isRequired": true, "signature": [ - { - "pluginId": "discoverEnhanced", - "scope": "public", - "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" - } + "ExploreDataChartActionContext" ], "description": [], "source": { @@ -426,13 +415,7 @@ ], "signature": [ "(context: ", - { - "pluginId": "discoverEnhanced", - "scope": "public", - "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" - }, + "ExploreDataChartActionContext", ") => Promise<", { "pluginId": "share", @@ -535,6 +518,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExploreDataContextMenuAction.getUrl.$1", "type": "Object", "label": "context", "isRequired": true, @@ -748,13 +732,7 @@ }, "signature": [ "{ dashboardConfig: ", - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.DashboardConfig", - "text": "DashboardConfig" - }, + "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; } | undefined" ] }, diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json index 5b02c5e0c9cb..c1b8313259ae 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -65,6 +65,7 @@ "description": [], "children": [ { + "id": "def-public.AddPanelAction.Unnamed.$1", "type": "Function", "label": "getFactory", "isRequired": true, @@ -117,6 +118,7 @@ } }, { + "id": "def-public.AddPanelAction.Unnamed.$2", "type": "Function", "label": "getAllFactories", "isRequired": true, @@ -169,6 +171,7 @@ } }, { + "id": "def-public.AddPanelAction.Unnamed.$3", "type": "Object", "label": "overlays", "isRequired": true, @@ -188,6 +191,7 @@ } }, { + "id": "def-public.AddPanelAction.Unnamed.$4", "type": "Object", "label": "notifications", "isRequired": true, @@ -207,6 +211,7 @@ } }, { + "id": "def-public.AddPanelAction.Unnamed.$5", "type": "CompoundType", "label": "SavedObjectFinder", "isRequired": true, @@ -277,6 +282,7 @@ "description": [], "children": [ { + "id": "def-public.AddPanelAction.isCompatible.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -322,6 +328,7 @@ "description": [], "children": [ { + "id": "def-public.AddPanelAction.execute.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -383,6 +390,7 @@ "description": [], "children": [ { + "id": "def-public.AttributeService.Unnamed.$1", "type": "string", "label": "type", "isRequired": true, @@ -396,6 +404,7 @@ } }, { + "id": "def-public.AttributeService.Unnamed.$2", "type": "Function", "label": "showSaveModal", "isRequired": true, @@ -409,6 +418,7 @@ } }, { + "id": "def-public.AttributeService.Unnamed.$3", "type": "Function", "label": "i18nContext", "isRequired": true, @@ -422,6 +432,7 @@ } }, { + "id": "def-public.AttributeService.Unnamed.$4", "type": "Object", "label": "toasts", "isRequired": true, @@ -443,17 +454,12 @@ } }, { + "id": "def-public.AttributeService.Unnamed.$5", "type": "Object", "label": "options", "isRequired": true, "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeServiceOptions", - "text": "AttributeServiceOptions" - }, + "AttributeServiceOptions", "" ], "description": [], @@ -463,6 +469,7 @@ } }, { + "id": "def-public.AttributeService.Unnamed.$6", "type": "Function", "label": "getEmbeddableFactory", "isRequired": false, @@ -532,6 +539,7 @@ "description": [], "children": [ { + "id": "def-public.AttributeService.unwrapAttributes.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -562,6 +570,7 @@ "description": [], "children": [ { + "id": "def-public.AttributeService.wrapAttributes.$1", "type": "Uncategorized", "label": "newAttributes", "isRequired": true, @@ -575,6 +584,7 @@ } }, { + "id": "def-public.AttributeService.wrapAttributes.$2", "type": "boolean", "label": "useRefType", "isRequired": true, @@ -588,6 +598,7 @@ } }, { + "id": "def-public.AttributeService.wrapAttributes.$3", "type": "CompoundType", "label": "input", "isRequired": false, @@ -613,6 +624,7 @@ "type": "Function", "children": [ { + "id": "def-public.AttributeService.inputIsRefType.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -672,6 +684,7 @@ "description": [], "children": [ { + "id": "def-public.AttributeService.getExplicitInputFromEmbeddable.$1", "type": "Object", "label": "embeddable", "isRequired": true, @@ -720,6 +733,7 @@ "type": "Function", "children": [ { + "id": "def-public.AttributeService.getInputAsValueType.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -750,6 +764,7 @@ "type": "Function", "children": [ { + "id": "def-public.AttributeService.getInputAsRefType.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -763,6 +778,7 @@ } }, { + "id": "def-public.AttributeService.getInputAsRefType.$2", "type": "CompoundType", "label": "saveOptions", "isRequired": false, @@ -861,6 +877,7 @@ "description": [], "children": [ { + "id": "def-public.Container.Unnamed.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -874,6 +891,7 @@ } }, { + "id": "def-public.Container.Unnamed.$2", "type": "Uncategorized", "label": "output", "isRequired": true, @@ -887,6 +905,7 @@ } }, { + "id": "def-public.Container.Unnamed.$3", "type": "Function", "label": "getFactory", "isRequired": true, @@ -939,6 +958,7 @@ } }, { + "id": "def-public.Container.Unnamed.$4", "type": "Object", "label": "parent", "isRequired": false, @@ -1008,6 +1028,7 @@ "description": [], "children": [ { + "id": "def-public.Container.updateInputForChild.$1", "type": "string", "label": "id", "isRequired": true, @@ -1021,6 +1042,7 @@ } }, { + "id": "def-public.Container.updateInputForChild.$2", "type": "Object", "label": "changes", "isRequired": true, @@ -1106,6 +1128,7 @@ "description": [], "children": [ { + "id": "def-public.Container.addNewEmbeddable.$1", "type": "string", "label": "type", "isRequired": true, @@ -1119,6 +1142,7 @@ } }, { + "id": "def-public.Container.addNewEmbeddable.$2", "type": "Object", "label": "explicitInput", "isRequired": true, @@ -1149,6 +1173,7 @@ "description": [], "children": [ { + "id": "def-public.Container.removeEmbeddable.$1", "type": "string", "label": "embeddableId", "isRequired": true, @@ -1219,6 +1244,7 @@ "description": [], "children": [ { + "id": "def-public.Container.getChild.$1", "type": "string", "label": "id", "isRequired": true, @@ -1265,6 +1291,7 @@ "description": [], "children": [ { + "id": "def-public.Container.getInputForChild.$1", "type": "string", "label": "embeddableId", "isRequired": true, @@ -1343,6 +1370,7 @@ "description": [], "children": [ { + "id": "def-public.Container.untilEmbeddableLoaded.$1", "type": "string", "label": "id", "isRequired": true, @@ -1393,13 +1421,7 @@ "text": "EmbeddableFactory" }, ", partial?: Partial) => ", { "pluginId": "embeddable", @@ -1412,6 +1434,7 @@ "description": [], "children": [ { + "id": "def-public.Container.createNewPanelState.$1", "type": "Object", "label": "factory", "isRequired": true, @@ -1424,13 +1447,7 @@ "text": "EmbeddableFactory" }, "" ], "description": [], @@ -1440,6 +1457,7 @@ } }, { + "id": "def-public.Container.createNewPanelState.$2", "type": "Object", "label": "partial", "isRequired": true, @@ -1494,6 +1512,7 @@ "description": [], "children": [ { + "id": "def-public.Container.getPanelState.$1", "type": "string", "label": "embeddableId", "isRequired": true, @@ -1526,6 +1545,7 @@ ], "children": [ { + "id": "def-public.Container.getInheritedInput.$1", "type": "string", "label": "id", "isRequired": true, @@ -1641,6 +1661,7 @@ "description": [], "children": [ { + "id": "def-public.EditPanelAction.Unnamed.$1", "type": "Function", "label": "getEmbeddableFactory", "isRequired": true, @@ -1693,6 +1714,7 @@ } }, { + "id": "def-public.EditPanelAction.Unnamed.$2", "type": "Object", "label": "application", "isRequired": true, @@ -1712,6 +1734,7 @@ } }, { + "id": "def-public.EditPanelAction.Unnamed.$3", "type": "Object", "label": "stateTransfer", "isRequired": false, @@ -1749,6 +1772,7 @@ "description": [], "children": [ { + "id": "def-public.EditPanelAction.getDisplayName.$1", "type": "Object", "label": "{ embeddable }", "isRequired": true, @@ -1795,6 +1819,7 @@ "description": [], "children": [ { + "id": "def-public.EditPanelAction.isCompatible.$1", "type": "Object", "label": "{ embeddable }", "isRequired": true, @@ -1825,6 +1850,7 @@ "description": [], "children": [ { + "id": "def-public.EditPanelAction.execute.$1", "type": "Object", "label": "context", "isRequired": true, @@ -1855,6 +1881,7 @@ "description": [], "children": [ { + "id": "def-public.EditPanelAction.getAppTarget.$1", "type": "Object", "label": "{ embeddable }", "isRequired": true, @@ -1885,6 +1912,7 @@ "description": [], "children": [ { + "id": "def-public.EditPanelAction.getHref.$1", "type": "Object", "label": "{ embeddable }", "isRequired": true, @@ -2101,6 +2129,7 @@ "description": [], "children": [ { + "id": "def-public.Embeddable.Unnamed.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -2114,6 +2143,7 @@ } }, { + "id": "def-public.Embeddable.Unnamed.$2", "type": "Uncategorized", "label": "output", "isRequired": true, @@ -2127,6 +2157,7 @@ } }, { + "id": "def-public.Embeddable.Unnamed.$3", "type": "Object", "label": "parent", "isRequired": false, @@ -2235,7 +2266,7 @@ "signature": [ "() => Readonly<", "Observable", - ">" + ">" ], "description": [ "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip any state handling in case `reload` already handled it." @@ -2263,7 +2294,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 121 + "lineNumber": 120 } }, { @@ -2281,7 +2312,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 125 + "lineNumber": 124 } }, { @@ -2297,7 +2328,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 129 + "lineNumber": 128 } }, { @@ -2313,7 +2344,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 133 + "lineNumber": 132 } }, { @@ -2329,7 +2360,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 137 + "lineNumber": 136 } }, { @@ -2386,7 +2417,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 145 + "lineNumber": 144 } }, { @@ -2399,6 +2430,7 @@ "description": [], "children": [ { + "id": "def-public.Embeddable.updateInput.$1", "type": "Object", "label": "changes", "isRequired": true, @@ -2408,7 +2440,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 153 + "lineNumber": 152 } } ], @@ -2416,7 +2448,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 153 + "lineNumber": 152 } }, { @@ -2429,6 +2461,7 @@ "description": [], "children": [ { + "id": "def-public.Embeddable.render.$1", "type": "Object", "label": "el", "isRequired": true, @@ -2438,7 +2471,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 165 + "lineNumber": 164 } } ], @@ -2446,7 +2479,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 165 + "lineNumber": 164 } }, { @@ -2476,7 +2509,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 180 + "lineNumber": 179 } }, { @@ -2494,7 +2527,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 188 + "lineNumber": 187 } }, { @@ -2507,6 +2540,7 @@ "description": [], "children": [ { + "id": "def-public.Embeddable.updateOutput.$1", "type": "Object", "label": "outputChanges", "isRequired": true, @@ -2516,7 +2550,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 200 + "lineNumber": 199 } } ], @@ -2524,7 +2558,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 200 + "lineNumber": 199 } }, { @@ -2537,6 +2571,7 @@ "description": [], "children": [ { + "id": "def-public.Embeddable.onFatalError.$1", "type": "Object", "label": "e", "isRequired": true, @@ -2546,7 +2581,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 211 + "lineNumber": 210 } } ], @@ -2554,7 +2589,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 211 + "lineNumber": 210 } }, { @@ -2570,7 +2605,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "lineNumber": 239 + "lineNumber": 238 } } ], @@ -2672,6 +2707,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddableChildPanel.Unnamed.$1", "type": "Object", "label": "props", "isRequired": true, @@ -2791,6 +2827,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1", "type": "string", "label": "type", "isRequired": true, @@ -2845,6 +2882,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddablePanel.Unnamed.$1", "type": "Object", "label": "props", "isRequired": true, @@ -2902,6 +2940,7 @@ "type": "Function", "children": [ { + "id": "def-public.EmbeddablePanel.onFocus.$1", "type": "string", "label": "focusedPanelIndex", "isRequired": true, @@ -2932,6 +2971,7 @@ "type": "Function", "children": [ { + "id": "def-public.EmbeddablePanel.onBlur.$1", "type": "string", "label": "blurredPanelIndex", "isRequired": true, @@ -3039,6 +3079,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddableRoot.Unnamed.$1", "type": "Object", "label": "props", "isRequired": true, @@ -3085,6 +3126,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddableRoot.componentDidUpdate.$1", "type": "Object", "label": "prevProps", "isRequired": false, @@ -3115,6 +3157,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddableRoot.shouldComponentUpdate.$1", "type": "Object", "label": "newProps", "isRequired": true, @@ -3190,6 +3233,7 @@ "description": [], "children": [ { + "id": "def-public.EmbeddableStateTransfer.Unnamed.$1", "type": "Function", "label": "navigateToApp", "isRequired": true, @@ -3211,6 +3255,7 @@ } }, { + "id": "def-public.EmbeddableStateTransfer.Unnamed.$2", "type": "Object", "label": "currentAppId$", "isRequired": true, @@ -3225,6 +3270,7 @@ } }, { + "id": "def-public.EmbeddableStateTransfer.Unnamed.$3", "type": "Object", "label": "appList", "isRequired": false, @@ -3246,6 +3292,7 @@ } }, { + "id": "def-public.EmbeddableStateTransfer.Unnamed.$4", "type": "Object", "label": "customStorage", "isRequired": false, @@ -3278,6 +3325,7 @@ "type": "Function", "children": [ { + "id": "def-public.EmbeddableStateTransfer.getAppNameFromId.$1", "type": "string", "label": "appId", "isRequired": true, @@ -3325,6 +3373,7 @@ ], "children": [ { + "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$1", "type": "string", "label": "appId", "isRequired": true, @@ -3340,6 +3389,7 @@ } }, { + "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$2", "type": "CompoundType", "label": "removeAfterFetch", "isRequired": false, @@ -3374,6 +3424,7 @@ ], "children": [ { + "id": "def-public.EmbeddableStateTransfer.clearEditorState.$1", "type": "string", "label": "appId", "isRequired": false, @@ -3416,6 +3467,7 @@ ], "children": [ { + "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$1", "type": "string", "label": "appId", "isRequired": true, @@ -3431,6 +3483,7 @@ } }, { + "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$2", "type": "CompoundType", "label": "removeAfterFetch", "isRequired": false, @@ -3473,6 +3526,7 @@ ], "children": [ { + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$1", "type": "string", "label": "appId", "isRequired": true, @@ -3486,7 +3540,7 @@ } }, { - "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options", + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options", "type": "Object", "label": "options", "tags": [], @@ -3494,7 +3548,7 @@ "children": [ { "tags": [], - "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options.path", + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.path", "type": "string", "label": "path", "description": [], @@ -3508,7 +3562,7 @@ }, { "tags": [], - "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options.state", + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.state", "type": "Object", "label": "state", "description": [], @@ -3560,6 +3614,7 @@ ], "children": [ { + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$1", "type": "string", "label": "appId", "isRequired": true, @@ -3573,7 +3628,7 @@ } }, { - "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options", + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.options", "type": "Object", "label": "options", "tags": [], @@ -3581,7 +3636,7 @@ "children": [ { "tags": [], - "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.path", + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.options.path", "type": "string", "label": "path", "description": [], @@ -3595,7 +3650,7 @@ }, { "tags": [], - "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.state", + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.options.state", "type": "Object", "label": "state", "description": [], @@ -3713,6 +3768,7 @@ "description": [], "children": [ { + "id": "def-public.ErrorEmbeddable.Unnamed.$1", "type": "CompoundType", "label": "error", "isRequired": true, @@ -3726,6 +3782,7 @@ } }, { + "id": "def-public.ErrorEmbeddable.Unnamed.$2", "type": "Object", "label": "input", "isRequired": true, @@ -3745,6 +3802,7 @@ } }, { + "id": "def-public.ErrorEmbeddable.Unnamed.$3", "type": "Object", "label": "parent", "isRequired": false, @@ -3814,6 +3872,7 @@ "description": [], "children": [ { + "id": "def-public.ErrorEmbeddable.render.$1", "type": "Object", "label": "dom", "isRequired": true, @@ -3915,6 +3974,7 @@ "type": "Function", "children": [ { + "id": "def-public.defaultEmbeddableFactoryProvider.$1", "type": "CompoundType", "label": "def", "isRequired": true, @@ -3992,6 +4052,7 @@ "type": "Function", "children": [ { + "id": "def-public.EmbeddableRenderer.$1", "type": "CompoundType", "label": "props", "isRequired": true, @@ -4050,6 +4111,7 @@ "type": "Function", "children": [ { + "id": "def-public.isContextMenuTriggerContext.$1", "type": "Unknown", "label": "context", "isRequired": true, @@ -4113,6 +4175,7 @@ "type": "Function", "children": [ { + "id": "def-public.isEmbeddable.$1", "type": "Unknown", "label": "x", "isRequired": true, @@ -4181,6 +4244,7 @@ "description": [], "children": [ { + "id": "def-public.isErrorEmbeddable.$1", "type": "CompoundType", "label": "embeddable", "isRequired": true, @@ -4214,6 +4278,7 @@ "type": "Function", "children": [ { + "id": "def-public.isRangeSelectTriggerContext.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -4320,6 +4385,7 @@ "description": [], "children": [ { + "id": "def-public.isReferenceOrValueEmbeddable.$1", "type": "Unknown", "label": "incoming", "isRequired": true, @@ -4346,6 +4412,7 @@ "type": "Function", "children": [ { + "id": "def-public.isRowClickTriggerContext.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -4468,6 +4535,7 @@ "description": [], "children": [ { + "id": "def-public.isSavedObjectEmbeddableInput.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -4508,6 +4576,7 @@ "type": "Function", "children": [ { + "id": "def-public.isValueClickTriggerContext.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -4653,7 +4722,7 @@ "description": [], "children": [ { - "id": "def-public.openAddPanelFlyout.options", + "id": "def-public.openAddPanelFlyout.$1.options", "type": "Object", "label": "options", "tags": [], @@ -4661,7 +4730,7 @@ "children": [ { "tags": [], - "id": "def-public.openAddPanelFlyout.options.embeddable", + "id": "def-public.openAddPanelFlyout.$1.options.embeddable", "type": "Object", "label": "embeddable", "description": [], @@ -4698,7 +4767,7 @@ }, { "tags": [], - "id": "def-public.openAddPanelFlyout.options.getFactory", + "id": "def-public.openAddPanelFlyout.$1.options.getFactory", "type": "Function", "label": "getFactory", "description": [], @@ -4751,7 +4820,7 @@ }, { "tags": [], - "id": "def-public.openAddPanelFlyout.options.getAllFactories", + "id": "def-public.openAddPanelFlyout.$1.options.getAllFactories", "type": "Function", "label": "getAllFactories", "description": [], @@ -4804,7 +4873,7 @@ }, { "tags": [], - "id": "def-public.openAddPanelFlyout.options.overlays", + "id": "def-public.openAddPanelFlyout.$1.options.overlays", "type": "Object", "label": "overlays", "description": [], @@ -4824,7 +4893,7 @@ }, { "tags": [], - "id": "def-public.openAddPanelFlyout.options.notifications", + "id": "def-public.openAddPanelFlyout.$1.options.notifications", "type": "Object", "label": "notifications", "description": [], @@ -4844,7 +4913,7 @@ }, { "tags": [], - "id": "def-public.openAddPanelFlyout.options.SavedObjectFinder", + "id": "def-public.openAddPanelFlyout.$1.options.SavedObjectFinder", "type": "CompoundType", "label": "SavedObjectFinder", "description": [], @@ -4876,6 +4945,7 @@ "type": "Function", "children": [ { + "id": "def-public.withEmbeddableSubscription.$1", "type": "CompoundType", "label": "WrappedComponent", "isRequired": true, @@ -5467,6 +5537,7 @@ ], "children": [ { + "id": "def-public.EmbeddableFactory.getDefaultInput.$1", "type": "Object", "label": "partial", "isRequired": true, @@ -5549,6 +5620,7 @@ ], "children": [ { + "id": "def-public.EmbeddableFactory.createFromSavedObject.$1", "type": "string", "label": "savedObjectId", "isRequired": true, @@ -5562,6 +5634,7 @@ } }, { + "id": "def-public.EmbeddableFactory.createFromSavedObject.$2", "type": "Object", "label": "input", "isRequired": true, @@ -5577,6 +5650,7 @@ } }, { + "id": "def-public.EmbeddableFactory.createFromSavedObject.$3", "type": "Object", "label": "parent", "isRequired": false, @@ -5664,6 +5738,7 @@ ], "children": [ { + "id": "def-public.EmbeddableFactory.create.$1", "type": "Uncategorized", "label": "initialInput", "isRequired": true, @@ -5677,6 +5752,7 @@ } }, { + "id": "def-public.EmbeddableFactory.create.$2", "type": "Object", "label": "parent", "isRequired": false, @@ -5798,13 +5874,7 @@ "lineNumber": 25 }, "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableError", - "text": "EmbeddableError" - }, + "EmbeddableError", " | undefined" ] }, @@ -6203,6 +6273,7 @@ ], "children": [ { + "id": "def-public.IContainer.untilEmbeddableLoaded.$1", "type": "string", "label": "id", "isRequired": true, @@ -6243,6 +6314,7 @@ ], "children": [ { + "id": "def-public.IContainer.getInputForChild.$1", "type": "string", "label": "id", "isRequired": true, @@ -6283,6 +6355,7 @@ ], "children": [ { + "id": "def-public.IContainer.updateInputForChild.$1", "type": "string", "label": "id", "isRequired": true, @@ -6296,6 +6369,7 @@ } }, { + "id": "def-public.IContainer.updateInputForChild.$2", "type": "Object", "label": "changes", "isRequired": true, @@ -6367,6 +6441,7 @@ ], "children": [ { + "id": "def-public.IContainer.getChild.$1", "type": "string", "label": "id", "isRequired": true, @@ -6399,6 +6474,7 @@ ], "children": [ { + "id": "def-public.IContainer.removeEmbeddable.$1", "type": "string", "label": "embeddableId", "isRequired": true, @@ -6470,6 +6546,7 @@ ], "children": [ { + "id": "def-public.IContainer.addNewEmbeddable.$1", "type": "string", "label": "type", "isRequired": true, @@ -6483,6 +6560,7 @@ } }, { + "id": "def-public.IContainer.addNewEmbeddable.$2", "type": "Object", "label": "explicitInput", "isRequired": true, @@ -6743,6 +6821,7 @@ ], "children": [ { + "id": "def-public.IEmbeddable.updateInput.$1", "type": "Object", "label": "changes", "isRequired": true, @@ -6890,6 +6969,7 @@ ], "children": [ { + "id": "def-public.IEmbeddable.render.$1", "type": "CompoundType", "label": "domNode", "isRequired": true, @@ -7895,13 +7975,7 @@ }, "signature": [ "(customProvider: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryProvider", - "text": "EmbeddableFactoryProvider" - }, + "EmbeddableFactoryProvider", ") => void" ] } @@ -8163,13 +8237,7 @@ "text": "SavedObjectEmbeddableInput" }, ">(type: string, options: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeServiceOptions", - "text": "AttributeServiceOptions" - } + "AttributeServiceOptions" ] } ], @@ -8385,6 +8453,7 @@ "type": "Function", "children": [ { + "id": "def-common.extractBaseEmbeddableInput.$1", "type": "CompoundType", "label": "state", "isRequired": true, @@ -8440,6 +8509,7 @@ "type": "Function", "children": [ { + "id": "def-common.getExtractFunction.$1", "type": "Object", "label": "embeddables", "isRequired": true, @@ -8503,6 +8573,7 @@ "type": "Function", "children": [ { + "id": "def-common.getInjectFunction.$1", "type": "Object", "label": "embeddables", "isRequired": true, @@ -8565,6 +8636,7 @@ "type": "Function", "children": [ { + "id": "def-common.getMigrateFunction.$1", "type": "Object", "label": "embeddables", "isRequired": true, @@ -8625,6 +8697,7 @@ "type": "Function", "children": [ { + "id": "def-common.getTelemetryFunction.$1", "type": "Object", "label": "embeddables", "isRequired": true, @@ -8678,6 +8751,7 @@ "type": "Function", "children": [ { + "id": "def-common.injectBaseEmbeddableInput.$1", "type": "CompoundType", "label": "state", "isRequired": true, @@ -8697,17 +8771,12 @@ } }, { + "id": "def-common.injectBaseEmbeddableInput.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -8773,6 +8842,7 @@ "description": [], "children": [ { + "id": "def-common.isSavedObjectEmbeddableInput.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -8813,6 +8883,7 @@ "type": "Function", "children": [ { + "id": "def-common.telemetryBaseEmbeddableInput.$1", "type": "CompoundType", "label": "state", "isRequired": true, @@ -8832,6 +8903,7 @@ } }, { + "id": "def-common.telemetryBaseEmbeddableInput.$2", "type": "Object", "label": "telemetryData", "isRequired": true, diff --git a/api_docs/embeddable_enhanced.json b/api_docs/embeddable_enhanced.json index 8c5d5a1de4ca..93aeac499473 100644 --- a/api_docs/embeddable_enhanced.json +++ b/api_docs/embeddable_enhanced.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.isEnhancedEmbeddable.$1", "type": "Uncategorized", "label": "maybeEnhancedEmbeddable", "isRequired": true, diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json index 6de5870d0523..9487ccee9f32 100644 --- a/api_docs/encrypted_saved_objects.json +++ b/api_docs/encrypted_saved_objects.json @@ -37,6 +37,7 @@ "description": [], "children": [ { + "id": "def-server.EncryptionError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -50,6 +51,7 @@ } }, { + "id": "def-server.EncryptionError.Unnamed.$2", "type": "string", "label": "attributeName", "isRequired": true, @@ -63,17 +65,12 @@ } }, { + "id": "def-server.EncryptionError.Unnamed.$3", "type": "Enum", "label": "operation", "isRequired": true, "signature": [ - { - "pluginId": "encryptedSavedObjects", - "scope": "server", - "docId": "kibEncryptedSavedObjectsPluginApi", - "section": "def-server.EncryptionErrorOperation", - "text": "EncryptionErrorOperation" - } + "EncryptionErrorOperation" ], "description": [], "source": { @@ -82,6 +79,7 @@ } }, { + "id": "def-server.EncryptionError.Unnamed.$4", "type": "Object", "label": "cause", "isRequired": false, @@ -155,13 +153,7 @@ "text": "SavedObjectsBaseOptions" }, " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ] } @@ -204,13 +196,7 @@ }, "signature": [ "ReadonlySet" ] }, @@ -292,13 +278,7 @@ "lineNumber": 37 }, "signature": [ - { - "pluginId": "encryptedSavedObjects", - "scope": "server", - "docId": "kibEncryptedSavedObjectsPluginApi", - "section": "def-server.CreateEncryptedSavedObjectsMigrationFn", - "text": "CreateEncryptedSavedObjectsMigrationFn" - } + "CreateEncryptedSavedObjectsMigrationFn" ] } ], @@ -341,13 +321,7 @@ "lineNumber": 42 }, "signature": [ - { - "pluginId": "encryptedSavedObjects", - "scope": "server", - "docId": "kibEncryptedSavedObjectsPluginApi", - "section": "def-server.ClientInstanciator", - "text": "ClientInstanciator" - } + "ClientInstanciator" ] } ], diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json index c3b2b042f987..ac32be544759 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -39,6 +39,7 @@ "description": [], "children": [ { + "id": "def-public.CronEditor.getDerivedStateFromProps.$1", "type": "Object", "label": "props", "isRequired": true, @@ -69,6 +70,7 @@ "description": [], "children": [ { + "id": "def-public.CronEditor.Unnamed.$1", "type": "Object", "label": "props", "isRequired": true, @@ -94,6 +96,7 @@ "type": "Function", "children": [ { + "id": "def-public.CronEditor.onChangeFrequency.$1", "type": "CompoundType", "label": "frequency", "isRequired": true, @@ -138,17 +141,12 @@ "type": "Function", "children": [ { + "id": "def-public.CronEditor.onChangeFields.$1", "type": "Object", "label": "fields", "isRequired": true, "signature": [ - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.FieldToValueMap", - "text": "FieldToValueMap" - } + "FieldToValueMap" ], "description": [], "source": { @@ -159,13 +157,7 @@ ], "signature": [ "(fields: ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.FieldToValueMap", - "text": "FieldToValueMap" - }, + "FieldToValueMap", ") => void" ], "description": [], @@ -223,6 +215,7 @@ "type": "Function", "children": [ { + "id": "def-public.attemptToURIDecode.$1", "type": "string", "label": "value", "isRequired": false, @@ -254,6 +247,7 @@ "type": "Function", "children": [ { + "id": "def-public.AuthorizationProvider.$1", "type": "Object", "label": "{ privilegesEndpoint, httpClient, children }", "isRequired": true, @@ -292,6 +286,7 @@ "description": [], "children": [ { + "id": "def-public.extractQueryParams.$1", "type": "string", "label": "queryString", "isRequired": true, @@ -333,6 +328,7 @@ "type": "Function", "children": [ { + "id": "def-public.NotAuthorizedSection.$1", "type": "Object", "label": "{ title, message }", "isRequired": true, @@ -364,6 +360,7 @@ "type": "Function", "children": [ { + "id": "def-public.SectionError.$1", "type": "CompoundType", "label": "{\n title,\n error,\n actions,\n ...rest\n}", "isRequired": true, @@ -395,6 +392,7 @@ "type": "Function", "children": [ { + "id": "def-public.SectionLoading.$1", "type": "CompoundType", "label": "{ inline, children, ...rest }", "isRequired": true, @@ -426,6 +424,7 @@ "type": "Function", "children": [ { + "id": "def-public.sendRequest.$1", "type": "Object", "label": "httpClient", "isRequired": true, @@ -445,6 +444,7 @@ } }, { + "id": "def-public.sendRequest.$2", "type": "Object", "label": "{ path, method, body, query, asSystemRequest }", "isRequired": true, @@ -523,6 +523,7 @@ "type": "Function", "children": [ { + "id": "def-public.useRequest.$1", "type": "Object", "label": "httpClient", "isRequired": true, @@ -542,6 +543,7 @@ } }, { + "id": "def-public.useRequest.$2", "type": "Object", "label": "{ path, method, query, body, pollIntervalMs, initialData, deserializer }", "isRequired": true, @@ -603,6 +605,7 @@ "type": "Function", "children": [ { + "id": "def-public.WithPrivileges.$1", "type": "Object", "label": "{ privileges: requiredPrivileges, children }", "isRequired": true, @@ -1217,13 +1220,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.indexNameBeginsWithPeriod", - "text": "indexNameBeginsWithPeriod" - } + "indexNameBeginsWithPeriod" ] }, { @@ -1238,13 +1235,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.findIllegalCharactersInIndexName", - "text": "findIllegalCharactersInIndexName" - } + "findIllegalCharactersInIndexName" ] }, { @@ -1259,13 +1250,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "esUiShared", - "scope": "public", - "docId": "kibEsUiSharedPluginApi", - "section": "def-public.indexNameContainsSpaces", - "text": "indexNameContainsSpaces" - } + "indexNameContainsSpaces" ] } ], @@ -1287,6 +1272,7 @@ "type": "Function", "children": [ { + "id": "def-server.handleEsError.$1", "type": "Object", "label": "{\n error,\n response,\n handleCustomError,\n}", "isRequired": true, @@ -1331,6 +1317,7 @@ "description": [], "children": [ { + "id": "def-server.isEsError.$1", "type": "Object", "label": "err", "isRequired": true, @@ -1357,6 +1344,7 @@ "type": "Function", "children": [ { + "id": "def-server.parseEsError.$1", "type": "string", "label": "err", "isRequired": true, diff --git a/api_docs/event_log.json b/api_docs/event_log.json index aea4d0c00191..5523b3eb60b4 100644 --- a/api_docs/event_log.json +++ b/api_docs/event_log.json @@ -9,8 +9,487 @@ "objects": [] }, "server": { - "classes": [], - "functions": [], + "classes": [ + { + "id": "def-server.ClusterClientAdapter", + "type": "Class", + "tags": [], + "label": "ClusterClientAdapter", + "description": [], + "signature": [ + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.ClusterClientAdapter", + "text": "ClusterClientAdapter" + }, + "" + ], + "children": [ + { + "id": "def-server.ClusterClientAdapter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.Unnamed.$1", + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + "ConstructorOpts" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 54 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 54 + } + }, + { + "id": "def-server.ClusterClientAdapter.shutdown", + "type": "Function", + "label": "shutdown", + "signature": [ + "() => Promise" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 78 + } + }, + { + "id": "def-server.ClusterClientAdapter.indexDocument", + "type": "Function", + "label": "indexDocument", + "signature": [ + "(doc: TDoc) => void" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.indexDocument.$1", + "type": "Uncategorized", + "label": "doc", + "isRequired": true, + "signature": [ + "TDoc" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 83 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 83 + } + }, + { + "id": "def-server.ClusterClientAdapter.indexDocuments", + "type": "Function", + "label": "indexDocuments", + "signature": [ + "(docs: TDoc[]) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.indexDocuments.$1", + "type": "Array", + "label": "docs", + "isRequired": true, + "signature": [ + "TDoc[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 87 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 87 + } + }, + { + "id": "def-server.ClusterClientAdapter.doesIlmPolicyExist", + "type": "Function", + "label": "doesIlmPolicyExist", + "signature": [ + "(policyName: string) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.doesIlmPolicyExist.$1", + "type": "string", + "label": "policyName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 123 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 123 + } + }, + { + "id": "def-server.ClusterClientAdapter.createIlmPolicy", + "type": "Function", + "label": "createIlmPolicy", + "signature": [ + "(policyName: string, policy: Record) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.createIlmPolicy.$1", + "type": "string", + "label": "policyName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 138 + } + }, + { + "id": "def-server.ClusterClientAdapter.createIlmPolicy.$2", + "type": "Object", + "label": "policy", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 138 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 138 + } + }, + { + "id": "def-server.ClusterClientAdapter.doesIndexTemplateExist", + "type": "Function", + "label": "doesIndexTemplateExist", + "signature": [ + "(name: string) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.doesIndexTemplateExist.$1", + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 152 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 152 + } + }, + { + "id": "def-server.ClusterClientAdapter.createIndexTemplate", + "type": "Function", + "label": "createIndexTemplate", + "signature": [ + "(name: string, template: Record) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.createIndexTemplate.$1", + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 162 + } + }, + { + "id": "def-server.ClusterClientAdapter.createIndexTemplate.$2", + "type": "Object", + "label": "template", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 162 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 162 + } + }, + { + "id": "def-server.ClusterClientAdapter.doesAliasExist", + "type": "Function", + "label": "doesAliasExist", + "signature": [ + "(name: string) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.doesAliasExist.$1", + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 180 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 180 + } + }, + { + "id": "def-server.ClusterClientAdapter.createIndex", + "type": "Function", + "label": "createIndex", + "signature": [ + "(name: string, body?: Record) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.createIndex.$1", + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 190 + } + }, + { + "id": "def-server.ClusterClientAdapter.createIndex.$2", + "type": "Object", + "label": "body", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 190 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 190 + } + }, + { + "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects", + "type": "Function", + "label": "queryEventsBySavedObjects", + "signature": [ + "(index: string, namespace: string | undefined, type: string, ids: string[], { page, per_page: perPage, start, end, sort_field, sort_order, filter }: ", + "FindOptionsType", + ") => Promise<", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.QueryEventsBySavedObjectResult", + "text": "QueryEventsBySavedObjectResult" + }, + ">" + ], + "description": [], + "children": [ + { + "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$1", + "type": "string", + "label": "index", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 205 + } + }, + { + "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$2", + "type": "string", + "label": "namespace", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 206 + } + }, + { + "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$3", + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 207 + } + }, + { + "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$4", + "type": "Array", + "label": "ids", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 208 + } + }, + { + "id": "def-server.ClusterClientAdapter.queryEventsBySavedObjects.$5", + "type": "CompoundType", + "label": "{ page, per_page: perPage, start, end, sort_field, sort_order, filter }", + "isRequired": true, + "signature": [ + "FindOptionsType" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 210 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 204 + } + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 47 + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-server.createReadySignal", + "type": "Function", + "label": "createReadySignal", + "signature": [ + "() => ", + "ReadySignal", + "" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/lib/ready_signal.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + } + ], "interfaces": [ { "id": "def-server.IEventLogClient", @@ -25,13 +504,7 @@ "label": "findEventsBySavedObjectIds", "signature": [ "(type: string, ids: string[], options?: Partial<", - { - "pluginId": "eventLog", - "scope": "server", - "docId": "kibEventLogPluginApi", - "section": "def-server.FindOptionsType", - "text": "FindOptionsType" - }, + "FindOptionsType", "> | undefined) => Promise<", { "pluginId": "eventLog", @@ -45,6 +518,7 @@ "description": [], "children": [ { + "id": "def-server.IEventLogClient.findEventsBySavedObjectIds.$1", "type": "string", "label": "type", "isRequired": true, @@ -58,6 +532,7 @@ } }, { + "id": "def-server.IEventLogClient.findEventsBySavedObjectIds.$2", "type": "Array", "label": "ids", "isRequired": true, @@ -71,18 +546,13 @@ } }, { + "id": "def-server.IEventLogClient.findEventsBySavedObjectIds.$3", "type": "Object", "label": "options", "isRequired": false, "signature": [ "Partial<", - { - "pluginId": "eventLog", - "scope": "server", - "docId": "kibEventLogPluginApi", - "section": "def-server.FindOptionsType", - "text": "FindOptionsType" - }, + "FindOptionsType", "> | undefined" ], "description": [], @@ -118,16 +588,17 @@ "type": "Function", "label": "logEvent", "signature": [ - "(properties: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], "description": [], "children": [ { + "id": "def-server.IEventLogger.logEvent.$1", "type": "Object", "label": "properties", "isRequired": false, "signature": [ - "DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "description": [], "source": { @@ -148,16 +619,17 @@ "type": "Function", "label": "startTiming", "signature": [ - "(event: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], "description": [], "children": [ { + "id": "def-server.IEventLogger.startTiming.$1", "type": "Object", "label": "event", "isRequired": false, "signature": [ - "DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "description": [], "source": { @@ -178,16 +650,17 @@ "type": "Function", "label": "stopTiming", "signature": [ - "(event: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" ], "description": [], "children": [ { + "id": "def-server.IEventLogger.stopTiming.$1", "type": "Object", "label": "event", "isRequired": false, "signature": [ - "DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "description": [], "source": { @@ -225,7 +698,7 @@ "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 36 + "lineNumber": 38 } }, { @@ -236,7 +709,7 @@ "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 37 + "lineNumber": 39 } }, { @@ -247,7 +720,7 @@ "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 38 + "lineNumber": 40 } }, { @@ -258,16 +731,16 @@ "description": [], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 39 + "lineNumber": 41 }, "signature": [ - "(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" ] } ], "source": { "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", - "lineNumber": 35 + "lineNumber": 37 }, "initialIsOpen": false } @@ -285,7 +758,7 @@ "lineNumber": 26 }, "signature": [ - "undefined | DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>>" ], "initialIsOpen": false }, @@ -300,7 +773,7 @@ "lineNumber": 25 }, "signature": [ - "undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>" ], "initialIsOpen": false }, @@ -386,6 +859,7 @@ "description": [], "children": [ { + "id": "def-server.IEventLogService.registerProviderActions.$1", "type": "string", "label": "provider", "isRequired": true, @@ -399,6 +873,7 @@ } }, { + "id": "def-server.IEventLogService.registerProviderActions.$2", "type": "Array", "label": "actions", "isRequired": true, @@ -429,6 +904,7 @@ "description": [], "children": [ { + "id": "def-server.IEventLogService.isProviderActionRegistered.$1", "type": "string", "label": "provider", "isRequired": true, @@ -442,6 +918,7 @@ } }, { + "id": "def-server.IEventLogService.isProviderActionRegistered.$2", "type": "string", "label": "action", "isRequired": true, @@ -484,18 +961,13 @@ "label": "registerSavedObjectProvider", "signature": [ "(type: string, provider: ", - { - "pluginId": "eventLog", - "scope": "server", - "docId": "kibEventLogPluginApi", - "section": "def-server.SavedObjectProvider", - "text": "SavedObjectProvider" - }, + "SavedObjectProvider", ") => void" ], "description": [], "children": [ { + "id": "def-server.IEventLogService.registerSavedObjectProvider.$1", "type": "string", "label": "type", "isRequired": true, @@ -509,17 +981,12 @@ } }, { + "id": "def-server.IEventLogService.registerSavedObjectProvider.$2", "type": "Function", "label": "provider", "isRequired": true, "signature": [ - { - "pluginId": "eventLog", - "scope": "server", - "docId": "kibEventLogPluginApi", - "section": "def-server.SavedObjectProvider", - "text": "SavedObjectProvider" - } + "SavedObjectProvider" ], "description": [], "source": { @@ -540,7 +1007,7 @@ "type": "Function", "label": "getLogger", "signature": [ - "(properties: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ", { "pluginId": "eventLog", "scope": "server", @@ -552,11 +1019,12 @@ "description": [], "children": [ { + "id": "def-server.IEventLogService.getLogger.$1", "type": "Object", "label": "properties", "isRequired": false, "signature": [ - "DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: 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; } & {}>[] | 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; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: 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; uuid?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "description": [], "source": { @@ -612,6 +1080,7 @@ "description": [], "children": [ { + "id": "def-server.IEventLogClientService.getClient.$1", "type": "Object", "label": "request", "isRequired": true, diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 2c212e5099f0..6948a63cf85c 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -19,6 +19,12 @@ import eventLogObj from './event_log.json'; ### Start +### Functions + + +### Classes + + ### Interfaces diff --git a/api_docs/expressions.json b/api_docs/expressions.json index 06c97e497ae4..7355d2904e63 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -103,13 +103,7 @@ "text": "ExecutionContext" }, "" ] }, @@ -209,6 +203,7 @@ "description": [], "children": [ { + "id": "def-public.Execution.Unnamed.$1", "type": "Object", "label": "execution", "isRequired": true, @@ -265,6 +260,7 @@ ], "children": [ { + "id": "def-public.Execution.start.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -303,6 +299,7 @@ "description": [], "children": [ { + "id": "def-public.Execution.invokeChain.$1", "type": "Array", "label": "chainArr", "isRequired": true, @@ -323,6 +320,7 @@ } }, { + "id": "def-public.Execution.invokeChain.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -361,6 +359,7 @@ "description": [], "children": [ { + "id": "def-public.Execution.invokeFunction.$1", "type": "Object", "label": "fn", "isRequired": true, @@ -380,6 +379,7 @@ } }, { + "id": "def-public.Execution.invokeFunction.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -393,6 +393,7 @@ } }, { + "id": "def-public.Execution.invokeFunction.$3", "type": "Object", "label": "args", "isRequired": true, @@ -423,6 +424,7 @@ "description": [], "children": [ { + "id": "def-public.Execution.cast.$1", "type": "Any", "label": "value", "isRequired": true, @@ -436,6 +438,7 @@ } }, { + "id": "def-public.Execution.cast.$2", "type": "Array", "label": "toTypeNames", "isRequired": false, @@ -474,6 +477,7 @@ "description": [], "children": [ { + "id": "def-public.Execution.resolveArgs.$1", "type": "Object", "label": "fnDef", "isRequired": true, @@ -493,6 +497,7 @@ } }, { + "id": "def-public.Execution.resolveArgs.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -506,6 +511,7 @@ } }, { + "id": "def-public.Execution.resolveArgs.$3", "type": "Any", "label": "argAsts", "isRequired": true, @@ -544,6 +550,7 @@ "description": [], "children": [ { + "id": "def-public.Execution.interpret.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -563,6 +570,7 @@ } }, { + "id": "def-public.Execution.interpret.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -630,6 +638,7 @@ "description": [], "children": [ { + "id": "def-public.ExecutionContract.Unnamed.$1", "type": "Object", "label": "execution", "isRequired": true, @@ -836,6 +845,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.createWithDefaults.$1", "type": "Object", "label": "state", "isRequired": false, @@ -938,6 +948,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.Unnamed.$1", "type": "Object", "label": "state", "isRequired": false, @@ -991,6 +1002,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.registerFunction.$1", "type": "CompoundType", "label": "functionDefinition", "isRequired": true, @@ -1044,6 +1056,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.getFunction.$1", "type": "string", "label": "name", "isRequired": true, @@ -1114,6 +1127,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.registerType.$1", "type": "CompoundType", "label": "typeDefinition", "isRequired": true, @@ -1167,6 +1181,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.getType.$1", "type": "string", "label": "name", "isRequired": true, @@ -1221,6 +1236,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.extendContext.$1", "type": "Object", "label": "extraContext", "isRequired": true, @@ -1283,6 +1299,7 @@ ], "children": [ { + "id": "def-public.Executor.run.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -1305,6 +1322,7 @@ } }, { + "id": "def-public.Executor.run.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -1320,6 +1338,7 @@ } }, { + "id": "def-public.Executor.run.$3", "type": "Object", "label": "params", "isRequired": true, @@ -1388,6 +1407,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.createExecution.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -1408,6 +1428,7 @@ } }, { + "id": "def-public.Executor.createExecution.$2", "type": "Object", "label": "params", "isRequired": true, @@ -1448,13 +1469,7 @@ "text": "ExpressionAstExpression" }, ", references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => ", { "pluginId": "expressions", @@ -1467,6 +1482,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.inject.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -1486,17 +1502,12 @@ } }, { + "id": "def-public.Executor.inject.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -1535,18 +1546,13 @@ "text": "ExpressionAstExpression" }, "; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [], "children": [ { + "id": "def-public.Executor.extract.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -1591,6 +1597,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.telemetry.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -1610,6 +1617,7 @@ } }, { + "id": "def-public.Executor.telemetry.$2", "type": "Object", "label": "telemetryData", "isRequired": true, @@ -1655,6 +1663,7 @@ "description": [], "children": [ { + "id": "def-public.Executor.migrate.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -1674,6 +1683,7 @@ } }, { + "id": "def-public.Executor.migrate.$2", "type": "string", "label": "version", "isRequired": true, @@ -1920,13 +1930,7 @@ "text": "ExpressionAstArgument" }, "[]>; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ] }, @@ -1950,13 +1954,7 @@ "text": "ExpressionAstArgument" }, "[]>, references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => Record false,\n }", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderHandlerParams", - "text": "ExpressionRenderHandlerParams" - } + "ExpressionRenderHandlerParams" ], "description": [], "source": { @@ -2718,6 +2720,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionRenderHandler.render.$1", "type": "Any", "label": "value", "isRequired": true, @@ -2731,6 +2734,7 @@ } }, { + "id": "def-public.ExpressionRenderHandler.render.$2", "type": "Any", "label": "uiState", "isRequired": true, @@ -2793,6 +2797,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionRenderHandler.handleRenderError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -2867,6 +2872,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsInspectorAdapter.logAST.$1", "type": "Any", "label": "ast", "isRequired": true, @@ -2959,6 +2965,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -3012,6 +3019,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3064,6 +3072,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3164,6 +3173,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -3217,6 +3227,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3269,6 +3280,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3404,6 +3416,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionsService.Unnamed.$1", "type": "Object", "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", "isRequired": true, @@ -3435,6 +3448,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.registerFunction.$1", "type": "CompoundType", "label": "functionDefinition", "isRequired": true, @@ -3498,6 +3512,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.registerType.$1", "type": "CompoundType", "label": "typeDefinition", "isRequired": true, @@ -3559,6 +3574,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.registerRenderer.$1", "type": "CompoundType", "label": "definition", "isRequired": true, @@ -3620,6 +3636,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.run.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -3640,6 +3657,7 @@ } }, { + "id": "def-public.ExpressionsService.run.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -3653,6 +3671,7 @@ } }, { + "id": "def-public.ExpressionsService.run.$3", "type": "Object", "label": "params", "isRequired": false, @@ -3706,6 +3725,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.getFunction.$1", "type": "string", "label": "name", "isRequired": true, @@ -3770,6 +3790,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.getRenderer.$1", "type": "string", "label": "name", "isRequired": true, @@ -3834,6 +3855,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.getType.$1", "type": "string", "label": "name", "isRequired": true, @@ -3959,6 +3981,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.telemetry.$1", "type": "Object", "label": "state", "isRequired": true, @@ -3978,6 +4001,7 @@ } }, { + "id": "def-public.ExpressionsService.telemetry.$2", "type": "Object", "label": "telemetryData", "isRequired": true, @@ -4018,6 +4042,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.extract.$1", "type": "Object", "label": "state", "isRequired": true, @@ -4055,13 +4080,7 @@ "text": "ExpressionAstExpression" }, "; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [ @@ -4082,6 +4101,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.inject.$1", "type": "Object", "label": "state", "isRequired": true, @@ -4101,17 +4121,12 @@ } }, { + "id": "def-public.ExpressionsService.inject.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -4131,13 +4146,7 @@ "text": "ExpressionAstExpression" }, ", references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => ", { "pluginId": "expressions", @@ -4165,6 +4174,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionsService.migrate.$1", "type": "Object", "label": "state", "isRequired": true, @@ -4184,6 +4194,7 @@ } }, { + "id": "def-public.ExpressionsService.migrate.$2", "type": "string", "label": "version", "isRequired": true, @@ -4403,6 +4414,7 @@ "description": [], "children": [ { + "id": "def-public.ExpressionType.Unnamed.$1", "type": "Object", "label": "definition", "isRequired": true, @@ -4434,6 +4446,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionType.getToFn.$1", "type": "string", "label": "typeName", "isRequired": true, @@ -4472,6 +4485,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionType.getFromFn.$1", "type": "string", "label": "typeName", "isRequired": true, @@ -4510,6 +4524,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionType.castsTo.$1", "type": "Any", "label": "value", "isRequired": true, @@ -4540,6 +4555,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionType.castsFrom.$1", "type": "Any", "label": "value", "isRequired": true, @@ -4570,6 +4586,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionType.to.$1", "type": "Any", "label": "value", "isRequired": true, @@ -4583,6 +4600,7 @@ } }, { + "id": "def-public.ExpressionType.to.$2", "type": "string", "label": "toTypeName", "isRequired": true, @@ -4596,6 +4614,7 @@ } }, { + "id": "def-public.ExpressionType.to.$3", "type": "Object", "label": "types", "isRequired": true, @@ -4642,6 +4661,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExpressionType.from.$1", "type": "Any", "label": "value", "isRequired": true, @@ -4655,6 +4675,7 @@ } }, { + "id": "def-public.ExpressionType.from.$2", "type": "Object", "label": "types", "isRequired": true, @@ -4746,6 +4767,7 @@ "description": [], "children": [ { + "id": "def-public.FunctionsRegistry.Unnamed.$1", "type": "Object", "label": "executor", "isRequired": true, @@ -4799,6 +4821,7 @@ "description": [], "children": [ { + "id": "def-public.FunctionsRegistry.register.$1", "type": "CompoundType", "label": "functionDefinition", "isRequired": true, @@ -4852,6 +4875,7 @@ "description": [], "children": [ { + "id": "def-public.FunctionsRegistry.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -4963,6 +4987,7 @@ "description": [], "children": [ { + "id": "def-public.TablesAdapter.logDatatable.$1", "type": "string", "label": "name", "isRequired": true, @@ -4976,6 +5001,7 @@ } }, { + "id": "def-public.TablesAdapter.logDatatable.$2", "type": "Object", "label": "datatable", "isRequired": true, @@ -5074,6 +5100,7 @@ "description": [], "children": [ { + "id": "def-public.TypesRegistry.Unnamed.$1", "type": "Object", "label": "executor", "isRequired": true, @@ -5127,6 +5154,7 @@ "description": [], "children": [ { + "id": "def-public.TypesRegistry.register.$1", "type": "CompoundType", "label": "typeDefinition", "isRequired": true, @@ -5180,6 +5208,7 @@ "description": [], "children": [ { + "id": "def-public.TypesRegistry.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -5300,6 +5329,7 @@ ], "children": [ { + "id": "def-public.buildExpression.$1", "type": "CompoundType", "label": "initialState", "isRequired": false, @@ -5395,6 +5425,7 @@ ], "children": [ { + "id": "def-public.buildExpressionFunction.$1", "type": "Uncategorized", "label": "fnName", "isRequired": true, @@ -5417,6 +5448,7 @@ } }, { + "id": "def-public.buildExpressionFunction.$2", "type": "Object", "label": "initialArgs", "isRequired": true, @@ -5478,6 +5510,7 @@ "description": [], "children": [ { + "id": "def-public.format.$1", "type": "Uncategorized", "label": "ast", "isRequired": true, @@ -5491,6 +5524,7 @@ } }, { + "id": "def-public.format.$2", "type": "Uncategorized", "label": "type", "isRequired": true, @@ -5540,6 +5574,7 @@ ], "children": [ { + "id": "def-public.formatExpression.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -5581,6 +5616,7 @@ ], "children": [ { + "id": "def-public.isExpressionAstBuilder.$1", "type": "Any", "label": "val", "isRequired": true, @@ -5633,6 +5669,7 @@ "description": [], "children": [ { + "id": "def-public.parse.$1", "type": "Uncategorized", "label": "expression", "isRequired": true, @@ -5646,6 +5683,7 @@ } }, { + "id": "def-public.parse.$2", "type": "Uncategorized", "label": "startRule", "isRequired": true, @@ -5686,6 +5724,7 @@ ], "children": [ { + "id": "def-public.parseExpression.$1", "type": "string", "label": "expression", "isRequired": true, @@ -5714,6 +5753,7 @@ "type": "Function", "children": [ { + "id": "def-public.ReactExpressionRenderer.$1", "type": "Object", "label": "{\n className,\n dataAttrs,\n padding,\n renderError,\n expression,\n onEvent,\n onData$,\n reload$,\n debounce,\n ...expressionLoaderOptions\n}", "isRequired": true, @@ -6713,13 +6753,7 @@ "lineNumber": 25 }, "signature": [ - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionInterpreter", - "text": "ExpressionInterpreter" - } + "ExpressionInterpreter" ] } ], @@ -6910,6 +6944,7 @@ ], "children": [ { + "id": "def-public.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -6925,6 +6960,7 @@ } }, { + "id": "def-public.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", "label": "args", "isRequired": true, @@ -6940,6 +6976,7 @@ } }, { + "id": "def-public.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -7872,13 +7909,7 @@ "lineNumber": 36 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined" ] }, @@ -8012,13 +8043,7 @@ "lineNumber": 46 }, "signature": [ - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.RenderErrorHandlerFnType", - "text": "RenderErrorHandlerFnType" - }, + "RenderErrorHandlerFnType", " | undefined" ] }, @@ -8271,6 +8296,7 @@ "description": [], "children": [ { + "id": "def-public.IRegistry.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -9526,13 +9552,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionLoader", - "text": "ExpressionLoader" - } + "ExpressionLoader" ] }, { @@ -9567,13 +9587,7 @@ "lineNumber": 27 }, "signature": [ - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.IExpressionLoader", - "text": "IExpressionLoader" - } + "IExpressionLoader" ] }, { @@ -9610,13 +9624,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.render", - "text": "render" - } + "render" ] } ], @@ -9731,13 +9739,7 @@ "text": "ExecutionContext" }, "" ] }, @@ -9837,6 +9839,7 @@ "description": [], "children": [ { + "id": "def-server.Execution.Unnamed.$1", "type": "Object", "label": "execution", "isRequired": true, @@ -9893,6 +9896,7 @@ ], "children": [ { + "id": "def-server.Execution.start.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -9931,6 +9935,7 @@ "description": [], "children": [ { + "id": "def-server.Execution.invokeChain.$1", "type": "Array", "label": "chainArr", "isRequired": true, @@ -9951,6 +9956,7 @@ } }, { + "id": "def-server.Execution.invokeChain.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -9989,6 +9995,7 @@ "description": [], "children": [ { + "id": "def-server.Execution.invokeFunction.$1", "type": "Object", "label": "fn", "isRequired": true, @@ -10008,6 +10015,7 @@ } }, { + "id": "def-server.Execution.invokeFunction.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -10021,6 +10029,7 @@ } }, { + "id": "def-server.Execution.invokeFunction.$3", "type": "Object", "label": "args", "isRequired": true, @@ -10051,6 +10060,7 @@ "description": [], "children": [ { + "id": "def-server.Execution.cast.$1", "type": "Any", "label": "value", "isRequired": true, @@ -10064,6 +10074,7 @@ } }, { + "id": "def-server.Execution.cast.$2", "type": "Array", "label": "toTypeNames", "isRequired": false, @@ -10102,6 +10113,7 @@ "description": [], "children": [ { + "id": "def-server.Execution.resolveArgs.$1", "type": "Object", "label": "fnDef", "isRequired": true, @@ -10121,6 +10133,7 @@ } }, { + "id": "def-server.Execution.resolveArgs.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -10134,6 +10147,7 @@ } }, { + "id": "def-server.Execution.resolveArgs.$3", "type": "Any", "label": "argAsts", "isRequired": true, @@ -10172,6 +10186,7 @@ "description": [], "children": [ { + "id": "def-server.Execution.interpret.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -10191,6 +10206,7 @@ } }, { + "id": "def-server.Execution.interpret.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -10269,6 +10285,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.createWithDefaults.$1", "type": "Object", "label": "state", "isRequired": false, @@ -10371,6 +10388,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.Unnamed.$1", "type": "Object", "label": "state", "isRequired": false, @@ -10424,6 +10442,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.registerFunction.$1", "type": "CompoundType", "label": "functionDefinition", "isRequired": true, @@ -10477,6 +10496,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.getFunction.$1", "type": "string", "label": "name", "isRequired": true, @@ -10547,6 +10567,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.registerType.$1", "type": "CompoundType", "label": "typeDefinition", "isRequired": true, @@ -10600,6 +10621,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.getType.$1", "type": "string", "label": "name", "isRequired": true, @@ -10654,6 +10676,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.extendContext.$1", "type": "Object", "label": "extraContext", "isRequired": true, @@ -10716,6 +10739,7 @@ ], "children": [ { + "id": "def-server.Executor.run.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -10738,6 +10762,7 @@ } }, { + "id": "def-server.Executor.run.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -10753,6 +10778,7 @@ } }, { + "id": "def-server.Executor.run.$3", "type": "Object", "label": "params", "isRequired": true, @@ -10821,6 +10847,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.createExecution.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -10841,6 +10868,7 @@ } }, { + "id": "def-server.Executor.createExecution.$2", "type": "Object", "label": "params", "isRequired": true, @@ -10881,13 +10909,7 @@ "text": "ExpressionAstExpression" }, ", references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => ", { "pluginId": "expressions", @@ -10900,6 +10922,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.inject.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -10919,17 +10942,12 @@ } }, { + "id": "def-server.Executor.inject.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -10968,18 +10986,13 @@ "text": "ExpressionAstExpression" }, "; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [], "children": [ { + "id": "def-server.Executor.extract.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -11024,6 +11037,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.telemetry.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -11043,6 +11057,7 @@ } }, { + "id": "def-server.Executor.telemetry.$2", "type": "Object", "label": "telemetryData", "isRequired": true, @@ -11088,6 +11103,7 @@ "description": [], "children": [ { + "id": "def-server.Executor.migrate.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -11107,6 +11123,7 @@ } }, { + "id": "def-server.Executor.migrate.$2", "type": "string", "label": "version", "isRequired": true, @@ -11353,13 +11370,7 @@ "text": "ExpressionAstArgument" }, "[]>; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ] }, @@ -11383,13 +11394,7 @@ "text": "ExpressionAstArgument" }, "[]>, references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => Record" ] }, @@ -16962,6 +17005,7 @@ "description": [], "children": [ { + "id": "def-common.Execution.Unnamed.$1", "type": "Object", "label": "execution", "isRequired": true, @@ -17018,6 +17062,7 @@ ], "children": [ { + "id": "def-common.Execution.start.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -17056,6 +17101,7 @@ "description": [], "children": [ { + "id": "def-common.Execution.invokeChain.$1", "type": "Array", "label": "chainArr", "isRequired": true, @@ -17076,6 +17122,7 @@ } }, { + "id": "def-common.Execution.invokeChain.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -17114,6 +17161,7 @@ "description": [], "children": [ { + "id": "def-common.Execution.invokeFunction.$1", "type": "Object", "label": "fn", "isRequired": true, @@ -17133,6 +17181,7 @@ } }, { + "id": "def-common.Execution.invokeFunction.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -17146,6 +17195,7 @@ } }, { + "id": "def-common.Execution.invokeFunction.$3", "type": "Object", "label": "args", "isRequired": true, @@ -17176,6 +17226,7 @@ "description": [], "children": [ { + "id": "def-common.Execution.cast.$1", "type": "Any", "label": "value", "isRequired": true, @@ -17189,6 +17240,7 @@ } }, { + "id": "def-common.Execution.cast.$2", "type": "Array", "label": "toTypeNames", "isRequired": false, @@ -17227,6 +17279,7 @@ "description": [], "children": [ { + "id": "def-common.Execution.resolveArgs.$1", "type": "Object", "label": "fnDef", "isRequired": true, @@ -17246,6 +17299,7 @@ } }, { + "id": "def-common.Execution.resolveArgs.$2", "type": "Unknown", "label": "input", "isRequired": true, @@ -17259,6 +17313,7 @@ } }, { + "id": "def-common.Execution.resolveArgs.$3", "type": "Any", "label": "argAsts", "isRequired": true, @@ -17297,6 +17352,7 @@ "description": [], "children": [ { + "id": "def-common.Execution.interpret.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -17316,6 +17372,7 @@ } }, { + "id": "def-common.Execution.interpret.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -17383,6 +17440,7 @@ "description": [], "children": [ { + "id": "def-common.ExecutionContract.Unnamed.$1", "type": "Object", "label": "execution", "isRequired": true, @@ -17589,6 +17647,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.createWithDefaults.$1", "type": "Object", "label": "state", "isRequired": false, @@ -17691,6 +17750,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.Unnamed.$1", "type": "Object", "label": "state", "isRequired": false, @@ -17744,6 +17804,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.registerFunction.$1", "type": "CompoundType", "label": "functionDefinition", "isRequired": true, @@ -17797,6 +17858,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.getFunction.$1", "type": "string", "label": "name", "isRequired": true, @@ -17867,6 +17929,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.registerType.$1", "type": "CompoundType", "label": "typeDefinition", "isRequired": true, @@ -17920,6 +17983,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.getType.$1", "type": "string", "label": "name", "isRequired": true, @@ -17974,6 +18038,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.extendContext.$1", "type": "Object", "label": "extraContext", "isRequired": true, @@ -18036,6 +18101,7 @@ ], "children": [ { + "id": "def-common.Executor.run.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -18058,6 +18124,7 @@ } }, { + "id": "def-common.Executor.run.$2", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -18073,6 +18140,7 @@ } }, { + "id": "def-common.Executor.run.$3", "type": "Object", "label": "params", "isRequired": true, @@ -18141,6 +18209,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.createExecution.$1", "type": "CompoundType", "label": "ast", "isRequired": true, @@ -18161,6 +18230,7 @@ } }, { + "id": "def-common.Executor.createExecution.$2", "type": "Object", "label": "params", "isRequired": true, @@ -18201,13 +18271,7 @@ "text": "ExpressionAstExpression" }, ", references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => ", { "pluginId": "expressions", @@ -18220,6 +18284,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.inject.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -18239,17 +18304,12 @@ } }, { + "id": "def-common.Executor.inject.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -18288,18 +18348,13 @@ "text": "ExpressionAstExpression" }, "; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [], "children": [ { + "id": "def-common.Executor.extract.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -18344,6 +18399,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.telemetry.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -18363,6 +18419,7 @@ } }, { + "id": "def-common.Executor.telemetry.$2", "type": "Object", "label": "telemetryData", "isRequired": true, @@ -18408,6 +18465,7 @@ "description": [], "children": [ { + "id": "def-common.Executor.migrate.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -18427,6 +18485,7 @@ } }, { + "id": "def-common.Executor.migrate.$2", "type": "string", "label": "version", "isRequired": true, @@ -18673,13 +18732,7 @@ "text": "ExpressionAstArgument" }, "[]>; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ] }, @@ -18703,13 +18756,7 @@ "text": "ExpressionAstArgument" }, "[]>, references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => Record ", { "pluginId": "expressions", @@ -20273,6 +20326,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionsService.migrate.$1", "type": "Object", "label": "state", "isRequired": true, @@ -20292,6 +20346,7 @@ } }, { + "id": "def-common.ExpressionsService.migrate.$2", "type": "string", "label": "version", "isRequired": true, @@ -20511,6 +20566,7 @@ "description": [], "children": [ { + "id": "def-common.ExpressionType.Unnamed.$1", "type": "Object", "label": "definition", "isRequired": true, @@ -20542,6 +20598,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionType.getToFn.$1", "type": "string", "label": "typeName", "isRequired": true, @@ -20580,6 +20637,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionType.getFromFn.$1", "type": "string", "label": "typeName", "isRequired": true, @@ -20618,6 +20676,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionType.castsTo.$1", "type": "Any", "label": "value", "isRequired": true, @@ -20648,6 +20707,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionType.castsFrom.$1", "type": "Any", "label": "value", "isRequired": true, @@ -20678,6 +20738,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionType.to.$1", "type": "Any", "label": "value", "isRequired": true, @@ -20691,6 +20752,7 @@ } }, { + "id": "def-common.ExpressionType.to.$2", "type": "string", "label": "toTypeName", "isRequired": true, @@ -20704,6 +20766,7 @@ } }, { + "id": "def-common.ExpressionType.to.$3", "type": "Object", "label": "types", "isRequired": true, @@ -20750,6 +20813,7 @@ "type": "Function", "children": [ { + "id": "def-common.ExpressionType.from.$1", "type": "Any", "label": "value", "isRequired": true, @@ -20763,6 +20827,7 @@ } }, { + "id": "def-common.ExpressionType.from.$2", "type": "Object", "label": "types", "isRequired": true, @@ -20854,6 +20919,7 @@ "description": [], "children": [ { + "id": "def-common.FunctionsRegistry.Unnamed.$1", "type": "Object", "label": "executor", "isRequired": true, @@ -20907,6 +20973,7 @@ "description": [], "children": [ { + "id": "def-common.FunctionsRegistry.register.$1", "type": "CompoundType", "label": "functionDefinition", "isRequired": true, @@ -20960,6 +21027,7 @@ "description": [], "children": [ { + "id": "def-common.FunctionsRegistry.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -21071,6 +21139,7 @@ "description": [], "children": [ { + "id": "def-common.TablesAdapter.logDatatable.$1", "type": "string", "label": "name", "isRequired": true, @@ -21084,6 +21153,7 @@ } }, { + "id": "def-common.TablesAdapter.logDatatable.$2", "type": "Object", "label": "datatable", "isRequired": true, @@ -21182,6 +21252,7 @@ "description": [], "children": [ { + "id": "def-common.TypesRegistry.Unnamed.$1", "type": "Object", "label": "executor", "isRequired": true, @@ -21235,6 +21306,7 @@ "description": [], "children": [ { + "id": "def-common.TypesRegistry.register.$1", "type": "CompoundType", "label": "typeDefinition", "isRequired": true, @@ -21288,6 +21360,7 @@ "description": [], "children": [ { + "id": "def-common.TypesRegistry.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -21408,6 +21481,7 @@ ], "children": [ { + "id": "def-common.buildExpression.$1", "type": "CompoundType", "label": "initialState", "isRequired": false, @@ -21503,6 +21577,7 @@ ], "children": [ { + "id": "def-common.buildExpressionFunction.$1", "type": "Uncategorized", "label": "fnName", "isRequired": true, @@ -21525,6 +21600,7 @@ } }, { + "id": "def-common.buildExpressionFunction.$2", "type": "Object", "label": "initialArgs", "isRequired": true, @@ -21596,6 +21672,7 @@ ], "children": [ { + "id": "def-common.buildResultColumns.$1", "type": "Object", "label": "input", "isRequired": true, @@ -21617,6 +21694,7 @@ } }, { + "id": "def-common.buildResultColumns.$2", "type": "string", "label": "outputColumnId", "isRequired": true, @@ -21632,6 +21710,7 @@ } }, { + "id": "def-common.buildResultColumns.$3", "type": "string", "label": "inputColumnId", "isRequired": true, @@ -21647,6 +21726,7 @@ } }, { + "id": "def-common.buildResultColumns.$4", "type": "string", "label": "outputColumnName", "isRequired": false, @@ -21662,7 +21742,7 @@ } }, { - "id": "def-common.buildResultColumns.options", + "id": "def-common.buildResultColumns.$5.options", "type": "Object", "label": "options", "tags": [], @@ -21670,7 +21750,7 @@ "children": [ { "tags": [], - "id": "def-common.buildResultColumns.options.allowColumnOverwrite", + "id": "def-common.buildResultColumns.$5.options.allowColumnOverwrite", "type": "boolean", "label": "allowColumnOverwrite", "description": [], @@ -21699,6 +21779,7 @@ "type": "Function", "children": [ { + "id": "def-common.createError.$1", "type": "CompoundType", "label": "err", "isRequired": true, @@ -21769,6 +21850,7 @@ "type": "Function", "children": [ { + "id": "def-common.createExecutionContainer.$1", "type": "Object", "label": "state", "isRequired": true, @@ -21823,6 +21905,7 @@ "type": "Function", "children": [ { + "id": "def-common.createExecutorContainer.$1", "type": "Object", "label": "state", "isRequired": true, @@ -21925,6 +22008,7 @@ "description": [], "children": [ { + "id": "def-common.format.$1", "type": "Uncategorized", "label": "ast", "isRequired": true, @@ -21938,6 +22022,7 @@ } }, { + "id": "def-common.format.$2", "type": "Uncategorized", "label": "type", "isRequired": true, @@ -21987,6 +22072,7 @@ ], "children": [ { + "id": "def-common.formatExpression.$1", "type": "Object", "label": "ast", "isRequired": true, @@ -22028,6 +22114,7 @@ ], "children": [ { + "id": "def-common.getBucketIdentifier.$1", "type": "Object", "label": "row", "isRequired": true, @@ -22041,6 +22128,7 @@ } }, { + "id": "def-common.getBucketIdentifier.$2", "type": "Array", "label": "groupColumns", "isRequired": false, @@ -22074,6 +22162,7 @@ ], "children": [ { + "id": "def-common.getByAlias.$1", "type": "CompoundType", "label": "node", "isRequired": true, @@ -22087,6 +22176,7 @@ } }, { + "id": "def-common.getByAlias.$2", "type": "string", "label": "nodeName", "isRequired": true, @@ -22118,6 +22208,7 @@ "description": [], "children": [ { + "id": "def-common.getType.$1", "type": "Any", "label": "node", "isRequired": true, @@ -22144,6 +22235,7 @@ "type": "Function", "children": [ { + "id": "def-common.isDatatable.$1", "type": "Unknown", "label": "datatable", "isRequired": true, @@ -22191,6 +22283,7 @@ ], "children": [ { + "id": "def-common.isExpressionAstBuilder.$1", "type": "Any", "label": "val", "isRequired": true, @@ -22223,6 +22316,7 @@ "type": "Function", "children": [ { + "id": "def-common.isExpressionValueError.$1", "type": "Any", "label": "value", "isRequired": true, @@ -22298,6 +22392,7 @@ "description": [], "children": [ { + "id": "def-common.parse.$1", "type": "Uncategorized", "label": "expression", "isRequired": true, @@ -22311,6 +22406,7 @@ } }, { + "id": "def-common.parse.$2", "type": "Uncategorized", "label": "startRule", "isRequired": true, @@ -22351,6 +22447,7 @@ ], "children": [ { + "id": "def-common.parseExpression.$1", "type": "string", "label": "expression", "isRequired": true, @@ -22379,6 +22476,7 @@ "type": "Function", "children": [ { + "id": "def-common.serializeProvider.$1", "type": "Object", "label": "types", "isRequired": true, @@ -22439,6 +22537,7 @@ "description": [], "children": [ { + "id": "def-common.unboxExpressionValue.$1", "type": "CompoundType", "label": "{\n type,\n ...value\n}", "isRequired": true, @@ -23099,13 +23198,7 @@ "lineNumber": 83 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", " | undefined" ] } @@ -24745,6 +24838,7 @@ ], "children": [ { + "id": "def-common.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -24760,6 +24854,7 @@ } }, { + "id": "def-common.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", "label": "args", "isRequired": true, @@ -24775,6 +24870,7 @@ } }, { + "id": "def-common.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -25832,6 +25928,7 @@ "description": [], "children": [ { + "id": "def-common.IRegistry.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -27580,6 +27677,7 @@ "type": "Function", "children": [ { + "id": "def-common.boolean.from.number.$1", "type": "Any", "label": "n", "isRequired": true, @@ -27610,6 +27708,7 @@ "type": "Function", "children": [ { + "id": "def-common.boolean.from.string.$1", "type": "Any", "label": "s", "isRequired": true, @@ -27653,6 +27752,7 @@ "type": "Function", "children": [ { + "id": "def-common.boolean.to.render.$1", "type": "boolean", "label": "value", "isRequired": true, @@ -27691,6 +27791,7 @@ "type": "Function", "children": [ { + "id": "def-common.boolean.to.datatable.$1", "type": "boolean", "label": "value", "isRequired": true, @@ -27817,6 +27918,7 @@ "type": "Function", "children": [ { + "id": "def-common.clog.fn.$1", "type": "Unknown", "label": "input", "isRequired": true, @@ -28177,6 +28279,7 @@ "description": [], "children": [ { + "id": "def-common.cumulativeSum.fn.$1", "type": "Object", "label": "input", "isRequired": true, @@ -28196,6 +28299,7 @@ } }, { + "id": "def-common.cumulativeSum.fn.$2", "type": "Object", "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", "isRequired": true, @@ -28257,6 +28361,7 @@ "type": "Function", "children": [ { + "id": "def-common.datatable.validate.$1", "type": "Any", "label": "table", "isRequired": true, @@ -28287,6 +28392,7 @@ "type": "Function", "children": [ { + "id": "def-common.datatable.serialize.$1", "type": "Object", "label": "table", "isRequired": true, @@ -28339,6 +28445,7 @@ "type": "Function", "children": [ { + "id": "def-common.datatable.deserialize.$1", "type": "Object", "label": "table", "isRequired": true, @@ -28412,6 +28519,7 @@ "type": "Function", "children": [ { + "id": "def-common.datatable.from.pointseries.$1", "type": "CompoundType", "label": "value", "isRequired": true, @@ -28486,6 +28594,7 @@ "type": "Function", "children": [ { + "id": "def-common.datatable.to.render.$1", "type": "Object", "label": "table", "isRequired": true, @@ -28538,6 +28647,7 @@ "type": "Function", "children": [ { + "id": "def-common.datatable.to.pointseries.$1", "type": "Object", "label": "table", "isRequired": true, @@ -28986,6 +29096,7 @@ "description": [], "children": [ { + "id": "def-common.derivative.fn.$1", "type": "Object", "label": "input", "isRequired": true, @@ -29005,6 +29116,7 @@ } }, { + "id": "def-common.derivative.fn.$2", "type": "Object", "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", "isRequired": true, @@ -29086,6 +29198,7 @@ "type": "Function", "children": [ { + "id": "def-common.error.to.render.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -29200,6 +29313,7 @@ "type": "Function", "children": [ { + "id": "def-common.executionPureTransitions.start.$1", "type": "Object", "label": "state", "isRequired": true, @@ -29269,6 +29383,7 @@ "type": "Function", "children": [ { + "id": "def-common.executionPureTransitions.setResult.$1", "type": "Object", "label": "state", "isRequired": true, @@ -29338,6 +29453,7 @@ "type": "Function", "children": [ { + "id": "def-common.executionPureTransitions.setError.$1", "type": "Object", "label": "state", "isRequired": true, @@ -30034,6 +30150,7 @@ "type": "Function", "children": [ { + "id": "def-common.font.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -30047,6 +30164,7 @@ } }, { + "id": "def-common.font.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -30178,6 +30296,7 @@ "type": "Function", "children": [ { + "id": "def-common.image.to.render.$1", "type": "Object", "label": "input", "isRequired": true, @@ -30633,6 +30752,7 @@ "type": "Function", "children": [ { + "id": "def-common.mapColumn.fn.$1", "type": "Object", "label": "input", "isRequired": true, @@ -30652,6 +30772,7 @@ } }, { + "id": "def-common.mapColumn.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -30896,6 +31017,7 @@ "type": "Function", "children": [ { + "id": "def-common.math.fn.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -30915,6 +31037,7 @@ } }, { + "id": "def-common.math.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -31346,6 +31469,7 @@ "description": [], "children": [ { + "id": "def-common.movingAverage.fn.$1", "type": "Object", "label": "input", "isRequired": true, @@ -31365,6 +31489,7 @@ } }, { + "id": "def-common.movingAverage.fn.$2", "type": "Object", "label": "{ by, inputColumnId, outputColumnId, outputColumnName, window }", "isRequired": true, @@ -31442,7 +31567,7 @@ "tags": [], "children": [ { - "id": "def-common.nullType.from.'*'", + "id": "def-common.nullType.from.", "type": "Function", "children": [], "signature": [ @@ -31519,6 +31644,7 @@ "type": "Function", "children": [ { + "id": "def-common.num.from.boolean.$1", "type": "Any", "label": "b", "isRequired": true, @@ -31549,6 +31675,7 @@ "type": "Function", "children": [ { + "id": "def-common.num.from.string.$1", "type": "Any", "label": "n", "isRequired": true, @@ -31575,10 +31702,11 @@ "returnComment": [] }, { - "id": "def-common.num.from.'*'", + "id": "def-common.num.from.", "type": "Function", "children": [ { + "id": "def-common.num.from..$1", "type": "Any", "label": "value", "isRequired": true, @@ -31622,6 +31750,7 @@ "type": "Function", "children": [ { + "id": "def-common.num.to.render.$1", "type": "CompoundType", "label": "{ value }", "isRequired": true, @@ -31675,6 +31804,7 @@ "type": "Function", "children": [ { + "id": "def-common.num.to.datatable.$1", "type": "CompoundType", "label": "{ value }", "isRequired": true, @@ -31784,6 +31914,7 @@ "type": "Function", "children": [ { + "id": "def-common.number.from.boolean.$1", "type": "Any", "label": "b", "isRequired": true, @@ -31814,6 +31945,7 @@ "type": "Function", "children": [ { + "id": "def-common.number.from.string.$1", "type": "Any", "label": "n", "isRequired": true, @@ -31857,6 +31989,7 @@ "type": "Function", "children": [ { + "id": "def-common.number.to.render.$1", "type": "number", "label": "value", "isRequired": true, @@ -31895,6 +32028,7 @@ "type": "Function", "children": [ { + "id": "def-common.number.to.datatable.$1", "type": "number", "label": "value", "isRequired": true, @@ -32047,6 +32181,7 @@ "type": "Function", "children": [ { + "id": "def-common.pointseries.to.render.$1", "type": "CompoundType", "label": "pseries", "isRequired": true, @@ -32075,6 +32210,7 @@ } }, { + "id": "def-common.pointseries.to.render.$2", "type": "Object", "label": "types", "isRequired": true, @@ -32159,6 +32295,7 @@ "type": "Function", "children": [ { + "id": "def-common.pureSelectors.getFunction.$1", "type": "Object", "label": "state", "isRequired": true, @@ -32211,6 +32348,7 @@ "type": "Function", "children": [ { + "id": "def-common.pureSelectors.getType.$1", "type": "Object", "label": "state", "isRequired": true, @@ -32263,6 +32401,7 @@ "type": "Function", "children": [ { + "id": "def-common.pureSelectors.getContext.$1", "type": "Object", "label": "{ context }", "isRequired": true, @@ -32322,6 +32461,7 @@ "type": "Function", "children": [ { + "id": "def-common.pureTransitions.addFunction.$1", "type": "Object", "label": "state", "isRequired": true, @@ -32391,6 +32531,7 @@ "type": "Function", "children": [ { + "id": "def-common.pureTransitions.addType.$1", "type": "Object", "label": "state", "isRequired": true, @@ -32460,6 +32601,7 @@ "type": "Function", "children": [ { + "id": "def-common.pureTransitions.extendContext.$1", "type": "Object", "label": "state", "isRequired": true, @@ -32590,6 +32732,7 @@ "type": "Function", "children": [ { + "id": "def-common.range.to.render.$1", "type": "Object", "label": "value", "isRequired": true, @@ -32679,10 +32822,11 @@ "tags": [], "children": [ { - "id": "def-common.render.from.'*'", + "id": "def-common.render.from.", "type": "Function", "children": [ { + "id": "def-common.render.from..$1", "type": "Uncategorized", "label": "v", "isRequired": true, @@ -32762,6 +32906,7 @@ "type": "Function", "children": [ { + "id": "def-common.shape.to.render.$1", "type": "CompoundType", "label": "input", "isRequired": true, @@ -32872,6 +33017,7 @@ "type": "Function", "children": [ { + "id": "def-common.string.from.boolean.$1", "type": "Any", "label": "b", "isRequired": true, @@ -32902,6 +33048,7 @@ "type": "Function", "children": [ { + "id": "def-common.string.from.number.$1", "type": "Any", "label": "n", "isRequired": true, @@ -32945,6 +33092,7 @@ "type": "Function", "children": [ { + "id": "def-common.string.to.render.$1", "type": "Uncategorized", "label": "text", "isRequired": true, @@ -32983,6 +33131,7 @@ "type": "Function", "children": [ { + "id": "def-common.string.to.datatable.$1", "type": "string", "label": "value", "isRequired": true, @@ -33255,6 +33404,7 @@ "type": "Function", "children": [ { + "id": "def-common.theme.fn.$1", "type": "Uncategorized", "label": "input", "isRequired": true, @@ -33268,6 +33418,7 @@ } }, { + "id": "def-common.theme.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -33281,6 +33432,7 @@ } }, { + "id": "def-common.theme.fn.$3", "type": "Object", "label": "handlers", "isRequired": true, @@ -33301,13 +33453,7 @@ "text": "Adapters" }, ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", ">" ], "description": [], @@ -33335,13 +33481,7 @@ "text": "Adapters" }, ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", ">) => any" ], "description": [], @@ -33493,18 +33633,13 @@ "text": "Adapters" }, ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", ">) => any" ], "description": [], "children": [ { + "id": "def-common.variable.fn.$1", "type": "Unknown", "label": "input", "isRequired": true, @@ -33518,6 +33653,7 @@ } }, { + "id": "def-common.variable.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -33531,6 +33667,7 @@ } }, { + "id": "def-common.variable.fn.$3", "type": "Object", "label": "context", "isRequired": true, @@ -33551,13 +33688,7 @@ "text": "Adapters" }, ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", ">" ], "description": [], @@ -33752,18 +33883,13 @@ "text": "Adapters" }, ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", ">) => unknown" ], "description": [], "children": [ { + "id": "def-common.variableSet.fn.$1", "type": "Unknown", "label": "input", "isRequired": true, @@ -33777,6 +33903,7 @@ } }, { + "id": "def-common.variableSet.fn.$2", "type": "Object", "label": "args", "isRequired": true, @@ -33790,6 +33917,7 @@ } }, { + "id": "def-common.variableSet.fn.$3", "type": "Object", "label": "context", "isRequired": true, @@ -33810,13 +33938,7 @@ "text": "Adapters" }, ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, + "SerializableState", ">" ], "description": [], diff --git a/api_docs/features.json b/api_docs/features.json index 967dd11ffca3..3755e99beb3b 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -40,6 +40,7 @@ "description": [], "children": [ { + "id": "def-public.KibanaFeature.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -52,7 +53,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: 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<{ 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: \"read\" | \"all\" | \"none\"; 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; }>" ], "description": [], "source": { @@ -456,13 +457,7 @@ "lineNumber": 40 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.AppCategory", - "text": "AppCategory" - } + "AppCategory" ] }, { @@ -665,13 +660,7 @@ }, "signature": [ "{ description: string; privileges: readonly ", - { - "pluginId": "features", - "scope": "common", - "docId": "kibFeaturesPluginApi", - "section": "def-common.ReservedKibanaPrivilege", - "text": "ReservedKibanaPrivilege" - }, + "ReservedKibanaPrivilege", "[]; } | undefined" ] } @@ -755,7 +744,7 @@ "section": "def-common.FeatureKibanaPrivileges", "text": "FeatureKibanaPrivileges" }, - ", \"management\" | \"catalogue\" | \"ui\" | \"alerting\" | \"app\" | \"api\" | \"savedObject\">" + ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"app\" | \"api\" | \"savedObject\">" ], "description": [ "\nConfiguration for a sub-feature privilege." @@ -891,6 +880,7 @@ "description": [], "children": [ { + "id": "def-server.ElasticsearchFeature.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -1058,6 +1048,7 @@ "description": [], "children": [ { + "id": "def-server.KibanaFeature.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -1070,7 +1061,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: 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<{ 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: \"read\" | \"all\" | \"none\"; 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; }>" ], "description": [], "source": { @@ -1646,13 +1637,7 @@ "lineNumber": 40 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.AppCategory", - "text": "AppCategory" - } + "AppCategory" ] }, { @@ -1855,13 +1840,7 @@ }, "signature": [ "{ description: string; privileges: readonly ", - { - "pluginId": "features", - "scope": "common", - "docId": "kibFeaturesPluginApi", - "section": "def-common.ReservedKibanaPrivilege", - "text": "ReservedKibanaPrivilege" - }, + "ReservedKibanaPrivilege", "[]; } | undefined" ] } @@ -1899,6 +1878,7 @@ "description": [], "children": [ { + "id": "def-server.PluginSetupContract.registerKibanaFeature.$1", "type": "Object", "label": "feature", "isRequired": true, @@ -1943,6 +1923,7 @@ "description": [], "children": [ { + "id": "def-server.PluginSetupContract.registerElasticsearchFeature.$1", "type": "Object", "label": "feature", "isRequired": true, @@ -2023,13 +2004,7 @@ "label": "getFeaturesUICapabilities", "signature": [ "() => ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - } + "Capabilities" ], "description": [], "children": [], @@ -2149,6 +2124,7 @@ "description": [], "children": [ { + "id": "def-common.ElasticsearchFeature.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -2316,6 +2292,7 @@ "description": [], "children": [ { + "id": "def-common.KibanaFeature.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -2328,7 +2305,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: 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<{ 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: \"read\" | \"all\" | \"none\"; 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; }>" ], "description": [], "source": { @@ -2550,6 +2527,7 @@ "description": [], "children": [ { + "id": "def-common.SubFeature.Unnamed.$1", "type": "Object", "label": "config", "isRequired": true, @@ -2562,7 +2540,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: 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[]; }>; }>[]; }>[]; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; 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[]; }>; }>[]; }>[]; }>" ], "description": [], "source": { @@ -2608,7 +2586,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: 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[]; }>; }>[]; }>[]" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; 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[]; }>; }>[]; }>[]" ] }, { @@ -2624,7 +2602,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: 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[]; }>; }>[]; }>[]; }" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; 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[]; }>; }>[]; }>[]; }" ], "description": [], "children": [], @@ -3013,13 +2991,7 @@ "lineNumber": 40 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.AppCategory", - "text": "AppCategory" - } + "AppCategory" ] }, { @@ -3222,13 +3194,7 @@ }, "signature": [ "{ description: string; privileges: readonly ", - { - "pluginId": "features", - "scope": "common", - "docId": "kibFeaturesPluginApi", - "section": "def-common.ReservedKibanaPrivilege", - "text": "ReservedKibanaPrivilege" - }, + "ReservedKibanaPrivilege", "[]; } | undefined" ] } @@ -3312,7 +3278,7 @@ "section": "def-common.FeatureKibanaPrivileges", "text": "FeatureKibanaPrivileges" }, - ", \"management\" | \"catalogue\" | \"ui\" | \"alerting\" | \"app\" | \"api\" | \"savedObject\">" + ", \"management\" | \"catalogue\" | \"alerting\" | \"ui\" | \"app\" | \"api\" | \"savedObject\">" ], "description": [ "\nConfiguration for a sub-feature privilege." diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json index 6a624f87bfcd..09b3b11040a6 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -19,7 +19,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 21 + "lineNumber": 26 }, "signature": [ { @@ -39,7 +39,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 22 + "lineNumber": 27 }, "signature": [ { @@ -55,7 +55,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 20 + "lineNumber": 25 }, "initialIsOpen": false }, @@ -145,13 +145,13 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 93 + "lineNumber": 100 } } ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, "initialIsOpen": false }, @@ -170,7 +170,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 14 + "lineNumber": 16 } }, { @@ -181,7 +181,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 15 + "lineNumber": 17 }, "signature": [ "(geojsonFile: GeoJSON.FeatureCollection, name: string, previewCoverage: number) => void" @@ -195,7 +195,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 16 + "lineNumber": 18 }, "signature": [ "() => void" @@ -209,7 +209,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 17 + "lineNumber": 19 }, "signature": [ "(indexReady: boolean) => void" @@ -223,7 +223,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 18 + "lineNumber": 20 }, "signature": [ "(results: { indexDataResp: ", @@ -253,7 +253,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 22 + "lineNumber": 24 }, "signature": [ "() => void" @@ -262,7 +262,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 13 + "lineNumber": 15 }, "initialIsOpen": false }, @@ -281,7 +281,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 26 + "lineNumber": 31 } }, { @@ -292,7 +292,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 27 + "lineNumber": 32 } }, { @@ -303,7 +303,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 28 + "lineNumber": 33 } }, { @@ -314,7 +314,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 29 + "lineNumber": 34 } }, { @@ -325,7 +325,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 30 + "lineNumber": 35 }, "signature": [ "{ [fieldName: string]: { count: number; cardinality: number; top_hits: { count: number; value: any; }[]; mean_value?: number | undefined; median_value?: number | undefined; max_value?: number | undefined; min_value?: number | undefined; earliest?: string | undefined; latest?: string | undefined; }; }" @@ -339,7 +339,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 43 + "lineNumber": 48 } }, { @@ -350,7 +350,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 44 + "lineNumber": 49 } }, { @@ -361,7 +361,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 45 + "lineNumber": 50 }, "signature": [ "{ properties: { [fieldName: string]: { type: ", @@ -414,7 +414,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 58 + "lineNumber": 63 } }, { @@ -425,7 +425,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 59 + "lineNumber": 64 } }, { @@ -436,7 +436,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 60 + "lineNumber": 65 } }, { @@ -447,7 +447,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 61 + "lineNumber": 66 } }, { @@ -458,7 +458,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 62 + "lineNumber": 67 }, "signature": [ "string[] | undefined" @@ -472,7 +472,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 63 + "lineNumber": 68 }, "signature": [ "string[] | undefined" @@ -486,7 +486,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 64 + "lineNumber": 69 }, "signature": [ "string | undefined" @@ -500,7 +500,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 65 + "lineNumber": 70 }, "signature": [ "string | undefined" @@ -514,7 +514,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 66 + "lineNumber": 71 }, "signature": [ "string | undefined" @@ -528,7 +528,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 67 + "lineNumber": 72 }, "signature": [ "string[] | undefined" @@ -542,7 +542,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 68 + "lineNumber": 73 }, "signature": [ "string[] | undefined" @@ -556,7 +556,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 69 + "lineNumber": 74 }, "signature": [ "string | undefined" @@ -570,7 +570,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 70 + "lineNumber": 75 }, "signature": [ "boolean | undefined" @@ -579,7 +579,32 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 25 + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-public.HasImportPermission", + "type": "Interface", + "label": "HasImportPermission", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.HasImportPermission.hasImportPermission", + "type": "boolean", + "label": "hasImportPermission", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 12 + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 11 }, "initialIsOpen": false }, @@ -600,6 +625,7 @@ "description": [], "children": [ { + "id": "def-public.IImporter.read.$1", "type": "Object", "label": "data", "isRequired": true, @@ -662,6 +688,7 @@ "description": [], "children": [ { + "id": "def-public.IImporter.initializeImport.$1", "type": "string", "label": "index", "isRequired": true, @@ -675,6 +702,7 @@ } }, { + "id": "def-public.IImporter.initializeImport.$2", "type": "Object", "label": "settings", "isRequired": true, @@ -694,6 +722,7 @@ } }, { + "id": "def-public.IImporter.initializeImport.$3", "type": "Object", "label": "mappings", "isRequired": true, @@ -713,6 +742,7 @@ } }, { + "id": "def-public.IImporter.initializeImport.$4", "type": "Object", "label": "pipeline", "isRequired": true, @@ -757,6 +787,7 @@ "description": [], "children": [ { + "id": "def-public.IImporter.import.$1", "type": "string", "label": "id", "isRequired": true, @@ -770,6 +801,7 @@ } }, { + "id": "def-public.IImporter.import.$2", "type": "string", "label": "index", "isRequired": true, @@ -783,6 +815,7 @@ } }, { + "id": "def-public.IImporter.import.$3", "type": "string", "label": "pipelineId", "isRequired": false, @@ -796,6 +829,7 @@ } }, { + "id": "def-public.IImporter.import.$4", "type": "Function", "label": "setImportProgress", "isRequired": true, @@ -974,7 +1008,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 87 + "lineNumber": 94 } }, { @@ -985,7 +1019,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 88 + "lineNumber": 95 } }, { @@ -996,7 +1030,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 89 + "lineNumber": 96 }, "signature": [ { @@ -1011,7 +1045,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 86 + "lineNumber": 93 }, "initialIsOpen": false }, @@ -1030,7 +1064,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 76 + "lineNumber": 81 } }, { @@ -1041,7 +1075,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 77 + "lineNumber": 82 } }, { @@ -1052,7 +1086,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 78 + "lineNumber": 83 }, "signature": [ "string | undefined" @@ -1066,7 +1100,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 79 + "lineNumber": 84 }, "signature": [ "string | undefined" @@ -1080,7 +1114,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 80 + "lineNumber": 85 } }, { @@ -1091,7 +1125,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 81 + "lineNumber": 86 }, "signature": [ { @@ -1107,15 +1141,17 @@ { "tags": [], "id": "def-public.ImportResponse.error", - "type": "Any", + "type": "Object", "label": "error", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 82 + "lineNumber": 87 }, "signature": [ - "any" + "{ error: ", + "ErrorCause", + "; } | undefined" ] }, { @@ -1126,7 +1162,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 83 + "lineNumber": 90 }, "signature": [ "boolean | undefined" @@ -1135,7 +1171,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 75 + "lineNumber": 80 }, "initialIsOpen": false }, @@ -1228,7 +1264,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 120 + "lineNumber": 127 } }, { @@ -1239,7 +1275,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 121 + "lineNumber": 128 }, "signature": [ "any[]" @@ -1248,7 +1284,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 119 + "lineNumber": 126 }, "initialIsOpen": false }, @@ -1267,7 +1303,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 115 + "lineNumber": 122 } }, { @@ -1278,7 +1314,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 116 + "lineNumber": 123 }, "signature": [ { @@ -1293,7 +1329,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, "initialIsOpen": false }, @@ -1312,7 +1348,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 + "lineNumber": 16 }, "signature": [ "any" @@ -1321,7 +1357,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 10 + "lineNumber": 15 }, "initialIsOpen": false }, @@ -1340,7 +1376,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 106 + "lineNumber": 113 }, "signature": [ "{ created_by: string; } | undefined" @@ -1354,7 +1390,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 109 + "lineNumber": 116 }, "signature": [ "{ [key: string]: any; }" @@ -1363,7 +1399,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 105 + "lineNumber": 112 }, "initialIsOpen": false }, @@ -1382,7 +1418,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 99 + "lineNumber": 106 }, "signature": [ "string | undefined" @@ -1396,7 +1432,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 100 + "lineNumber": 107 } }, { @@ -1407,7 +1443,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 101 + "lineNumber": 108 }, "signature": [ "any[]" @@ -1421,7 +1457,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 102 + "lineNumber": 109 }, "signature": [ "any" @@ -1430,7 +1466,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 98 + "lineNumber": 105 }, "initialIsOpen": false } @@ -1475,7 +1511,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 14 + "lineNumber": 19 }, "signature": [ "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" @@ -1490,7 +1526,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 96 + "lineNumber": 103 }, "signature": [ "string | object | ", @@ -1527,7 +1563,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 73 + "lineNumber": 78 }, "signature": [ "any[]" @@ -1601,7 +1637,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/plugin.ts", - "lineNumber": 21 + "lineNumber": 26 }, "signature": [ "FileUploadStartApi" @@ -1637,7 +1673,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 21 + "lineNumber": 26 }, "signature": [ { @@ -1657,7 +1693,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 22 + "lineNumber": 27 }, "signature": [ { @@ -1673,7 +1709,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 20 + "lineNumber": 25 }, "initialIsOpen": false }, @@ -1692,13 +1728,13 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 93 + "lineNumber": 100 } } ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, "initialIsOpen": false }, @@ -1717,7 +1753,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 26 + "lineNumber": 31 } }, { @@ -1728,7 +1764,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 27 + "lineNumber": 32 } }, { @@ -1739,7 +1775,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 28 + "lineNumber": 33 } }, { @@ -1750,7 +1786,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 29 + "lineNumber": 34 } }, { @@ -1761,7 +1797,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 30 + "lineNumber": 35 }, "signature": [ "{ [fieldName: string]: { count: number; cardinality: number; top_hits: { count: number; value: any; }[]; mean_value?: number | undefined; median_value?: number | undefined; max_value?: number | undefined; min_value?: number | undefined; earliest?: string | undefined; latest?: string | undefined; }; }" @@ -1775,7 +1811,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 43 + "lineNumber": 48 } }, { @@ -1786,7 +1822,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 44 + "lineNumber": 49 } }, { @@ -1797,7 +1833,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 45 + "lineNumber": 50 }, "signature": [ "{ properties: { [fieldName: string]: { type: ", @@ -1850,7 +1886,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 58 + "lineNumber": 63 } }, { @@ -1861,7 +1897,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 59 + "lineNumber": 64 } }, { @@ -1872,7 +1908,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 60 + "lineNumber": 65 } }, { @@ -1883,7 +1919,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 61 + "lineNumber": 66 } }, { @@ -1894,7 +1930,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 62 + "lineNumber": 67 }, "signature": [ "string[] | undefined" @@ -1908,7 +1944,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 63 + "lineNumber": 68 }, "signature": [ "string[] | undefined" @@ -1922,7 +1958,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 64 + "lineNumber": 69 }, "signature": [ "string | undefined" @@ -1936,7 +1972,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 65 + "lineNumber": 70 }, "signature": [ "string | undefined" @@ -1950,7 +1986,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 66 + "lineNumber": 71 }, "signature": [ "string | undefined" @@ -1964,7 +2000,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 67 + "lineNumber": 72 }, "signature": [ "string[] | undefined" @@ -1978,7 +2014,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 68 + "lineNumber": 73 }, "signature": [ "string[] | undefined" @@ -1992,7 +2028,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 69 + "lineNumber": 74 }, "signature": [ "string | undefined" @@ -2006,7 +2042,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 70 + "lineNumber": 75 }, "signature": [ "boolean | undefined" @@ -2015,7 +2051,32 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 25 + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-common.HasImportPermission", + "type": "Interface", + "label": "HasImportPermission", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.HasImportPermission.hasImportPermission", + "type": "boolean", + "label": "hasImportPermission", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 12 + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 11 }, "initialIsOpen": false }, @@ -2034,7 +2095,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 87 + "lineNumber": 94 } }, { @@ -2045,7 +2106,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 88 + "lineNumber": 95 } }, { @@ -2056,7 +2117,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 89 + "lineNumber": 96 }, "signature": [ { @@ -2071,7 +2132,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 86 + "lineNumber": 93 }, "initialIsOpen": false }, @@ -2090,7 +2151,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 76 + "lineNumber": 81 } }, { @@ -2101,7 +2162,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 77 + "lineNumber": 82 } }, { @@ -2112,7 +2173,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 78 + "lineNumber": 83 }, "signature": [ "string | undefined" @@ -2126,7 +2187,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 79 + "lineNumber": 84 }, "signature": [ "string | undefined" @@ -2140,7 +2201,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 80 + "lineNumber": 85 } }, { @@ -2151,7 +2212,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 81 + "lineNumber": 86 }, "signature": [ { @@ -2167,15 +2228,17 @@ { "tags": [], "id": "def-common.ImportResponse.error", - "type": "Any", + "type": "Object", "label": "error", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 82 + "lineNumber": 87 }, "signature": [ - "any" + "{ error: ", + "ErrorCause", + "; } | undefined" ] }, { @@ -2186,7 +2249,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 83 + "lineNumber": 90 }, "signature": [ "boolean | undefined" @@ -2195,7 +2258,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 75 + "lineNumber": 80 }, "initialIsOpen": false }, @@ -2214,7 +2277,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 120 + "lineNumber": 127 } }, { @@ -2225,7 +2288,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 121 + "lineNumber": 128 }, "signature": [ "any[]" @@ -2234,7 +2297,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 119 + "lineNumber": 126 }, "initialIsOpen": false }, @@ -2253,7 +2316,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 115 + "lineNumber": 122 } }, { @@ -2264,7 +2327,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 116 + "lineNumber": 123 }, "signature": [ { @@ -2279,7 +2342,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, "initialIsOpen": false }, @@ -2298,7 +2361,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 + "lineNumber": 16 }, "signature": [ "any" @@ -2307,7 +2370,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 10 + "lineNumber": 15 }, "initialIsOpen": false }, @@ -2326,7 +2389,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 106 + "lineNumber": 113 }, "signature": [ "{ created_by: string; } | undefined" @@ -2340,7 +2403,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 109 + "lineNumber": 116 }, "signature": [ "{ [key: string]: any; }" @@ -2349,7 +2412,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 105 + "lineNumber": 112 }, "initialIsOpen": false }, @@ -2368,7 +2431,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 99 + "lineNumber": 106 }, "signature": [ "string | undefined" @@ -2382,7 +2445,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 100 + "lineNumber": 107 } }, { @@ -2393,7 +2456,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 101 + "lineNumber": 108 }, "signature": [ "any[]" @@ -2407,7 +2470,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 102 + "lineNumber": 109 }, "signature": [ "any" @@ -2416,7 +2479,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 98 + "lineNumber": 105 }, "initialIsOpen": false } @@ -2461,7 +2524,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 14 + "lineNumber": 19 }, "signature": [ "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" @@ -2476,7 +2539,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 96 + "lineNumber": 103 }, "signature": [ "string | object | ", @@ -2513,7 +2576,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 73 + "lineNumber": 78 }, "signature": [ "any[]" diff --git a/api_docs/fleet.json b/api_docs/fleet.json index 60d0dca4d8a1..a0f9d248fc94 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.pkgKeyFromPackageInfo.$1", "type": "Uncategorized", "label": "packageInfo", "isRequired": true, @@ -1042,17 +1043,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.integration_details_overview.$1", "type": "Object", "label": "{ pkgkey }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1063,13 +1059,7 @@ ], "signature": [ "({ pkgkey }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1086,17 +1076,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.integration_details_policies.$1", "type": "Object", "label": "{ pkgkey }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1107,13 +1092,7 @@ ], "signature": [ "({ pkgkey }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1130,17 +1109,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.integration_details_settings.$1", "type": "Object", "label": "{ pkgkey }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1151,13 +1125,7 @@ ], "signature": [ "({ pkgkey }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1174,17 +1142,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.integration_details_custom.$1", "type": "Object", "label": "{ pkgkey }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1195,13 +1158,7 @@ ], "signature": [ "({ pkgkey }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1218,17 +1175,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.integration_policy_edit.$1", "type": "Object", "label": "{ packagePolicyId }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1239,13 +1191,7 @@ ], "signature": [ "({ packagePolicyId }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1294,17 +1240,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.policy_details.$1", "type": "Object", "label": "{ policyId, tabId }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1315,13 +1256,7 @@ ], "signature": [ "({ policyId, tabId }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1338,17 +1273,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.add_integration_from_policy.$1", "type": "Object", "label": "{ policyId }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1359,13 +1289,7 @@ ], "signature": [ "({ policyId }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1382,17 +1306,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.add_integration_to_policy.$1", "type": "Object", "label": "{ pkgkey }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1403,13 +1322,7 @@ ], "signature": [ "({ pkgkey }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1426,17 +1339,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.edit_integration.$1", "type": "Object", "label": "{ policyId, packagePolicyId }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1447,13 +1355,7 @@ ], "signature": [ "({ policyId, packagePolicyId }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1486,17 +1388,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.fleet_agent_list.$1", "type": "Object", "label": "{ kuery }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1507,13 +1404,7 @@ ], "signature": [ "({ kuery }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1530,17 +1421,12 @@ "type": "Function", "children": [ { + "id": "def-public.pagePathGetters.fleet_agent_details.$1", "type": "Object", "label": "{ agentId, tabId, logQuery }", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - } + "DynamicPagePathValues" ], "description": [], "source": { @@ -1551,13 +1437,7 @@ ], "signature": [ "({ agentId, tabId, logQuery }: ", - { - "pluginId": "fleet", - "scope": "public", - "docId": "kibFleetPluginApi", - "section": "def-public.DynamicPagePathValues", - "text": "DynamicPagePathValues" - }, + "DynamicPagePathValues", ") => string" ], "description": [], @@ -1727,6 +1607,7 @@ "type": "Function", "children": [ { + "id": "def-server.relativeDownloadUrlFromArtifact.$1", "type": "Uncategorized", "label": "{\n identifier,\n decodedSha256,\n}", "isRequired": true, @@ -1789,7 +1670,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, id: string, withPackagePolicies?: boolean) => Promise<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, id: string, withPackagePolicies?: boolean) => Promise<", { "pluginId": "fleet", "scope": "common", @@ -1819,7 +1700,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ", { "pluginId": "fleet", "scope": "common", @@ -1849,7 +1730,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">) => Promise" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise" ] }, { @@ -1871,7 +1752,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<", { "pluginId": "fleet", "scope": "common", @@ -1912,13 +1793,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.getAgentById", - "text": "getAgentById" - } + "getAgentById" ] }, { @@ -1957,6 +1832,7 @@ ], "children": [ { + "id": "def-server.AgentService.authenticateAgentWithAccessToken.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1976,6 +1852,7 @@ } }, { + "id": "def-server.AgentService.authenticateAgentWithAccessToken.$2", "type": "Object", "label": "request", "isRequired": true, @@ -2031,6 +1908,7 @@ ], "children": [ { + "id": "def-server.AgentService.getAgentStatusById.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -2050,6 +1928,7 @@ } }, { + "id": "def-server.AgentService.getAgentStatusById.$2", "type": "string", "label": "agentId", "isRequired": true, @@ -2084,13 +1963,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.getAgentsByKuery", - "text": "getAgentsByKuery" - } + "getAgentsByKuery" ] } ], @@ -2174,6 +2047,7 @@ "description": [], "children": [ { + "id": "def-server.ArtifactsClientInterface.getArtifact.$1", "type": "string", "label": "id", "isRequired": true, @@ -2200,13 +2074,7 @@ "label": "createArtifact", "signature": [ "(options: ", - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.ArtifactsClientCreateOptions", - "text": "ArtifactsClientCreateOptions" - }, + "ArtifactsClientCreateOptions", ") => Promise<", { "pluginId": "fleet", @@ -2220,17 +2088,12 @@ "description": [], "children": [ { + "id": "def-server.ArtifactsClientInterface.createArtifact.$1", "type": "CompoundType", "label": "options", "isRequired": true, "signature": [ - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.ArtifactsClientCreateOptions", - "text": "ArtifactsClientCreateOptions" - } + "ArtifactsClientCreateOptions" ], "description": [], "source": { @@ -2256,6 +2119,7 @@ "description": [], "children": [ { + "id": "def-server.ArtifactsClientInterface.deleteArtifact.$1", "type": "string", "label": "id", "isRequired": true, @@ -2282,13 +2146,7 @@ "label": "listArtifacts", "signature": [ "(options?: ", - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.ListArtifactsProps", - "text": "ListArtifactsProps" - }, + "ListArtifactsProps", " | undefined) => Promise<", { "pluginId": "fleet", @@ -2310,17 +2168,12 @@ "description": [], "children": [ { + "id": "def-server.ArtifactsClientInterface.listArtifacts.$1", "type": "CompoundType", "label": "options", "isRequired": false, "signature": [ - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.ListArtifactsProps", - "text": "ListArtifactsProps" - }, + "ListArtifactsProps", " | undefined" ], "description": [], @@ -2355,6 +2208,7 @@ "description": [], "children": [ { + "id": "def-server.ArtifactsClientInterface.encodeContent.$1", "type": "string", "label": "content", "isRequired": true, @@ -2385,6 +2239,7 @@ "description": [], "children": [ { + "id": "def-server.ArtifactsClientInterface.generateHash.$1", "type": "string", "label": "content", "isRequired": true, @@ -2434,11 +2289,12 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, pkgName: string, datasetPath: string) => Promise" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, pkgName: string, datasetPath: string) => Promise" ], "description": [], "children": [ { + "id": "def-server.ESIndexPatternService.getESIndexPattern.$1", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -2451,7 +2307,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "description": [], "source": { @@ -2460,6 +2316,7 @@ } }, { + "id": "def-server.ESIndexPatternService.getESIndexPattern.$2", "type": "string", "label": "pkgName", "isRequired": true, @@ -2473,6 +2330,7 @@ } }, { + "id": "def-server.ESIndexPatternService.getESIndexPattern.$3", "type": "string", "label": "datasetPath", "isRequired": true, @@ -2515,7 +2373,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 96 }, "signature": [ { @@ -2535,7 +2393,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 96 + "lineNumber": 97 }, "signature": [ { @@ -2556,7 +2414,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 97 + "lineNumber": 98 }, "signature": [ { @@ -2577,7 +2435,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 98 + "lineNumber": 99 }, "signature": [ { @@ -2597,7 +2455,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 99 + "lineNumber": 100 }, "signature": [ { @@ -2618,24 +2476,18 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 100 + "lineNumber": 101 }, "signature": [ "Pick<", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorSet", - "text": "CollectorSet" - }, + "CollectorSet", ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" ] } ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 94 + "lineNumber": 95 }, "initialIsOpen": false }, @@ -2661,7 +2513,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, pkgName: string) => Promise<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, pkgName: string) => Promise<", { "pluginId": "fleet", "scope": "common", @@ -2674,6 +2526,7 @@ "description": [], "children": [ { + "id": "def-server.PackageService.getInstalledEsAssetReferences.$1", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -2686,7 +2539,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "description": [], "source": { @@ -2695,6 +2548,7 @@ } }, { + "id": "def-server.PackageService.getInstalledEsAssetReferences.$2", "type": "string", "label": "pkgName", "isRequired": true, @@ -2735,7 +2589,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 140 + "lineNumber": 141 }, "signature": [ "[\"packagePolicyCreate\", (newPackagePolicy: ", @@ -2789,7 +2643,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/index.ts", - "lineNumber": 78 + "lineNumber": 83 }, "signature": [ "any" @@ -2837,7 +2691,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 125 + "lineNumber": 126 }, "signature": [ "void" @@ -2854,6 +2708,22 @@ ], "tags": [], "children": [ + { + "tags": [], + "id": "def-server.FleetStartContract.fleetSetupCompleted", + "type": "Function", + "label": "fleetSetupCompleted", + "description": [ + "\nreturns a promise that resolved when fleet setup has been completed regardless if it was successful or failed).\nAny consumer of fleet start services should first `await` for this promise to be resolved before using those\nservices" + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 170 + }, + "signature": [ + "() => Promise" + ] + }, { "tags": [], "id": "def-server.FleetStartContract.esIndexPatternService", @@ -2862,7 +2732,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 164 + "lineNumber": 171 }, "signature": [ { @@ -2882,7 +2752,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 165 + "lineNumber": 172 }, "signature": [ { @@ -2902,7 +2772,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 166 + "lineNumber": 173 }, "signature": [ { @@ -2924,16 +2794,10 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 170 + "lineNumber": 177 }, "signature": [ - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.PackagePolicyService", - "text": "PackagePolicyService" - } + "PackagePolicyService" ] }, { @@ -2944,7 +2808,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 171 + "lineNumber": 178 }, "signature": [ { @@ -2966,7 +2830,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 176 + "lineNumber": 183 }, "signature": [ "(...args: ", @@ -2990,23 +2854,17 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 182 + "lineNumber": 189 }, "signature": [ "(packageName: string) => ", - { - "pluginId": "fleet", - "scope": "server", - "docId": "kibFleetPluginApi", - "section": "def-server.FleetArtifactsClient", - "text": "FleetArtifactsClient" - } + "FleetArtifactsClient" ] } ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 163 + "lineNumber": 164 }, "lifecycle": "start", "initialIsOpen": true @@ -3029,31 +2887,20 @@ "(license$: ", "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">) => void" ], "description": [], "children": [ { + "id": "def-common.LicenseService.start.$1", "type": "Object", "label": "license$", "isRequired": true, "signature": [ "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ], "description": [], @@ -3092,13 +2939,7 @@ "label": "getLicenseInformation", "signature": [ "() => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", " | null" ], "description": [], @@ -3118,13 +2959,7 @@ "() => ", "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", "> | null" ], "description": [], @@ -3187,6 +3022,7 @@ "description": [], "children": [ { + "id": "def-common.decodeCloudId.$1", "type": "string", "label": "cid", "isRequired": true, @@ -3213,6 +3049,7 @@ "type": "Function", "children": [ { + "id": "def-common.doesAgentPolicyAlreadyIncludePackage.$1", "type": "Object", "label": "agentPolicy", "isRequired": true, @@ -3232,6 +3069,7 @@ } }, { + "id": "def-common.doesAgentPolicyAlreadyIncludePackage.$2", "type": "string", "label": "packageName", "isRequired": true, @@ -3274,7 +3112,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 39 + "lineNumber": 42 }, "signature": [ "(o: T) => [keyof T, T[keyof T]][]" @@ -3286,6 +3124,7 @@ "type": "Function", "children": [ { + "id": "def-common.fullAgentPolicyToYaml.$1", "type": "Object", "label": "policy", "isRequired": true, @@ -3301,7 +3140,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", - "lineNumber": 27 + "lineNumber": 28 } } ], @@ -3320,7 +3159,7 @@ "label": "fullAgentPolicyToYaml", "source": { "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", - "lineNumber": 27 + "lineNumber": 28 }, "tags": [], "returnComment": [], @@ -3344,6 +3183,7 @@ "description": [], "children": [ { + "id": "def-common.isAgentUpgradeable.$1", "type": "Object", "label": "agent", "isRequired": true, @@ -3363,6 +3203,7 @@ } }, { + "id": "def-common.isAgentUpgradeable.$2", "type": "string", "label": "kibanaVersion", "isRequired": true, @@ -3394,6 +3235,7 @@ "description": [], "children": [ { + "id": "def-common.isDiffPathProtocol.$1", "type": "Array", "label": "kibanaUrls", "isRequired": true, @@ -3420,6 +3262,7 @@ "type": "Function", "children": [ { + "id": "def-common.isPackageLimited.$1", "type": "CompoundType", "label": "packageInfo", "isRequired": true, @@ -3470,6 +3313,7 @@ "description": [], "children": [ { + "id": "def-common.isValidNamespace.$1", "type": "string", "label": "namespace", "isRequired": true, @@ -3496,6 +3340,7 @@ "type": "Function", "children": [ { + "id": "def-common.packageToPackagePolicy.$1", "type": "CompoundType", "label": "packageInfo", "isRequired": true, @@ -3515,6 +3360,7 @@ } }, { + "id": "def-common.packageToPackagePolicy.$2", "type": "string", "label": "agentPolicyId", "isRequired": true, @@ -3528,6 +3374,7 @@ } }, { + "id": "def-common.packageToPackagePolicy.$3", "type": "string", "label": "outputId", "isRequired": true, @@ -3541,6 +3388,7 @@ } }, { + "id": "def-common.packageToPackagePolicy.$4", "type": "string", "label": "namespace", "isRequired": true, @@ -3554,6 +3402,7 @@ } }, { + "id": "def-common.packageToPackagePolicy.$5", "type": "string", "label": "packagePolicyName", "isRequired": false, @@ -3567,6 +3416,7 @@ } }, { + "id": "def-common.packageToPackagePolicy.$6", "type": "string", "label": "description", "isRequired": false, @@ -3615,6 +3465,7 @@ "type": "Function", "children": [ { + "id": "def-common.packageToPackagePolicyInputs.$1", "type": "CompoundType", "label": "packageInfo", "isRequired": true, @@ -3668,6 +3519,7 @@ "type": "Function", "children": [ { + "id": "def-common.storedPackagePoliciesToAgentInputs.$1", "type": "Array", "label": "packagePolicies", "isRequired": true, @@ -4045,7 +3897,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 27 + "lineNumber": 28 } }, { @@ -4056,7 +3908,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 28 + "lineNumber": 29 }, "signature": [ { @@ -4077,7 +3929,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 29 + "lineNumber": 30 }, "signature": [ "string[] | ", @@ -4099,7 +3951,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 30 + "lineNumber": 31 } }, { @@ -4110,7 +3962,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 31 + "lineNumber": 32 } }, { @@ -4121,7 +3973,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 32 + "lineNumber": 33 } }, { @@ -4132,13 +3984,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 33 + "lineNumber": 34 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 26 + "lineNumber": 27 }, "initialIsOpen": false }, @@ -4340,7 +4192,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 213 + "lineNumber": 217 } }, { @@ -4351,7 +4203,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 214 + "lineNumber": 218 }, "signature": [ "string | undefined" @@ -4365,7 +4217,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 215 + "lineNumber": 219 }, "signature": [ { @@ -4385,7 +4237,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 216 + "lineNumber": 220 }, "signature": [ { @@ -4405,13 +4257,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 217 + "lineNumber": 221 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 212 + "lineNumber": 216 }, "initialIsOpen": false }, @@ -4424,44 +4276,58 @@ "children": [ { "tags": [], - "id": "def-common.BaseSettings.kibana_urls", - "type": "Array", - "label": "kibana_urls", + "id": "def-common.BaseSettings.has_seen_add_data_notice", + "type": "CompoundType", + "label": "has_seen_add_data_notice", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 11 }, "signature": [ - "string[]" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.BaseSettings.kibana_ca_sha256", - "type": "string", - "label": "kibana_ca_sha256", + "id": "def-common.BaseSettings.fleet_server_hosts", + "type": "Array", + "label": "fleet_server_hosts", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 12 }, "signature": [ - "string | undefined" + "string[]" ] }, { "tags": [], - "id": "def-common.BaseSettings.has_seen_add_data_notice", - "type": "CompoundType", - "label": "has_seen_add_data_notice", + "id": "def-common.BaseSettings.kibana_urls", + "type": "Array", + "label": "kibana_urls", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 13 + "lineNumber": 14 }, "signature": [ - "boolean | undefined" + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.BaseSettings.kibana_ca_sha256", + "type": "string", + "label": "kibana_ca_sha256", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 15 + }, + "signature": [ + "string | undefined" ] } ], @@ -4614,7 +4480,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 206 + "lineNumber": 210 } }, { @@ -4625,7 +4491,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 207 + "lineNumber": 211 } }, { @@ -4636,13 +4502,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 208 + "lineNumber": 212 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 205 + "lineNumber": 209 }, "initialIsOpen": false }, @@ -5111,7 +4977,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 200 + "lineNumber": 205 }, "signature": [ "{ agentId: string; }" @@ -5120,7 +4986,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 199 + "lineNumber": 204 }, "initialIsOpen": false }, @@ -5380,7 +5246,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 312 + "lineNumber": 316 } }, { @@ -5391,7 +5257,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 313 + "lineNumber": 317 } }, { @@ -5402,7 +5268,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 314 + "lineNumber": 318 }, "signature": [ { @@ -5422,7 +5288,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 315 + "lineNumber": 319 }, "signature": [ "boolean | undefined" @@ -5431,7 +5297,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 311 + "lineNumber": 315 }, "initialIsOpen": false }, @@ -5492,7 +5358,7 @@ "lineNumber": 15 }, "signature": [ - "{ enabled: boolean; fleetServerEnabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" + "{ enabled: boolean; fleetServerEnabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" ] } ], @@ -5978,7 +5844,7 @@ }, { "tags": [], - "id": "def-common.FleetServerAgentAction.'@timestamp'", + "id": "def-common.FleetServerAgentAction.timestamp", "type": "string", "label": "'@timestamp'", "description": [ @@ -6290,7 +6156,7 @@ "children": [ { "tags": [], - "id": "def-common.FleetServerPolicy.'@timestamp'", + "id": "def-common.FleetServerPolicy.timestamp", "type": "string", "label": "'@timestamp'", "description": [ @@ -6298,7 +6164,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 99 + "lineNumber": 117 }, "signature": [ "string | undefined" @@ -6314,7 +6180,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 103 + "lineNumber": 121 } }, { @@ -6327,7 +6193,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 107 + "lineNumber": 125 } }, { @@ -6340,7 +6206,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 111 + "lineNumber": 129 } }, { @@ -6353,7 +6219,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 115 + "lineNumber": 133 }, "signature": [ "{ [k: string]: unknown; }" @@ -6369,13 +6235,13 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 121 + "lineNumber": 139 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 95 + "lineNumber": 113 }, "initialIsOpen": false }, @@ -6394,7 +6260,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 63 + "lineNumber": 74 } }, { @@ -6405,7 +6271,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 64 + "lineNumber": 75 }, "signature": [ "{ [key: string]: Pick<", @@ -6421,16 +6287,38 @@ }, { "tags": [], - "id": "def-common.FullAgentPolicy.fleet", + "id": "def-common.FullAgentPolicy.output_permissions", "type": "Object", + "label": "output_permissions", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 80 + }, + "signature": [ + "{ [output: string]: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyOutputPermissions", + "text": "FullAgentPolicyOutputPermissions" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicy.fleet", + "type": "CompoundType", "label": "fleet", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 69 + "lineNumber": 83 }, "signature": [ - "{ kibana: ", + "{ hosts: string[]; } | { kibana: ", { "pluginId": "fleet", "scope": "common", @@ -6449,7 +6337,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 72 + "lineNumber": 90 }, "signature": [ { @@ -6470,7 +6358,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 73 + "lineNumber": 91 }, "signature": [ "number | undefined" @@ -6484,7 +6372,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 74 + "lineNumber": 92 }, "signature": [ "{ monitoring: { use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined" @@ -6493,7 +6381,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 62 + "lineNumber": 73 }, "initialIsOpen": false }, @@ -6512,7 +6400,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 48 + "lineNumber": 49 } }, { @@ -6523,7 +6411,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 49 + "lineNumber": 50 } }, { @@ -6534,7 +6422,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 50 + "lineNumber": 51 } }, { @@ -6545,7 +6433,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 51 + "lineNumber": 52 } }, { @@ -6556,7 +6444,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 52 + "lineNumber": 53 }, "signature": [ "{ namespace: string; }" @@ -6570,7 +6458,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 53 + "lineNumber": 54 } }, { @@ -6581,7 +6469,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 54 + "lineNumber": 55 }, "signature": [ "{ [key: string]: unknown; package?: Pick<", @@ -6603,7 +6491,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 58 + "lineNumber": 59 }, "signature": [ { @@ -6624,7 +6512,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 59 + "lineNumber": 60 }, "signature": [ "any" @@ -6633,7 +6521,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 47 + "lineNumber": 48 }, "initialIsOpen": false }, @@ -6652,7 +6540,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 39 + "lineNumber": 40 } }, { @@ -6663,7 +6551,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 40 + "lineNumber": 41 }, "signature": [ "{ dataset: string; type: string; }" @@ -6677,7 +6565,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 44 + "lineNumber": 45 }, "signature": [ "any" @@ -6686,7 +6574,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 38 + "lineNumber": 39 }, "initialIsOpen": false }, @@ -6705,7 +6593,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 85 + "lineNumber": 103 }, "signature": [ "string[]" @@ -6719,7 +6607,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 86 + "lineNumber": 104 } }, { @@ -6730,7 +6618,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 87 + "lineNumber": 105 }, "signature": [ "string | undefined" @@ -6739,7 +6627,35 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 84 + "lineNumber": 102 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FullAgentPolicyOutputPermissions", + "type": "Interface", + "label": "FullAgentPolicyOutputPermissions", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.FullAgentPolicyOutputPermissions.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 64 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 63 }, "initialIsOpen": false }, @@ -6968,7 +6884,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 215 + "lineNumber": 220 }, "signature": [ "{ kuery?: string | undefined; policyId?: string | undefined; }" @@ -6977,7 +6893,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 214 + "lineNumber": 219 }, "initialIsOpen": false }, @@ -6996,7 +6912,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 222 + "lineNumber": 227 }, "signature": [ "{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }" @@ -7005,7 +6921,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 221 + "lineNumber": 226 }, "initialIsOpen": false }, @@ -7436,7 +7352,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 182 + "lineNumber": 187 }, "signature": [ "{ agentId: string; }" @@ -7450,7 +7366,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 185 + "lineNumber": 190 }, "signature": [ "{ page: number; perPage: number; kuery?: string | undefined; }" @@ -7459,7 +7375,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 181 + "lineNumber": 186 }, "initialIsOpen": false }, @@ -7478,7 +7394,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 193 + "lineNumber": 198 }, "signature": [ { @@ -7499,7 +7415,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 194 + "lineNumber": 199 } }, { @@ -7510,7 +7426,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 195 + "lineNumber": 200 } }, { @@ -7521,13 +7437,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 196 + "lineNumber": 201 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 192 + "lineNumber": 197 }, "initialIsOpen": false }, @@ -8066,7 +7982,7 @@ "section": "def-common.RegistryPackage", "text": "RegistryPackage" }, - ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">>[]" + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">>[]" ] } ], @@ -8237,7 +8153,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 383 + "lineNumber": 387 } }, { @@ -8248,7 +8164,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 384 + "lineNumber": 388 }, "signature": [ "string[]" @@ -8262,7 +8178,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 385 + "lineNumber": 389 }, "signature": [ "{ settings: any; mappings: any; }" @@ -8276,7 +8192,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 389 + "lineNumber": 393 }, "signature": [ "{ hidden?: boolean | undefined; }" @@ -8290,7 +8206,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 390 + "lineNumber": 394 }, "signature": [ "string[]" @@ -8304,7 +8220,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 391 + "lineNumber": 395 }, "signature": [ "object" @@ -8313,7 +8229,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 382 + "lineNumber": 386 }, "initialIsOpen": false }, @@ -8332,7 +8248,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 376 + "lineNumber": 380 }, "signature": [ "any" @@ -8341,7 +8257,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 375 + "lineNumber": 379 }, "initialIsOpen": false }, @@ -8371,7 +8287,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 331 + "lineNumber": 335 }, "signature": [ { @@ -8392,7 +8308,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 332 + "lineNumber": 336 }, "signature": [ { @@ -8413,7 +8329,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 333 + "lineNumber": 337 }, "signature": [ { @@ -8434,7 +8350,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 334 + "lineNumber": 338 }, "signature": [ "Record" @@ -8448,7 +8364,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 335 + "lineNumber": 339 } }, { @@ -8459,7 +8375,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 336 + "lineNumber": 340 } }, { @@ -8470,7 +8386,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 337 + "lineNumber": 341 }, "signature": [ { @@ -8490,7 +8406,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 338 + "lineNumber": 342 } }, { @@ -8501,7 +8417,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 339 + "lineNumber": 343 } }, { @@ -8512,7 +8428,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 340 + "lineNumber": 344 }, "signature": [ { @@ -8527,7 +8443,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 330 + "lineNumber": 334 }, "initialIsOpen": false }, @@ -9159,6 +9075,20 @@ "signature": [ "(\"metrics\" | \"logs\")[] | undefined" ] + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.preconfiguration_id", + "type": "string", + "label": "preconfiguration_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 24 + }, + "signature": [ + "string | undefined" + ] } ], "source": { @@ -10151,7 +10081,7 @@ "lineNumber": 20 }, "signature": [ - "(\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined" + "(\"custom\" | \"security\" | \"monitoring\" | \"cloud\" | \"network\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined" ] }, { @@ -10331,13 +10261,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 344 + "lineNumber": 348 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 343 + "lineNumber": 347 }, "initialIsOpen": false }, @@ -10672,7 +10602,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 128 + "lineNumber": 133 }, "signature": [ "{ agentId: string; }" @@ -10686,7 +10616,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 131 + "lineNumber": 136 }, "signature": [ "{ source_uri?: string | undefined; version: string; }" @@ -10695,7 +10625,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 127 + "lineNumber": 132 }, "initialIsOpen": false }, @@ -10708,7 +10638,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 154 + "lineNumber": 159 }, "initialIsOpen": false }, @@ -10727,7 +10657,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 167 + "lineNumber": 172 }, "signature": [ "{ policy_id: string; agents: string | string[]; }" @@ -10736,7 +10666,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 166 + "lineNumber": 171 }, "initialIsOpen": false }, @@ -10768,19 +10698,6 @@ }, "initialIsOpen": false }, - { - "id": "def-common.PostBulkAgentUnenrollResponse", - "type": "Interface", - "label": "PostBulkAgentUnenrollResponse", - "description": [], - "tags": [], - "children": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 125 - }, - "initialIsOpen": false - }, { "id": "def-common.PostBulkAgentUpgradeRequest", "type": "Interface", @@ -10796,7 +10713,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 138 + "lineNumber": 143 }, "signature": [ "{ agents: string | string[]; source_uri?: string | undefined; version: string; }" @@ -10805,7 +10722,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 137 + "lineNumber": 142 }, "initialIsOpen": false }, @@ -10921,73 +10838,217 @@ "label": "body", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 93 + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 93 + }, + "signature": [ + "{ action: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentAction", + "text": "NewAgentAction" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-common.PostNewAgentActionRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 96 + }, + "signature": [ + "{ agentId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 92 + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostNewAgentActionResponse", + "type": "Interface", + "label": "PostNewAgentActionResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostNewAgentActionResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 102 + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentAction", + "text": "AgentAction" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 101 + }, + "initialIsOpen": false + }, + { + "id": "def-common.PreconfiguredAgentPolicy", + "type": "Interface", + "label": "PreconfiguredAgentPolicy", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PreconfiguredAgentPolicy", + "text": "PreconfiguredAgentPolicy" + }, + " extends Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentPolicy", + "text": "NewAgentPolicy" + }, + ", \"description\" | \"name\" | \"is_default\" | \"is_managed\" | \"is_default_fleet_server\" | \"monitoring_enabled\" | \"preconfiguration_id\">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PreconfiguredAgentPolicy.id", + "type": "CompoundType", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 20 + }, + "signature": [ + "React.ReactText" + ] + }, + { + "tags": [], + "id": "def-common.PreconfiguredAgentPolicy.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 21 }, "signature": [ - "{ action: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentAction", - "text": "NewAgentAction" - }, - "; }" + "string | undefined" ] }, { "tags": [], - "id": "def-common.PostNewAgentActionRequest.params", - "type": "Object", - "label": "params", + "id": "def-common.PreconfiguredAgentPolicy.package_policies", + "type": "Array", + "label": "package_policies", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 96 + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 22 }, "signature": [ - "{ agentId: string; }" + "(Partial> & { name: string; package: Partial<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + ">; inputs?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InputsOverride", + "text": "InputsOverride" + }, + "[] | undefined; })[]" ] } ], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 92 + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 19 }, "initialIsOpen": false }, { - "id": "def-common.PostNewAgentActionResponse", + "id": "def-common.PreconfiguredPackage", "type": "Interface", - "label": "PostNewAgentActionResponse", + "label": "PreconfiguredPackage", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PreconfiguredPackage", + "text": "PreconfiguredPackage" + }, + " extends Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + ", \"name\" | \"version\">" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.PostNewAgentActionResponse.item", - "type": "Object", - "label": "item", + "id": "def-common.PreconfiguredPackage.force", + "type": "CompoundType", + "label": "force", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 102 + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 32 }, "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentAction", - "text": "AgentAction" - } + "boolean | undefined" ] } ], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 101 + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 31 }, "initialIsOpen": false }, @@ -11006,7 +11067,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 157 + "lineNumber": 162 }, "signature": [ "{ agentId: string; }" @@ -11020,7 +11081,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 160 + "lineNumber": 165 }, "signature": [ "{ policy_id: string; }" @@ -11029,7 +11090,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 156 + "lineNumber": 161 }, "initialIsOpen": false }, @@ -11042,7 +11103,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 164 + "lineNumber": 169 }, "initialIsOpen": false }, @@ -11148,7 +11209,7 @@ "section": "def-common.Settings", "text": "Settings" }, - ", \"kibana_urls\" | \"kibana_ca_sha256\" | \"has_seen_add_data_notice\">>" + ", \"has_seen_add_data_notice\" | \"fleet_server_hosts\" | \"kibana_urls\" | \"kibana_ca_sha256\">>" ] } ], @@ -11201,24 +11262,24 @@ "children": [ { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.type]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.type", "type": "string", "label": "[RegistryDataStreamKeys.type]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 258 + "lineNumber": 262 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.ilm_policy]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ilm_policy", "type": "string", "label": "[RegistryDataStreamKeys.ilm_policy]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 259 + "lineNumber": 263 }, "signature": [ "string | undefined" @@ -11226,13 +11287,13 @@ }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.hidden]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.hidden", "type": "CompoundType", "label": "[RegistryDataStreamKeys.hidden]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 260 + "lineNumber": 264 }, "signature": [ "boolean | undefined" @@ -11240,46 +11301,46 @@ }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.dataset]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset", "type": "string", "label": "[RegistryDataStreamKeys.dataset]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 261 + "lineNumber": 265 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.title]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.title", "type": "string", "label": "[RegistryDataStreamKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 262 + "lineNumber": 266 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.release]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.release", "type": "string", "label": "[RegistryDataStreamKeys.release]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 263 + "lineNumber": 267 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.streams]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.streams", "type": "Array", "label": "[RegistryDataStreamKeys.streams]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 264 + "lineNumber": 268 }, "signature": [ { @@ -11294,46 +11355,46 @@ }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.package]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.package", "type": "string", "label": "[RegistryDataStreamKeys.package]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 265 + "lineNumber": 269 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.path]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.path", "type": "string", "label": "[RegistryDataStreamKeys.path]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 266 + "lineNumber": 270 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.ingest_pipeline]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ingest_pipeline", "type": "string", "label": "[RegistryDataStreamKeys.ingest_pipeline]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 267 + "lineNumber": 271 } }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.elasticsearch]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.elasticsearch", "type": "Object", "label": "[RegistryDataStreamKeys.elasticsearch]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 268 + "lineNumber": 272 }, "signature": [ { @@ -11348,13 +11409,13 @@ }, { "tags": [], - "id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.dataset_is_prefix]", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset_is_prefix", "type": "CompoundType", "label": "[RegistryDataStreamKeys.dataset_is_prefix]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 269 + "lineNumber": 273 }, "signature": [ "boolean | undefined" @@ -11363,7 +11424,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 257 + "lineNumber": 261 }, "initialIsOpen": false }, @@ -11376,13 +11437,13 @@ "children": [ { "tags": [], - "id": "def-common.RegistryElasticsearch.'index_template.settings'", + "id": "def-common.RegistryElasticsearch.index_template.settings", "type": "Uncategorized", "label": "'index_template.settings'", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 273 + "lineNumber": 277 }, "signature": [ "object | undefined" @@ -11390,13 +11451,13 @@ }, { "tags": [], - "id": "def-common.RegistryElasticsearch.'index_template.mappings'", + "id": "def-common.RegistryElasticsearch.index_template.mappings", "type": "Uncategorized", "label": "'index_template.mappings'", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 274 + "lineNumber": 278 }, "signature": [ "object | undefined" @@ -11405,7 +11466,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 272 + "lineNumber": 276 }, "initialIsOpen": false }, @@ -11424,7 +11485,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 113 + "lineNumber": 117 } }, { @@ -11435,7 +11496,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 114 + "lineNumber": 118 } }, { @@ -11446,7 +11507,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 115 + "lineNumber": 119 }, "signature": [ "string | undefined" @@ -11460,7 +11521,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 116 + "lineNumber": 120 }, "signature": [ "string | undefined" @@ -11474,7 +11535,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 117 + "lineNumber": 121 }, "signature": [ "string | undefined" @@ -11483,7 +11544,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 112 + "lineNumber": 116 }, "initialIsOpen": false }, @@ -11496,46 +11557,46 @@ "children": [ { "tags": [], - "id": "def-common.RegistryInput.[RegistryInputKeys.type]", + "id": "def-common.RegistryInput.RegistryInputKeys.type", "type": "string", "label": "[RegistryInputKeys.type]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 146 + "lineNumber": 150 } }, { "tags": [], - "id": "def-common.RegistryInput.[RegistryInputKeys.title]", + "id": "def-common.RegistryInput.RegistryInputKeys.title", "type": "string", "label": "[RegistryInputKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 147 + "lineNumber": 151 } }, { "tags": [], - "id": "def-common.RegistryInput.[RegistryInputKeys.description]", + "id": "def-common.RegistryInput.RegistryInputKeys.description", "type": "string", "label": "[RegistryInputKeys.description]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 148 + "lineNumber": 152 } }, { "tags": [], - "id": "def-common.RegistryInput.[RegistryInputKeys.template_path]", + "id": "def-common.RegistryInput.RegistryInputKeys.template_path", "type": "string", "label": "[RegistryInputKeys.template_path]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 149 + "lineNumber": 153 }, "signature": [ "string | undefined" @@ -11543,13 +11604,13 @@ }, { "tags": [], - "id": "def-common.RegistryInput.[RegistryInputKeys.condition]", + "id": "def-common.RegistryInput.RegistryInputKeys.condition", "type": "string", "label": "[RegistryInputKeys.condition]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 150 + "lineNumber": 154 }, "signature": [ "string | undefined" @@ -11557,13 +11618,13 @@ }, { "tags": [], - "id": "def-common.RegistryInput.[RegistryInputKeys.vars]", + "id": "def-common.RegistryInput.RegistryInputKeys.vars", "type": "Array", "label": "[RegistryInputKeys.vars]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 151 + "lineNumber": 155 }, "signature": [ { @@ -11579,7 +11640,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 145 + "lineNumber": 149 }, "initialIsOpen": false }, @@ -11592,46 +11653,46 @@ "children": [ { "tags": [], - "id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.name]", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name", "type": "string", "label": "[RegistryPolicyTemplateKeys.name]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 129 + "lineNumber": 133 } }, { "tags": [], - "id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.title]", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title", "type": "string", "label": "[RegistryPolicyTemplateKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 130 + "lineNumber": 134 } }, { "tags": [], - "id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.description]", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description", "type": "string", "label": "[RegistryPolicyTemplateKeys.description]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 131 + "lineNumber": 135 } }, { "tags": [], - "id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.inputs]", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs", "type": "Array", "label": "[RegistryPolicyTemplateKeys.inputs]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 132 + "lineNumber": 136 }, "signature": [ { @@ -11646,13 +11707,13 @@ }, { "tags": [], - "id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.multiple]", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple", "type": "CompoundType", "label": "[RegistryPolicyTemplateKeys.multiple]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 133 + "lineNumber": 137 }, "signature": [ "boolean | undefined" @@ -11661,7 +11722,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 128 + "lineNumber": 132 }, "initialIsOpen": false }, @@ -11674,35 +11735,35 @@ "children": [ { "tags": [], - "id": "def-common.RegistryStream.[RegistryStreamKeys.input]", + "id": "def-common.RegistryStream.RegistryStreamKeys.input", "type": "string", "label": "[RegistryStreamKeys.input]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 164 + "lineNumber": 168 } }, { "tags": [], - "id": "def-common.RegistryStream.[RegistryStreamKeys.title]", + "id": "def-common.RegistryStream.RegistryStreamKeys.title", "type": "string", "label": "[RegistryStreamKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 165 + "lineNumber": 169 } }, { "tags": [], - "id": "def-common.RegistryStream.[RegistryStreamKeys.description]", + "id": "def-common.RegistryStream.RegistryStreamKeys.description", "type": "string", "label": "[RegistryStreamKeys.description]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 166 + "lineNumber": 170 }, "signature": [ "string | undefined" @@ -11710,13 +11771,13 @@ }, { "tags": [], - "id": "def-common.RegistryStream.[RegistryStreamKeys.enabled]", + "id": "def-common.RegistryStream.RegistryStreamKeys.enabled", "type": "CompoundType", "label": "[RegistryStreamKeys.enabled]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 167 + "lineNumber": 171 }, "signature": [ "boolean | undefined" @@ -11724,13 +11785,13 @@ }, { "tags": [], - "id": "def-common.RegistryStream.[RegistryStreamKeys.vars]", + "id": "def-common.RegistryStream.RegistryStreamKeys.vars", "type": "Array", "label": "[RegistryStreamKeys.vars]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 168 + "lineNumber": 172 }, "signature": [ { @@ -11745,19 +11806,19 @@ }, { "tags": [], - "id": "def-common.RegistryStream.[RegistryStreamKeys.template_path]", + "id": "def-common.RegistryStream.RegistryStreamKeys.template_path", "type": "string", "label": "[RegistryStreamKeys.template_path]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 169 + "lineNumber": 173 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 163 + "lineNumber": 167 }, "initialIsOpen": false }, @@ -11770,24 +11831,24 @@ "children": [ { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.name]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.name", "type": "string", "label": "[RegistryVarsEntryKeys.name]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 294 + "lineNumber": 298 } }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.title]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.title", "type": "string", "label": "[RegistryVarsEntryKeys.title]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 295 + "lineNumber": 299 }, "signature": [ "string | undefined" @@ -11795,13 +11856,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.description]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.description", "type": "string", "label": "[RegistryVarsEntryKeys.description]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 296 + "lineNumber": 300 }, "signature": [ "string | undefined" @@ -11809,13 +11870,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.type]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.type", "type": "CompoundType", "label": "[RegistryVarsEntryKeys.type]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 297 + "lineNumber": 301 }, "signature": [ { @@ -11829,13 +11890,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.required]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.required", "type": "CompoundType", "label": "[RegistryVarsEntryKeys.required]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 298 + "lineNumber": 302 }, "signature": [ "boolean | undefined" @@ -11843,13 +11904,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.show_user]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.show_user", "type": "CompoundType", "label": "[RegistryVarsEntryKeys.show_user]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 299 + "lineNumber": 303 }, "signature": [ "boolean | undefined" @@ -11857,13 +11918,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.multi]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.multi", "type": "CompoundType", "label": "[RegistryVarsEntryKeys.multi]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 300 + "lineNumber": 304 }, "signature": [ "boolean | undefined" @@ -11871,13 +11932,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.default]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.default", "type": "CompoundType", "label": "[RegistryVarsEntryKeys.default]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 301 + "lineNumber": 305 }, "signature": [ "string | string[] | undefined" @@ -11885,13 +11946,13 @@ }, { "tags": [], - "id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.os]", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.os", "type": "Object", "label": "[RegistryVarsEntryKeys.os]", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 302 + "lineNumber": 306 }, "signature": [ "{ [key: string]: { default: string | string[]; }; } | undefined" @@ -11900,7 +11961,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 293 + "lineNumber": 297 }, "initialIsOpen": false }, @@ -11919,13 +11980,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 175 + "lineNumber": 179 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 174 + "lineNumber": 178 }, "initialIsOpen": false }, @@ -11961,13 +12022,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 17 + "lineNumber": 19 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 16 + "lineNumber": 18 }, "initialIsOpen": false }, @@ -11999,7 +12060,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 20 + "lineNumber": 22 }, "initialIsOpen": false }, @@ -12018,7 +12079,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 395 + "lineNumber": 399 } }, { @@ -12029,7 +12090,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 396 + "lineNumber": 400 }, "signature": [ { @@ -12044,7 +12105,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 394 + "lineNumber": 398 }, "initialIsOpen": false }, @@ -12097,7 +12158,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 206 + "lineNumber": 211 }, "signature": [ "{ agentId: string; }" @@ -12111,7 +12172,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 209 + "lineNumber": 214 }, "signature": [ "{ user_provided_metadata: Record; }" @@ -12120,7 +12181,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 205 + "lineNumber": 210 }, "initialIsOpen": false }, @@ -12179,7 +12240,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 67 + "lineNumber": 71 }, "initialIsOpen": false }, @@ -12215,7 +12276,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 58 + "lineNumber": 60 }, "initialIsOpen": false }, @@ -12227,7 +12288,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 242 + "lineNumber": 246 }, "initialIsOpen": false }, @@ -12239,7 +12300,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 136 + "lineNumber": 140 }, "initialIsOpen": false }, @@ -12251,7 +12312,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 120 + "lineNumber": 124 }, "initialIsOpen": false }, @@ -12263,7 +12324,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 154 + "lineNumber": 158 }, "initialIsOpen": false }, @@ -12275,7 +12336,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 278 + "lineNumber": 282 }, "initialIsOpen": false } @@ -12646,10 +12707,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 36 + "lineNumber": 37 }, "signature": [ - "{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; is_default?: boolean | undefined; updated_by: string; revision: number; package_policies: string[] | PackagePolicy[]; is_managed: boolean; is_default_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; }" + "{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; is_default?: boolean | undefined; updated_by: string; revision: number; package_policies: string[] | PackagePolicy[]; is_managed: boolean; is_default_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; preconfiguration_id?: string | undefined; }" ], "initialIsOpen": false }, @@ -12736,10 +12797,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 80 + "lineNumber": 84 }, "signature": [ - "PackageSpecManifest & Pick" + "PackageSpecManifest & Pick" ], "initialIsOpen": false }, @@ -12751,7 +12812,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 358 + "lineNumber": 362 }, "signature": [ { @@ -12795,7 +12856,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 220 + "lineNumber": 224 }, "signature": [ "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" @@ -12864,7 +12925,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 219 + "lineNumber": 223 }, "signature": [ "Record & Record" @@ -12908,7 +12969,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 204 + "lineNumber": 208 }, "signature": [ "string" @@ -12923,7 +12984,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 203 + "lineNumber": 207 }, "signature": [ "CategorySummaryItem[]" @@ -12950,7 +13011,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 76 + "lineNumber": 80 }, "signature": [ "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" @@ -12980,7 +13041,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 373 + "lineNumber": 377 }, "signature": [ "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" @@ -13013,7 +13074,7 @@ "lineNumber": 38 }, "signature": [ - "\"custom\" | \"overview\" | \"policies\" | \"settings\"" + "\"custom\" | \"settings\" | \"overview\" | \"policies\"" ], "initialIsOpen": false }, @@ -13025,7 +13086,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 231 + "lineNumber": 235 }, "signature": [ "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" @@ -13040,7 +13101,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 237 + "lineNumber": 241 }, "signature": [ "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" @@ -13127,7 +13188,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 363 + "lineNumber": 367 }, "signature": [ "Pick & { type: ElasticsearchAssetType; }" @@ -13239,6 +13300,29 @@ ], "initialIsOpen": false }, + { + "id": "def-common.InputsOverride", + "type": "Type", + "label": "InputsOverride", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 15 + }, + "signature": [ + "Partial & { vars?: (Record & { name: string; })[] | undefined; }" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.INSTALL_SCRIPT_API_ROUTES", @@ -13259,7 +13343,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 347 + "lineNumber": 351 }, "signature": [ { @@ -13289,7 +13373,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 78 + "lineNumber": 82 }, "signature": [ { @@ -13333,7 +13417,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 349 + "lineNumber": 353 }, "signature": [ "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" @@ -13378,7 +13462,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 226 + "lineNumber": 230 }, "signature": [ "AssetParts & { service: Extract; type: KibanaAssetType; }" @@ -13393,7 +13477,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 360 + "lineNumber": 364 }, "signature": [ "Pick & { type: KibanaSavedObjectType; }" @@ -13408,10 +13492,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 236 + "lineNumber": 240 }, "signature": [ - "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; }" + "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; security_rule: KibanaAssetParts[]; ml_module: KibanaAssetParts[]; }" ], "initialIsOpen": false }, @@ -13453,7 +13537,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 354 + "lineNumber": 358 }, "signature": [ "T & { status: InstallationStatus['NotInstalled']; }" @@ -13555,7 +13639,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 367 + "lineNumber": 371 }, "signature": [ "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" @@ -13570,7 +13654,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 326 + "lineNumber": 330 }, "signature": [ { @@ -13623,10 +13707,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 322 + "lineNumber": 326 }, "signature": [ - "Installable>[]" + "Installable>[]" ], "initialIsOpen": false }, @@ -13638,7 +13722,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 324 + "lineNumber": 328 }, "signature": [ { @@ -13656,7 +13740,7 @@ "section": "def-common.RegistryPackage", "text": "RegistryPackage" }, - ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">> | ", + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">> | ", { "pluginId": "fleet", "scope": "common", @@ -13672,7 +13756,7 @@ "section": "def-common.RegistryPackage", "text": "RegistryPackage" }, - ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">>" + ", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\">>" ], "initialIsOpen": false }, @@ -13729,7 +13813,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 325 + "lineNumber": 329 }, "signature": [ "{ installed: PackageList; not_installed: PackageList; }" @@ -13747,7 +13831,7 @@ "lineNumber": 28 }, "signature": [ - "\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" + "\"custom\" | \"security\" | \"monitoring\" | \"cloud\" | \"network\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" ], "initialIsOpen": false }, @@ -13789,7 +13873,22 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 173 + "lineNumber": 178 + }, + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUnenrollResponse", + "type": "Type", + "label": "PostBulkAgentUnenrollResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 124 }, "signature": [ "{ [x: string]: { success: boolean; error?: string | undefined; }; }" @@ -13804,7 +13903,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 145 + "lineNumber": 150 }, "signature": [ "{ [x: string]: { success: boolean; error?: string | undefined; }; }" @@ -13819,7 +13918,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 84 + "lineNumber": 88 }, "signature": [ "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" @@ -13834,7 +13933,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 111 + "lineNumber": 115 }, "signature": [ "\"experimental\" | \"beta\" | \"ga\"" @@ -13849,10 +13948,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 183 + "lineNumber": 187 }, "signature": [ - "{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; data_streams?: RegistryDataStream[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (", + "{ 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?: (", { "pluginId": "fleet", "scope": "common", @@ -13860,7 +13959,7 @@ "section": "def-common.PackageSpecIcon", "text": "PackageSpecIcon" }, - "[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; internal?: boolean | undefined; }" + "[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; }" ], "initialIsOpen": false }, @@ -13872,10 +13971,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 181 + "lineNumber": 185 }, "signature": [ - "Pick[]" + "Pick[]" ], "initialIsOpen": false }, @@ -13887,7 +13986,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 277 + "lineNumber": 281 }, "signature": [ "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" @@ -13902,7 +14001,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 371 + "lineNumber": 375 }, "signature": [ "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" @@ -13917,7 +14016,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 211 + "lineNumber": 215 }, "signature": [ "undefined | Record<\"kibana\", { version: string; }>" @@ -13932,7 +14031,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 172 + "lineNumber": 176 }, "signature": [ "string" @@ -13947,7 +14046,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 173 + "lineNumber": 177 }, "signature": [ "string" @@ -13962,7 +14061,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 199 + "lineNumber": 203 }, "signature": [ { @@ -14095,7 +14194,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 44 + "lineNumber": 47 }, "signature": [ "T[keyof T]" @@ -14484,6 +14583,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentPolicyRouteService.getInfoPath.$1", "type": "string", "label": "agentPolicyId", "isRequired": true, @@ -14530,6 +14630,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentPolicyRouteService.getUpdatePath.$1", "type": "string", "label": "agentPolicyId", "isRequired": true, @@ -14560,6 +14661,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentPolicyRouteService.getCopyPath.$1", "type": "string", "label": "agentPolicyId", "isRequired": true, @@ -14606,6 +14708,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentPolicyRouteService.getInfoFullPath.$1", "type": "string", "label": "agentPolicyId", "isRequired": true, @@ -14636,6 +14739,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath.$1", "type": "string", "label": "agentPolicyId", "isRequired": true, @@ -14695,6 +14799,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getInfoPath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -14725,6 +14830,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getUpdatePath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -14755,6 +14861,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getEventsPath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -14785,6 +14892,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getUnenrollPath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -14831,6 +14939,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getReassignPath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -14877,6 +14986,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getUpgradePath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -14955,6 +15065,7 @@ "type": "Function", "children": [ { + "id": "def-common.agentRouteService.getCreateActionPath.$1", "type": "string", "label": "agentId", "isRequired": true, @@ -15596,6 +15707,7 @@ "type": "Function", "children": [ { + "id": "def-common.enrollmentAPIKeyRouteService.getInfoPath.$1", "type": "string", "label": "keyId", "isRequired": true, @@ -15626,6 +15738,7 @@ "type": "Function", "children": [ { + "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath.$1", "type": "string", "label": "keyId", "isRequired": true, @@ -15842,6 +15955,7 @@ "type": "Function", "children": [ { + "id": "def-common.epmRouteService.getInfoPath.$1", "type": "string", "label": "pkgkey", "isRequired": true, @@ -15872,6 +15986,7 @@ "type": "Function", "children": [ { + "id": "def-common.epmRouteService.getStatsPath.$1", "type": "string", "label": "pkgName", "isRequired": true, @@ -15902,6 +16017,7 @@ "type": "Function", "children": [ { + "id": "def-common.epmRouteService.getFilePath.$1", "type": "string", "label": "filePath", "isRequired": true, @@ -15932,6 +16048,7 @@ "type": "Function", "children": [ { + "id": "def-common.epmRouteService.getInstallPath.$1", "type": "string", "label": "pkgkey", "isRequired": true, @@ -15978,6 +16095,7 @@ "type": "Function", "children": [ { + "id": "def-common.epmRouteService.getRemovePath.$1", "type": "string", "label": "pkgkey", "isRequired": true, @@ -16130,6 +16248,7 @@ "type": "Function", "children": [ { + "id": "def-common.outputRoutesService.getInfoPath.$1", "type": "string", "label": "outputId", "isRequired": true, @@ -16160,6 +16279,7 @@ "type": "Function", "children": [ { + "id": "def-common.outputRoutesService.getUpdatePath.$1", "type": "string", "label": "outputId", "isRequired": true, @@ -16320,6 +16440,7 @@ "type": "Function", "children": [ { + "id": "def-common.packagePolicyRouteService.getInfoPath.$1", "type": "string", "label": "packagePolicyId", "isRequired": true, @@ -16366,6 +16487,7 @@ "type": "Function", "children": [ { + "id": "def-common.packagePolicyRouteService.getUpdatePath.$1", "type": "string", "label": "packagePolicyId", "isRequired": true, @@ -16416,6 +16538,31 @@ }, "initialIsOpen": false }, + { + "id": "def-common.PRECONFIGURATION_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PRECONFIGURATION_API_ROUTES.PUT_PRECONFIG", + "type": "string", + "label": "PUT_PRECONFIG", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 125 + } + } + ], + "description": [], + "label": "PRECONFIGURATION_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 124 + }, + "initialIsOpen": false + }, { "tags": [], "id": "def-common.requiredPackages", diff --git a/api_docs/global_search.json b/api_docs/global_search.json index 0cb40be77a7a..25bdddff9561 100644 --- a/api_docs/global_search.json +++ b/api_docs/global_search.json @@ -28,13 +28,7 @@ "lineNumber": 89 }, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchResult", - "text": "GlobalSearchResult" - }, + "GlobalSearchResult", "[]" ] } @@ -296,13 +290,7 @@ "lineNumber": 62 }, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderResultUrl", - "text": "GlobalSearchProviderResultUrl" - } + "GlobalSearchProviderResultUrl" ] }, { @@ -332,13 +320,7 @@ }, "signature": [ "Record | undefined" ] } @@ -377,31 +359,13 @@ "label": "find", "signature": [ "(search: ", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchFindParams", - "text": "GlobalSearchFindParams" - }, + "GlobalSearchFindParams", ", options: ", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderFindOptions", - "text": "GlobalSearchProviderFindOptions" - }, + "GlobalSearchProviderFindOptions", ") => ", "Observable", "<", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderResult", - "text": "GlobalSearchProviderResult" - }, + "GlobalSearchProviderResult", "[]>" ], "description": [ @@ -409,17 +373,12 @@ ], "children": [ { + "id": "def-public.GlobalSearchResultProvider.find.$1", "type": "Object", "label": "search", "isRequired": true, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchFindParams", - "text": "GlobalSearchFindParams" - } + "GlobalSearchFindParams" ], "description": [], "source": { @@ -428,17 +387,12 @@ } }, { + "id": "def-public.GlobalSearchResultProvider.find.$2", "type": "Object", "label": "options", "isRequired": true, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderFindOptions", - "text": "GlobalSearchProviderFindOptions" - } + "GlobalSearchProviderFindOptions" ], "description": [], "source": { @@ -606,13 +560,7 @@ "lineNumber": 89 }, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchResult", - "text": "GlobalSearchResult" - }, + "GlobalSearchResult", "[]" ] } @@ -704,7 +652,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">; typeRegistry: Pick<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; typeRegistry: Pick<", { "pluginId": "core", "scope": "server", @@ -875,13 +823,7 @@ "lineNumber": 62 }, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderResultUrl", - "text": "GlobalSearchProviderResultUrl" - } + "GlobalSearchProviderResultUrl" ] }, { @@ -911,13 +853,7 @@ }, "signature": [ "Record | undefined" ] } @@ -958,21 +894,9 @@ "label": "find", "signature": [ "(search: ", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchFindParams", - "text": "GlobalSearchFindParams" - }, + "GlobalSearchFindParams", ", options: ", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderFindOptions", - "text": "GlobalSearchProviderFindOptions" - }, + "GlobalSearchProviderFindOptions", ", context: ", { "pluginId": "globalSearch", @@ -984,30 +908,19 @@ ") => ", "Observable", "<", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderResult", - "text": "GlobalSearchProviderResult" - } + "GlobalSearchProviderResult" ], "description": [ "\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n" ], "children": [ { + "id": "def-server.GlobalSearchResultProvider.find.$1", "type": "Object", "label": "search", "isRequired": true, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchFindParams", - "text": "GlobalSearchFindParams" - } + "GlobalSearchFindParams" ], "description": [], "source": { @@ -1016,17 +929,12 @@ } }, { + "id": "def-server.GlobalSearchResultProvider.find.$2", "type": "Object", "label": "options", "isRequired": true, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchProviderFindOptions", - "text": "GlobalSearchProviderFindOptions" - } + "GlobalSearchProviderFindOptions" ], "description": [], "source": { @@ -1035,6 +943,7 @@ } }, { + "id": "def-server.GlobalSearchResultProvider.find.$3", "type": "Object", "label": "context", "isRequired": true, @@ -1109,13 +1018,7 @@ "label": "find", "signature": [ "(params: ", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchFindParams", - "text": "GlobalSearchFindParams" - }, + "GlobalSearchFindParams", ", options: ", { "pluginId": "globalSearch", @@ -1127,13 +1030,7 @@ ") => ", "Observable", "<", - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchBatchedResults", - "text": "GlobalSearchBatchedResults" - }, + "GlobalSearchBatchedResults", ">" ], "description": [ @@ -1141,17 +1038,12 @@ ], "children": [ { + "id": "def-server.RouteHandlerGlobalSearchContext.find.$1", "type": "Object", "label": "params", "isRequired": true, "signature": [ - { - "pluginId": "globalSearch", - "scope": "common", - "docId": "kibGlobalSearchPluginApi", - "section": "def-common.GlobalSearchFindParams", - "text": "GlobalSearchFindParams" - } + "GlobalSearchFindParams" ], "description": [], "source": { @@ -1160,6 +1052,7 @@ } }, { + "id": "def-server.RouteHandlerGlobalSearchContext.find.$2", "type": "Object", "label": "options", "isRequired": true, diff --git a/api_docs/home.json b/api_docs/home.json index 9f2c7929503d..4e9ab0466f91 100644 --- a/api_docs/home.json +++ b/api_docs/home.json @@ -15,6 +15,7 @@ ], "children": [ { + "id": "def-public.getDisplayText.$1", "type": "CompoundType", "label": "id", "isRequired": true, @@ -889,13 +890,7 @@ "lineNumber": 179 }, "signature": [ - { - "pluginId": "home", - "scope": "public", - "docId": "kibHomePluginApi", - "section": "def-public.FeatureCatalogueRegistry", - "text": "FeatureCatalogueRegistry" - } + "FeatureCatalogueRegistry" ] } ], @@ -943,13 +938,7 @@ "lineNumber": 63 }, "signature": [ - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.DashboardSchema", - "text": "DashboardSchema" - }, + "DashboardSchema", "[]" ] }, @@ -1285,13 +1274,7 @@ "text": "TutorialProvider" }, ") => void; addScopedTutorialContextFactory: (scopedTutorialContextFactory: ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.ScopedTutorialContextFactory", - "text": "ScopedTutorialContextFactory" - }, + "ScopedTutorialContextFactory", ") => void; }" ] }, @@ -1315,37 +1298,13 @@ "text": "SampleDatasetProvider" }, ") => void; getSampleDatasets: () => ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.SampleDatasetSchema", - "text": "SampleDatasetSchema" - }, + "SampleDatasetSchema", "[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.AppLinkSchema", - "text": "AppLinkSchema" - }, + "AppLinkSchema", "[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", - { - "pluginId": "home", - "scope": "server", - "docId": "kibHomePluginApi", - "section": "def-server.SampleDatasetDashboardPanel", - "text": "SampleDatasetDashboardPanel" - } + "SampleDatasetDashboardPanel" ] } ], diff --git a/api_docs/index_management.json b/api_docs/index_management.json index 6c66a94bf59f..cea978352137 100644 --- a/api_docs/index_management.json +++ b/api_docs/index_management.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.getIndexListUri.$1", "type": "string", "label": "filter", "isRequired": false, @@ -21,6 +22,7 @@ } }, { + "id": "def-public.getIndexListUri.$2", "type": "CompoundType", "label": "includeHiddenIndices", "isRequired": false, @@ -228,13 +230,7 @@ "lineNumber": 14 }, "signature": [ - { - "pluginId": "indexManagement", - "scope": "public", - "docId": "kibIndexManagementPluginApi", - "section": "def-public.ExtensionsSetup", - "text": "ExtensionsSetup" - } + "ExtensionsSetup" ] } ], @@ -648,13 +644,7 @@ }, "signature": [ "{ add: (enricher: ", - { - "pluginId": "indexManagement", - "scope": "server", - "docId": "kibIndexManagementPluginApi", - "section": "def-server.Enricher", - "text": "Enricher" - }, + "Enricher", ") => void; }" ] } @@ -675,6 +665,7 @@ "type": "Function", "children": [ { + "id": "def-common.getTemplateParameter.$1", "type": "CompoundType", "label": "template", "isRequired": true, @@ -702,6 +693,7 @@ } }, { + "id": "def-common.getTemplateParameter.$2", "type": "CompoundType", "label": "setting", "isRequired": true, @@ -1280,13 +1272,7 @@ "lineNumber": 33 }, "signature": [ - { - "pluginId": "indexManagement", - "scope": "common", - "docId": "kibIndexManagementPluginApi", - "section": "def-common.DataStreamIndexFromEs", - "text": "DataStreamIndexFromEs" - }, + "DataStreamIndexFromEs", "[]" ] }, @@ -1326,13 +1312,7 @@ "lineNumber": 36 }, "signature": [ - { - "pluginId": "indexManagement", - "scope": "common", - "docId": "kibIndexManagementPluginApi", - "section": "def-common.HealthFromEs", - "text": "HealthFromEs" - } + "HealthFromEs" ] }, { diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json index f2ff1bea4733..00d77023c041 100644 --- a/api_docs/index_pattern_field_editor.json +++ b/api_docs/index_pattern_field_editor.json @@ -45,13 +45,7 @@ "lineNumber": 76 }, "signature": [ - { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.FormatEditorState", - "text": "FormatEditorState" - }, + "FormatEditorState", " & S" ] }, @@ -73,17 +67,12 @@ "description": [], "children": [ { + "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$1", "type": "Object", "label": "nextProps", "isRequired": true, "signature": [ - { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.FormatEditorProps", - "text": "FormatEditorProps" - }, + "FormatEditorProps", "<{}>" ], "description": [], @@ -93,17 +82,12 @@ } }, { + "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$2", "type": "Object", "label": "state", "isRequired": true, "signature": [ - { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.FormatEditorState", - "text": "FormatEditorState" - } + "FormatEditorState" ], "description": [], "source": { @@ -124,6 +108,7 @@ "type": "Function", "children": [ { + "id": "def-public.DefaultFormatEditor.onChange.$1", "type": "Object", "label": "newParams", "isRequired": true, @@ -215,13 +200,7 @@ "lineNumber": 33 }, "signature": [ - { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.InternalFieldType", - "text": "InternalFieldType" - } + "InternalFieldType" ] }, { @@ -418,6 +397,7 @@ "description": [], "children": [ { + "id": "def-public.PluginStart.openEditor.$1", "type": "Object", "label": "options", "isRequired": true, @@ -462,6 +442,7 @@ "description": [], "children": [ { + "id": "def-public.PluginStart.openDeleteModal.$1", "type": "Object", "label": "options", "isRequired": true, @@ -544,13 +525,7 @@ }, "signature": [ "React.FunctionComponent<", - { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.Props", - "text": "Props" - }, + "Props", ">" ] } diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json index 8a1a9bbdf10b..4ce56a42df20 100644 --- a/api_docs/index_pattern_management.json +++ b/api_docs/index_pattern_management.json @@ -94,7 +94,7 @@ "description": [], "children": [ { - "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }", + "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse", "type": "Object", "label": "{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }", "tags": [], @@ -102,7 +102,7 @@ "children": [ { "tags": [], - "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.type", + "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.type", "type": "string", "label": "type", "description": [], @@ -116,7 +116,7 @@ }, { "tags": [], - "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.name", + "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.name", "type": "string", "label": "name", "description": [], @@ -130,7 +130,7 @@ }, { "tags": [], - "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.showSystemIndices", + "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.showSystemIndices", "type": "CompoundType", "label": "showSystemIndices", "description": [], @@ -144,7 +144,7 @@ }, { "tags": [], - "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.httpClient", + "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.httpClient", "type": "CompoundType", "label": "httpClient", "description": [], @@ -158,7 +158,7 @@ }, { "tags": [], - "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.isBeta", + "id": "def-public.IndexPatternCreationConfig.Unnamed.$1.typeundefinednameindexPatternTypeNameshowSystemIndicestruehttpClientnullisBetafalse.isBeta", "type": "CompoundType", "label": "isBeta", "description": [], @@ -190,13 +190,7 @@ "label": "getIndexPatternCreationOption", "signature": [ "(urlHandler: ", - { - "pluginId": "indexPatternManagement", - "scope": "public", - "docId": "kibIndexPatternManagementPluginApi", - "section": "def-public.UrlHandler", - "text": "UrlHandler" - }, + "UrlHandler", ") => ", { "pluginId": "indexPatternManagement", @@ -209,17 +203,12 @@ "description": [], "children": [ { + "id": "def-public.IndexPatternCreationConfig.getIndexPatternCreationOption.$1", "type": "Function", "label": "urlHandler", "isRequired": true, "signature": [ - { - "pluginId": "indexPatternManagement", - "scope": "public", - "docId": "kibIndexPatternManagementPluginApi", - "section": "def-public.UrlHandler", - "text": "UrlHandler" - } + "UrlHandler" ], "description": [], "source": { @@ -309,6 +298,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPatternCreationConfig.getIndexTags.$1", "type": "string", "label": "indexName", "isRequired": true, @@ -335,29 +325,18 @@ "label": "checkIndicesForErrors", "signature": [ "(indices: ", - { - "pluginId": "indexPatternManagement", - "scope": "public", - "docId": "kibIndexPatternManagementPluginApi", - "section": "def-public.MatchedItem", - "text": "MatchedItem" - }, + "MatchedItem", "[]) => undefined" ], "description": [], "children": [ { + "id": "def-public.IndexPatternCreationConfig.checkIndicesForErrors.$1", "type": "Array", "label": "indices", "isRequired": true, "signature": [ - { - "pluginId": "indexPatternManagement", - "scope": "public", - "docId": "kibIndexPatternManagementPluginApi", - "section": "def-public.MatchedItem", - "text": "MatchedItem" - }, + "MatchedItem", "[]" ], "description": [], @@ -480,18 +459,13 @@ "text": "IIndexPattern" }, ">, isDefault: boolean) => ", - { - "pluginId": "indexPatternManagement", - "scope": "public", - "docId": "kibIndexPatternManagementPluginApi", - "section": "def-public.IndexPatternTag", - "text": "IndexPatternTag" - }, + "IndexPatternTag", "[]" ], "description": [], "children": [ { + "id": "def-public.IndexPatternListConfig.getIndexPatternTags.$1", "type": "CompoundType", "label": "indexPattern", "isRequired": true, @@ -528,6 +502,7 @@ } }, { + "id": "def-public.IndexPatternListConfig.getIndexPatternTags.$2", "type": "boolean", "label": "isDefault", "isRequired": true, @@ -574,6 +549,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPatternListConfig.getFieldInfo.$1", "type": "Object", "label": "indexPattern", "isRequired": true, @@ -593,6 +569,7 @@ } }, { + "id": "def-public.IndexPatternListConfig.getFieldInfo.$2", "type": "Object", "label": "field", "isRequired": true, @@ -637,6 +614,7 @@ "description": [], "children": [ { + "id": "def-public.IndexPatternListConfig.areScriptedFieldsEnabled.$1", "type": "Object", "label": "indexPattern", "isRequired": true, diff --git a/api_docs/infra.json b/api_docs/infra.json index 9d64df881fc5..a9511cd9a7c8 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -8,18 +8,13 @@ "type": "Function", "children": [ { + "id": "def-public.LazyLogStreamWrapper.$1", "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ "React.PropsWithChildren<", - { - "pluginId": "infra", - "scope": "public", - "docId": "kibInfraPluginApi", - "section": "def-public.LogStreamProps", - "text": "LogStreamProps" - }, + "LogStreamProps", ">" ], "description": [], @@ -198,10 +193,10 @@ "description": [], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 65 + "lineNumber": 64 }, "signature": [ - "{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; container?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly query: Readonly<{} & { partitionSize: number; partitionFactor: number; }>; }" + "{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; container?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }" ], "initialIsOpen": false } @@ -222,24 +217,18 @@ "description": [], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 76 + "lineNumber": 75 }, "signature": [ "(sourceId: string, sourceProperties: ", - { - "pluginId": "infra", - "scope": "common", - "docId": "kibInfraPluginApi", - "section": "def-common.InfraStaticSourceConfiguration", - "text": "InfraStaticSourceConfiguration" - }, + "InfraStaticSourceConfiguration", ") => void" ] } ], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 75 + "lineNumber": 74 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/ingest_pipelines.json b/api_docs/ingest_pipelines.json index 79fe652cf4db..27ca7ff70a43 100644 --- a/api_docs/ingest_pipelines.json +++ b/api_docs/ingest_pipelines.json @@ -37,6 +37,7 @@ "description": [], "children": [ { + "id": "def-public.IngestPipelinesUrlGenerator.Unnamed.$1", "type": "Function", "label": "getAppBasePath", "isRequired": true, @@ -76,6 +77,7 @@ "type": "Function", "children": [ { + "id": "def-public.IngestPipelinesUrlGenerator.createUrl.$1", "type": "CompoundType", "label": "state", "isRequired": true, diff --git a/api_docs/inspector.json b/api_docs/inspector.json index 2d42ec9fbff8..051541f2f4ac 100644 --- a/api_docs/inspector.json +++ b/api_docs/inspector.json @@ -54,13 +54,7 @@ "lineNumber": 55 }, "signature": [ - { - "pluginId": "inspector", - "scope": "public", - "docId": "kibInspectorPluginApi", - "section": "def-public.InspectorViewRegistry", - "text": "InspectorViewRegistry" - }, + "InspectorViewRegistry", " | undefined" ] }, @@ -74,6 +68,7 @@ "description": [], "children": [ { + "id": "def-public.InspectorPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -123,18 +118,13 @@ "text": "InspectorViewDescription" }, ") => void; __LEGACY: { views: ", - { - "pluginId": "inspector", - "scope": "public", - "docId": "kibInspectorPluginApi", - "section": "def-public.InspectorViewRegistry", - "text": "InspectorViewRegistry" - }, + "InspectorViewRegistry", "; }; }" ], "description": [], "children": [ { + "id": "def-public.InspectorPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -211,6 +201,7 @@ "description": [], "children": [ { + "id": "def-public.InspectorPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -304,13 +295,7 @@ "label": "start", "signature": [ "(name: string, params?: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestParams", - "text": "RequestParams" - }, + "RequestParams", ") => ", { "pluginId": "inspector", @@ -325,6 +310,7 @@ ], "children": [ { + "id": "def-public.RequestAdapter.start.$1", "type": "string", "label": "name", "isRequired": true, @@ -340,17 +326,12 @@ } }, { + "id": "def-public.RequestAdapter.start.$2", "type": "Object", "label": "params", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestParams", - "text": "RequestParams" - } + "RequestParams" ], "description": [], "source": { @@ -396,6 +377,7 @@ "description": [], "children": [ { + "id": "def-public.RequestAdapter.resetRequest.$1", "type": "string", "label": "id", "isRequired": true, @@ -422,13 +404,7 @@ "label": "getRequests", "signature": [ "() => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Request", - "text": "Request" - }, + "Request", "[]" ], "description": [], @@ -466,17 +442,12 @@ "description": [], "children": [ { + "id": "def-public.RequestResponder.Unnamed.$1", "type": "Object", "label": "request", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Request", - "text": "Request" - } + "Request" ], "description": [], "source": { @@ -485,6 +456,7 @@ } }, { + "id": "def-public.RequestResponder.Unnamed.$2", "type": "Function", "label": "onChange", "isRequired": true, @@ -522,6 +494,7 @@ "description": [], "children": [ { + "id": "def-public.RequestResponder.json.$1", "type": "Uncategorized", "label": "reqJson", "isRequired": true, @@ -567,6 +540,7 @@ "description": [], "children": [ { + "id": "def-public.RequestResponder.stats.$1", "type": "Object", "label": "stats", "isRequired": true, @@ -607,18 +581,13 @@ "text": "RequestStatus" }, ", response: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - }, + "Response", ") => void" ], "description": [], "children": [ { + "id": "def-public.RequestResponder.finish.$1", "type": "Enum", "label": "status", "isRequired": true, @@ -638,17 +607,12 @@ } }, { + "id": "def-public.RequestResponder.finish.$2", "type": "Object", "label": "response", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - } + "Response" ], "description": [], "source": { @@ -670,29 +634,18 @@ "label": "ok", "signature": [ "(response: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - }, + "Response", ") => void" ], "description": [], "children": [ { + "id": "def-public.RequestResponder.ok.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - } + "Response" ], "description": [], "source": { @@ -714,29 +667,18 @@ "label": "error", "signature": [ "(response: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - }, + "Response", ") => void" ], "description": [], "children": [ { + "id": "def-public.RequestResponder.error.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - } + "Response" ], "description": [], "source": { @@ -1196,13 +1138,7 @@ }, "signature": [ "{ views: ", - { - "pluginId": "inspector", - "scope": "public", - "docId": "kibInspectorPluginApi", - "section": "def-public.InspectorViewRegistry", - "text": "InspectorViewRegistry" - }, + "InspectorViewRegistry", "; }" ] } @@ -1350,13 +1286,7 @@ "label": "start", "signature": [ "(name: string, params?: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestParams", - "text": "RequestParams" - }, + "RequestParams", ") => ", { "pluginId": "inspector", @@ -1371,6 +1301,7 @@ ], "children": [ { + "id": "def-common.RequestAdapter.start.$1", "type": "string", "label": "name", "isRequired": true, @@ -1386,17 +1317,12 @@ } }, { + "id": "def-common.RequestAdapter.start.$2", "type": "Object", "label": "params", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestParams", - "text": "RequestParams" - } + "RequestParams" ], "description": [], "source": { @@ -1442,6 +1368,7 @@ "description": [], "children": [ { + "id": "def-common.RequestAdapter.resetRequest.$1", "type": "string", "label": "id", "isRequired": true, @@ -1468,13 +1395,7 @@ "label": "getRequests", "signature": [ "() => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Request", - "text": "Request" - }, + "Request", "[]" ], "description": [], @@ -1512,17 +1433,12 @@ "description": [], "children": [ { + "id": "def-common.RequestResponder.Unnamed.$1", "type": "Object", "label": "request", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Request", - "text": "Request" - } + "Request" ], "description": [], "source": { @@ -1531,6 +1447,7 @@ } }, { + "id": "def-common.RequestResponder.Unnamed.$2", "type": "Function", "label": "onChange", "isRequired": true, @@ -1568,6 +1485,7 @@ "description": [], "children": [ { + "id": "def-common.RequestResponder.json.$1", "type": "Uncategorized", "label": "reqJson", "isRequired": true, @@ -1613,6 +1531,7 @@ "description": [], "children": [ { + "id": "def-common.RequestResponder.stats.$1", "type": "Object", "label": "stats", "isRequired": true, @@ -1653,18 +1572,13 @@ "text": "RequestStatus" }, ", response: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - }, + "Response", ") => void" ], "description": [], "children": [ { + "id": "def-common.RequestResponder.finish.$1", "type": "Enum", "label": "status", "isRequired": true, @@ -1684,17 +1598,12 @@ } }, { + "id": "def-common.RequestResponder.finish.$2", "type": "Object", "label": "response", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - } + "Response" ], "description": [], "source": { @@ -1716,29 +1625,18 @@ "label": "ok", "signature": [ "(response: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - }, + "Response", ") => void" ], "description": [], "children": [ { + "id": "def-common.RequestResponder.ok.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - } + "Response" ], "description": [], "source": { @@ -1760,29 +1658,18 @@ "label": "error", "signature": [ "(response: ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - }, + "Response", ") => void" ], "description": [], "children": [ { + "id": "def-common.RequestResponder.error.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Response", - "text": "Response" - } + "Response" ], "description": [], "source": { diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json index f86d9eb480e5..2e4b8be78dcf 100644 --- a/api_docs/kibana_legacy.json +++ b/api_docs/kibana_legacy.json @@ -19,6 +19,7 @@ "description": [], "children": [ { + "id": "def-public.KibanaLegacyPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -60,18 +61,13 @@ "text": "CoreSetup" }, "<{}, { dashboardConfig: ", - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.DashboardConfig", - "text": "DashboardConfig" - }, + "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}" ], "description": [], "children": [ { + "id": "def-public.KibanaLegacyPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -84,13 +80,7 @@ "text": "CoreSetup" }, "<{}, { dashboardConfig: ", - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.DashboardConfig", - "text": "DashboardConfig" - }, + "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>" ], "description": [], @@ -121,18 +111,13 @@ "text": "CoreStart" }, ") => { dashboardConfig: ", - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.DashboardConfig", - "text": "DashboardConfig" - }, + "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" ], "description": [], "children": [ { + "id": "def-public.KibanaLegacyPlugin.start.$1", "type": "Object", "label": "{ application, http: { basePath }, uiSettings }", "isRequired": true, @@ -204,6 +189,7 @@ "description": [], "children": [ { + "id": "def-public.ToastNotifications.Unnamed.$1", "type": "Object", "label": "toasts", "isRequired": true, @@ -237,6 +223,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.onChange.$1", "type": "Function", "label": "callback", "isRequired": true, @@ -267,6 +254,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.add.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -318,6 +306,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.remove.$1", "type": "CompoundType", "label": "toast", "isRequired": true, @@ -362,6 +351,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.addSuccess.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -413,6 +403,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.addWarning.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -464,6 +455,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.addDanger.$1", "type": "CompoundType", "label": "toastOrTitle", "isRequired": true, @@ -515,6 +507,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToastNotifications.addError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -528,6 +521,7 @@ } }, { + "id": "def-public.ToastNotifications.addError.$2", "type": "Object", "label": "options", "isRequired": true, @@ -588,6 +582,7 @@ "type": "Function", "children": [ { + "id": "def-public.$setupXsrfRequestInterceptor.$1", "type": "string", "label": "version", "isRequired": true, @@ -640,6 +635,7 @@ "description": [], "children": [ { + "id": "def-public.addFatalError.$1", "type": "Object", "label": "fatalErrors", "isRequired": true, @@ -659,6 +655,7 @@ } }, { + "id": "def-public.addFatalError.$2", "type": "CompoundType", "label": "error", "isRequired": true, @@ -679,6 +676,7 @@ } }, { + "id": "def-public.addFatalError.$3", "type": "string", "label": "location", "isRequired": false, @@ -712,6 +710,7 @@ ], "children": [ { + "id": "def-public.addSystemApiHeader.$1", "type": "Object", "label": "originalHeaders", "isRequired": true, @@ -744,6 +743,7 @@ "type": "Function", "children": [ { + "id": "def-public.configureAppAngularModule.$1", "type": "Object", "label": "angularModule", "isRequired": true, @@ -757,7 +757,7 @@ } }, { - "id": "def-public.configureAppAngularModule.newPlatform", + "id": "def-public.configureAppAngularModule.$2.newPlatform", "type": "Object", "label": "newPlatform", "tags": [], @@ -765,7 +765,7 @@ "children": [ { "tags": [], - "id": "def-public.configureAppAngularModule.newPlatform.core", + "id": "def-public.configureAppAngularModule.$2.newPlatform.core", "type": "Object", "label": "core", "description": [], @@ -785,7 +785,7 @@ }, { "tags": [], - "id": "def-public.configureAppAngularModule.newPlatform.env", + "id": "def-public.configureAppAngularModule.$2.newPlatform.env", "type": "Object", "label": "env", "description": [], @@ -808,6 +808,7 @@ } }, { + "id": "def-public.configureAppAngularModule.$3", "type": "boolean", "label": "isLocalAngular", "isRequired": true, @@ -821,6 +822,7 @@ } }, { + "id": "def-public.configureAppAngularModule.$4", "type": "Function", "label": "getHistory", "isRequired": false, @@ -896,6 +898,7 @@ "description": [], "children": [ { + "id": "def-public.formatAngularHttpError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -928,6 +931,7 @@ "type": "Function", "children": [ { + "id": "def-public.formatESMsg.$1", "type": "CompoundType", "label": "err", "isRequired": true, @@ -968,6 +972,7 @@ ], "children": [ { + "id": "def-public.formatMsg.$1", "type": "CompoundType", "label": "err", "isRequired": true, @@ -981,6 +986,7 @@ } }, { + "id": "def-public.formatMsg.$2", "type": "string", "label": "source", "isRequired": true, @@ -1014,6 +1020,7 @@ "description": [], "children": [ { + "id": "def-public.formatStack.$1", "type": "Object", "label": "err", "isRequired": true, @@ -1060,6 +1067,7 @@ "description": [], "children": [ { + "id": "def-public.isAngularHttpError.$1", "type": "Any", "label": "error", "isRequired": true, @@ -1093,6 +1101,7 @@ ], "children": [ { + "id": "def-public.isSystemApiRequest.$1", "type": "Object", "label": "request", "isRequired": true, @@ -1130,6 +1139,7 @@ "description": [], "children": [ { + "id": "def-public.loadKbnTopNavDirectives.$1", "type": "Unknown", "label": "navUi", "isRequired": true, @@ -1178,6 +1188,7 @@ "description": [], "children": [ { + "id": "def-public.PaginateDirectiveProvider.$1", "type": "Any", "label": "$parse", "isRequired": true, @@ -1191,6 +1202,7 @@ } }, { + "id": "def-public.PaginateDirectiveProvider.$2", "type": "Any", "label": "$compile", "isRequired": true, @@ -1239,6 +1251,7 @@ "description": [], "children": [ { + "id": "def-public.PromiseServiceCreator.$1", "type": "Unknown", "label": "$q", "isRequired": true, @@ -1252,6 +1265,7 @@ } }, { + "id": "def-public.PromiseServiceCreator.$2", "type": "Unknown", "label": "$timeout", "isRequired": true, @@ -1283,6 +1297,7 @@ "description": [], "children": [ { + "id": "def-public.registerListenEventListener.$1", "type": "Unknown", "label": "$rootScope", "isRequired": true, @@ -1325,6 +1340,7 @@ ], "children": [ { + "id": "def-public.subscribeWithScope.$1", "type": "Object", "label": "$scope", "isRequired": true, @@ -1338,6 +1354,7 @@ } }, { + "id": "def-public.subscribeWithScope.$2", "type": "Object", "label": "observable", "isRequired": true, @@ -1352,6 +1369,7 @@ } }, { + "id": "def-public.subscribeWithScope.$3", "type": "CompoundType", "label": "observer", "isRequired": false, @@ -1370,6 +1388,7 @@ } }, { + "id": "def-public.subscribeWithScope.$4", "type": "Function", "label": "fatalError", "isRequired": false, @@ -1401,6 +1420,7 @@ "description": [], "children": [ { + "id": "def-public.watchMultiDecorator.$1", "type": "Unknown", "label": "$provide", "isRequired": true, diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json index 79ea4b3f6613..1085cf8f14bb 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -45,6 +45,7 @@ "description": [], "children": [ { + "id": "def-public.TableListView.Unnamed.$1", "type": "Object", "label": "props", "isRequired": true, @@ -207,7 +208,7 @@ "description": [], "children": [ { - "id": "def-public.TableListView.setFilter.{-queryText }", + "id": "def-public.TableListView.setFilter.$1.queryText", "type": "Object", "label": "{ queryText }", "tags": [], @@ -215,7 +216,7 @@ "children": [ { "tags": [], - "id": "def-public.TableListView.setFilter.{-queryText }.queryText", + "id": "def-public.TableListView.setFilter.$1.queryText.queryText", "type": "string", "label": "queryText", "description": [], @@ -302,22 +303,6 @@ "lineNumber": 319 } }, - { - "id": "def-public.TableListView.renderNoItemsMessage", - "type": "Function", - "label": "renderNoItemsMessage", - "signature": [ - "() => JSX.Element" - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 350 - } - }, { "id": "def-public.TableListView.renderToolsLeft", "type": "Function", @@ -331,7 +316,7 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 364 + "lineNumber": 350 } }, { @@ -347,7 +332,7 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 395 + "lineNumber": 381 } }, { @@ -363,7 +348,7 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 475 + "lineNumber": 461 } }, { @@ -379,7 +364,7 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 483 + "lineNumber": 468 } }, { @@ -395,7 +380,7 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 528 + "lineNumber": 513 } }, { @@ -411,7 +396,7 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", - "lineNumber": 540 + "lineNumber": 525 } } ], @@ -511,6 +496,7 @@ "description": [], "children": [ { + "id": "def-public.ValidatedDualRange.getDerivedStateFromProps.$1", "type": "Object", "label": "nextProps", "isRequired": true, @@ -524,6 +510,7 @@ } }, { + "id": "def-public.ValidatedDualRange.getDerivedStateFromProps.$2", "type": "Object", "label": "prevState", "isRequired": true, @@ -561,6 +548,7 @@ "type": "Function", "children": [ { + "id": "def-public.ValidatedDualRange._onChange.$1", "type": "Object", "label": "value", "isRequired": true, @@ -616,18 +604,13 @@ "type": "Function", "children": [ { + "id": "def-public.CodeEditor.$1", "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ "React.PropsWithChildren<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - }, + "Props", ">" ], "description": [], @@ -657,6 +640,7 @@ "type": "Function", "children": [ { + "id": "def-public.createKibanaReactContext.$1", "type": "Uncategorized", "label": "services", "isRequired": true, @@ -704,6 +688,7 @@ "type": "Function", "children": [ { + "id": "def-public.createNotifications.$1", "type": "Object", "label": "services", "isRequired": true, @@ -758,6 +743,7 @@ "type": "Function", "children": [ { + "id": "def-public.createReactOverlays.$1", "type": "Object", "label": "services", "isRequired": true, @@ -825,6 +811,7 @@ "description": [], "children": [ { + "id": "def-public.FieldButton.$1", "type": "Object", "label": "{\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}", "isRequired": true, @@ -872,6 +859,7 @@ ], "children": [ { + "id": "def-public.FieldIcon.$1", "type": "Object", "label": "{\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}", "isRequired": true, @@ -919,17 +907,12 @@ "type": "Function", "children": [ { + "id": "def-public.Markdown.$1", "type": "Object", "label": "props", "isRequired": true, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.MarkdownProps", - "text": "MarkdownProps" - } + "MarkdownProps" ], "description": [], "source": { @@ -958,17 +941,12 @@ "type": "Function", "children": [ { + "id": "def-public.MarkdownSimple.$1", "type": "Object", "label": "props", "isRequired": true, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.MarkdownSimpleProps", - "text": "MarkdownSimpleProps" - } + "MarkdownSimpleProps" ], "description": [], "source": { @@ -997,6 +975,7 @@ "type": "Function", "children": [ { + "id": "def-public.MountPointPortal.$1", "type": "CompoundType", "label": "{ children, setMountPoint }", "isRequired": true, @@ -1030,6 +1009,7 @@ "type": "Function", "children": [ { + "id": "def-public.OverviewPageFooter.$1", "type": "CompoundType", "label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}", "isRequired": true, @@ -1061,6 +1041,7 @@ "type": "Function", "children": [ { + "id": "def-public.OverviewPageHeader.$1", "type": "CompoundType", "label": "{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}", "isRequired": true, @@ -1099,17 +1080,12 @@ "description": [], "children": [ { + "id": "def-public.Panel.$1", "type": "Object", "label": "{ children, className, initialWidth = 100, style = {} }", "isRequired": true, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - } + "Props" ], "description": [], "source": { @@ -1138,17 +1114,12 @@ "description": [], "children": [ { + "id": "def-public.PanelsContainer.$1", "type": "Object", "label": "{\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}", "isRequired": true, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - } + "Props" ], "description": [], "source": { @@ -1170,6 +1141,7 @@ "type": "Function", "children": [ { + "id": "def-public.reactRouterNavigate.$1", "type": "CompoundType", "label": "history", "isRequired": true, @@ -1192,6 +1164,7 @@ } }, { + "id": "def-public.reactRouterNavigate.$2", "type": "CompoundType", "label": "to", "isRequired": true, @@ -1205,6 +1178,7 @@ } }, { + "id": "def-public.reactRouterNavigate.$3", "type": "Object", "label": "onClickCallback", "isRequired": false, @@ -1246,6 +1220,7 @@ "type": "Function", "children": [ { + "id": "def-public.reactRouterOnClickHandler.$1", "type": "CompoundType", "label": "history", "isRequired": true, @@ -1268,6 +1243,7 @@ } }, { + "id": "def-public.reactRouterOnClickHandler.$2", "type": "CompoundType", "label": "to", "isRequired": true, @@ -1281,6 +1257,7 @@ } }, { + "id": "def-public.reactRouterOnClickHandler.$3", "type": "Object", "label": "onClickCallback", "isRequired": false, @@ -1322,6 +1299,7 @@ "type": "Function", "children": [ { + "id": "def-public.reactToUiComponent.$1", "type": "CompoundType", "label": "ReactComp", "isRequired": true, @@ -1363,6 +1341,7 @@ "type": "Function", "children": [ { + "id": "def-public.RedirectAppLinks.$1", "type": "CompoundType", "label": "{\n application,\n children,\n className,\n ...otherProps\n}", "isRequired": true, @@ -1396,6 +1375,7 @@ "type": "Function", "children": [ { + "id": "def-public.toMountPoint.$1", "type": "CompoundType", "label": "node", "isRequired": false, @@ -1437,6 +1417,7 @@ "type": "Function", "children": [ { + "id": "def-public.ToolbarButton.$1", "type": "CompoundType", "label": "{\n children,\n className,\n fontWeight = 'normal',\n size = 'm',\n hasArrow = true,\n groupPosition = 'none',\n dataTestSubj = '',\n ...rest\n}", "isRequired": true, @@ -1484,6 +1465,7 @@ "type": "Function", "children": [ { + "id": "def-public.uiToReactComponent.$1", "type": "Function", "label": "Comp", "isRequired": true, @@ -1504,6 +1486,7 @@ } }, { + "id": "def-public.uiToReactComponent.$2", "type": "string", "label": "as", "isRequired": true, @@ -1545,6 +1528,7 @@ "type": "Function", "children": [ { + "id": "def-public.UrlTemplateEditor.$1", "type": "CompoundType", "label": "{\n height = 105,\n value,\n variables,\n onChange,\n onEditor,\n Editor = CodeEditor,\n}", "isRequired": true, @@ -1625,6 +1609,7 @@ "type": "Function", "children": [ { + "id": "def-public.UseKibana.$1", "type": "CompoundType", "label": "{ children }", "isRequired": true, @@ -1672,6 +1657,7 @@ "type": "Function", "children": [ { + "id": "def-public.useUiSetting.$1", "type": "string", "label": "key", "isRequired": true, @@ -1685,6 +1671,7 @@ } }, { + "id": "def-public.useUiSetting.$2", "type": "Uncategorized", "label": "defaultValue", "isRequired": false, @@ -1718,6 +1705,7 @@ "type": "Function", "children": [ { + "id": "def-public.useUiSetting$.$1", "type": "string", "label": "key", "isRequired": true, @@ -1731,6 +1719,7 @@ } }, { + "id": "def-public.useUiSetting$.$2", "type": "Uncategorized", "label": "defaultValue", "isRequired": false, @@ -1764,6 +1753,7 @@ "type": "Function", "children": [ { + "id": "def-public.withKibana.$1", "type": "CompoundType", "label": "type", "isRequired": true, @@ -2417,6 +2407,7 @@ "description": [], "children": [ { + "id": "def-public.TableListViewProps.deleteItems.$1", "type": "Array", "label": "items", "isRequired": true, @@ -2447,6 +2438,7 @@ "description": [], "children": [ { + "id": "def-public.TableListViewProps.editItem.$1", "type": "Uncategorized", "label": "item", "isRequired": true, @@ -2499,6 +2491,7 @@ "description": [], "children": [ { + "id": "def-public.TableListViewProps.findItems.$1", "type": "string", "label": "query", "isRequired": true, @@ -2768,13 +2761,7 @@ "lineNumber": 75 }, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchError", - "text": "HttpFetchError" - }, + "HttpFetchError", " | undefined" ] }, @@ -3014,21 +3001,9 @@ }, "signature": [ "React.FunctionComponent<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - }, + "Props", "> | React.ComponentClass<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - }, + "Props", ", any> | undefined" ] } @@ -3825,6 +3800,7 @@ "type": "Function", "children": [ { + "id": "def-common.EuiThemeProvider.$1", "type": "CompoundType", "label": "{\n darkMode = false,\n ...otherProps\n}", "isRequired": true, @@ -3939,7 +3915,7 @@ "lineNumber": 17 }, "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; disabled: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; } | { paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; disabled: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; } | { paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; }" ] }, { diff --git a/api_docs/kibana_utils.json b/api_docs/kibana_utils.json index da04f3be71b8..bd4d7e5e3157 100644 --- a/api_docs/kibana_utils.json +++ b/api_docs/kibana_utils.json @@ -31,6 +31,7 @@ "description": [], "children": [ { + "id": "def-public.AbortError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -162,6 +163,7 @@ "description": [], "children": [ { + "id": "def-public.DuplicateField.Unnamed.$1", "type": "string", "label": "name", "isRequired": true, @@ -240,6 +242,7 @@ ], "children": [ { + "id": "def-public.HashedItemStore.Unnamed.$1", "type": "Object", "label": "storage", "isRequired": true, @@ -270,6 +273,7 @@ "description": [], "children": [ { + "id": "def-public.HashedItemStore.setItem.$1", "type": "string", "label": "hash", "isRequired": true, @@ -283,6 +287,7 @@ } }, { + "id": "def-public.HashedItemStore.setItem.$2", "type": "string", "label": "item", "isRequired": true, @@ -313,6 +318,7 @@ "description": [], "children": [ { + "id": "def-public.HashedItemStore.getItem.$1", "type": "string", "label": "hash", "isRequired": true, @@ -343,6 +349,7 @@ "description": [], "children": [ { + "id": "def-public.HashedItemStore.removeItem.$1", "type": "string", "label": "hash", "isRequired": true, @@ -422,6 +429,7 @@ "description": [], "children": [ { + "id": "def-public.InvalidJSONProperty.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -431,7 +439,7 @@ "description": [], "source": { "path": "src/plugins/kibana_utils/common/errors/errors.ts", - "lineNumber": 56 + "lineNumber": 74 } } ], @@ -439,13 +447,13 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_utils/common/errors/errors.ts", - "lineNumber": 56 + "lineNumber": 74 } } ], "source": { "path": "src/plugins/kibana_utils/common/errors/errors.ts", - "lineNumber": 55 + "lineNumber": 73 }, "initialIsOpen": false }, @@ -476,6 +484,7 @@ "description": [], "children": [ { + "id": "def-public.KbnError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -522,6 +531,7 @@ "description": [], "children": [ { + "id": "def-public.RenderCompleteDispatcher.Unnamed.$1", "type": "Object", "label": "el", "isRequired": false, @@ -552,6 +562,7 @@ "description": [], "children": [ { + "id": "def-public.RenderCompleteDispatcher.setEl.$1", "type": "Object", "label": "el", "isRequired": false, @@ -630,6 +641,7 @@ "description": [], "children": [ { + "id": "def-public.RenderCompleteDispatcher.setTitle.$1", "type": "string", "label": "title", "isRequired": true, @@ -674,6 +686,7 @@ "description": [], "children": [ { + "id": "def-public.RenderCompleteListener.Unnamed.$1", "type": "Object", "label": "element", "isRequired": true, @@ -779,6 +792,7 @@ "description": [], "children": [ { + "id": "def-public.ResizeChecker.Unnamed.$1", "type": "Object", "label": "el", "isRequired": true, @@ -792,7 +806,7 @@ } }, { - "id": "def-public.ResizeChecker.Unnamed.args", + "id": "def-public.ResizeChecker.Unnamed.$2.args", "type": "Object", "label": "args", "tags": [], @@ -800,7 +814,7 @@ "children": [ { "tags": [], - "id": "def-public.ResizeChecker.Unnamed.args.disabled", + "id": "def-public.ResizeChecker.Unnamed.$2.args.disabled", "type": "CompoundType", "label": "disabled", "description": [], @@ -854,6 +868,7 @@ ], "children": [ { + "id": "def-public.ResizeChecker.modifySizeWithoutTriggeringResize.$1", "type": "Function", "label": "block", "isRequired": true, @@ -899,6 +914,134 @@ }, "initialIsOpen": false }, + { + "id": "def-public.SavedFieldNotFound", + "type": "Class", + "tags": [], + "label": "SavedFieldNotFound", + "description": [ + "\nA saved field doesn't exist anymore" + ], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SavedFieldNotFound", + "text": "SavedFieldNotFound" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } + ], + "children": [ + { + "id": "def-public.SavedFieldNotFound.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.SavedFieldNotFound.Unnamed.$1", + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 54 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 54 + } + } + ], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 53 + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedFieldTypeInvalidForAgg", + "type": "Class", + "tags": [], + "label": "SavedFieldTypeInvalidForAgg", + "description": [ + "\nA saved field type isn't compatible with aggregation" + ], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SavedFieldTypeInvalidForAgg", + "text": "SavedFieldTypeInvalidForAgg" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } + ], + "children": [ + { + "id": "def-public.SavedFieldTypeInvalidForAgg.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.SavedFieldTypeInvalidForAgg.Unnamed.$1", + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 63 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 63 + } + } + ], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 62 + }, + "initialIsOpen": false + }, { "id": "def-public.SavedObjectNotFound", "type": "Class", @@ -960,6 +1103,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectNotFound.Unnamed.$1", "type": "string", "label": "type", "isRequired": true, @@ -973,6 +1117,7 @@ } }, { + "id": "def-public.SavedObjectNotFound.Unnamed.$2", "type": "string", "label": "id", "isRequired": false, @@ -986,6 +1131,7 @@ } }, { + "id": "def-public.SavedObjectNotFound.Unnamed.$3", "type": "string", "label": "link", "isRequired": false, @@ -997,6 +1143,20 @@ "path": "src/plugins/kibana_utils/common/errors/errors.ts", "lineNumber": 35 } + }, + { + "id": "def-public.SavedObjectNotFound.Unnamed.$4", + "type": "string", + "label": "customMessage", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 35 + } } ], "tags": [], @@ -1069,6 +1229,7 @@ "description": [], "children": [ { + "id": "def-public.Storage.Unnamed.$1", "type": "Object", "label": "store", "isRequired": true, @@ -1101,6 +1262,7 @@ "type": "Function", "children": [ { + "id": "def-public.Storage.get.$1", "type": "string", "label": "key", "isRequired": true, @@ -1131,6 +1293,7 @@ "type": "Function", "children": [ { + "id": "def-public.Storage.set.$1", "type": "string", "label": "key", "isRequired": true, @@ -1144,6 +1307,7 @@ } }, { + "id": "def-public.Storage.set.$2", "type": "Any", "label": "value", "isRequired": true, @@ -1174,6 +1338,7 @@ "type": "Function", "children": [ { + "id": "def-public.Storage.remove.$1", "type": "string", "label": "key", "isRequired": true, @@ -1236,6 +1401,7 @@ ], "children": [ { + "id": "def-public.abortSignalToPromise.$1", "type": "Object", "label": "signal", "isRequired": true, @@ -1270,6 +1436,7 @@ "description": [], "children": [ { + "id": "def-public.applyDiff.$1", "type": "Object", "label": "target", "isRequired": true, @@ -1283,6 +1450,7 @@ } }, { + "id": "def-public.applyDiff.$2", "type": "Object", "label": "source", "isRequired": true, @@ -1324,6 +1492,7 @@ "type": "Function", "children": [ { + "id": "def-public.createGetterSetter.$1", "type": "string", "label": "name", "isRequired": true, @@ -1386,6 +1555,7 @@ ], "children": [ { + "id": "def-public.createHistoryObservable.$1", "type": "Object", "label": "history", "isRequired": true, @@ -1415,6 +1585,7 @@ "type": "Function", "children": [ { + "id": "def-public.createKbnUrlControls.$1", "type": "Object", "label": "history", "isRequired": true, @@ -1450,7 +1621,7 @@ "type": "Function", "children": [ { - "id": "def-public.createKbnUrlStateStorage.{\n- useHash = false,\n history,\n onGetError,\n onSetError,\n }", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError", "type": "Object", "label": "{\n useHash = false,\n history,\n onGetError,\n onSetError,\n }", "tags": [], @@ -1458,7 +1629,7 @@ "children": [ { "tags": [], - "id": "def-public.createKbnUrlStateStorage.{\n- useHash = false,\n history,\n onGetError,\n onSetError,\n }.useHash", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.useHash", "type": "boolean", "label": "useHash", "description": [], @@ -1469,7 +1640,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlStateStorage.{\n- useHash = false,\n history,\n onGetError,\n onSetError,\n }.history", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.history", "type": "Object", "label": "history", "description": [], @@ -1484,7 +1655,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlStateStorage.{\n- useHash = false,\n history,\n onGetError,\n onSetError,\n }.onGetError", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.onGetError", "type": "Function", "label": "onGetError", "description": [], @@ -1498,7 +1669,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlStateStorage.{\n- useHash = false,\n history,\n onGetError,\n onSetError,\n }.onSetError", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.onSetError", "type": "Function", "label": "onSetError", "description": [], @@ -1578,7 +1749,7 @@ ], "children": [ { - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink", "type": "Object", "label": "{\n baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}", "tags": [], @@ -1586,7 +1757,7 @@ "children": [ { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.baseUrl", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.baseUrl", "type": "string", "label": "baseUrl", "description": [ @@ -1599,7 +1770,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.defaultSubUrl", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.defaultSubUrl", "type": "string", "label": "defaultSubUrl", "description": [ @@ -1612,7 +1783,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.stateParams", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.stateParams", "type": "Array", "label": "stateParams", "description": [ @@ -1630,7 +1801,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.storageKey", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.storageKey", "type": "string", "label": "storageKey", "description": [ @@ -1643,7 +1814,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.navLinkUpdater$", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.navLinkUpdater$", "type": "Object", "label": "navLinkUpdater$", "description": [ @@ -1668,7 +1839,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.toastNotifications", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.toastNotifications", "type": "Object", "label": "toastNotifications", "description": [ @@ -1692,7 +1863,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.history", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.history", "type": "Object", "label": "history", "description": [ @@ -1709,7 +1880,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.getHistory", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.getHistory", "type": "Function", "label": "getHistory", "description": [ @@ -1727,7 +1898,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.storage", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.storage", "type": "Object", "label": "storage", "description": [ @@ -1743,7 +1914,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.shouldTrackUrlUpdate", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.shouldTrackUrlUpdate", "type": "Function", "label": "shouldTrackUrlUpdate", "description": [ @@ -1759,7 +1930,7 @@ }, { "tags": [], - "id": "def-public.createKbnUrlTracker.{\n- baseUrl,\n defaultSubUrl,\n storageKey,\n stateParams,\n navLinkUpdater$,\n toastNotifications,\n history,\n getHistory,\n storage,\n shouldTrackUrlUpdate = () => {\n return true;\n },\n onBeforeNavLinkSaved = (newNavLink) => newNavLink,\n}.onBeforeNavLinkSaved", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.onBeforeNavLinkSaved", "type": "Function", "label": "onBeforeNavLinkSaved", "description": [ @@ -1804,6 +1975,7 @@ ], "children": [ { + "id": "def-public.createQueryParamObservable.$1", "type": "Object", "label": "history", "isRequired": true, @@ -1820,6 +1992,7 @@ } }, { + "id": "def-public.createQueryParamObservable.$2", "type": "string", "label": "paramKey", "isRequired": true, @@ -1861,6 +2034,7 @@ ], "children": [ { + "id": "def-public.createQueryParamsObservable.$1", "type": "Object", "label": "history", "isRequired": true, @@ -1890,6 +2064,7 @@ "type": "Function", "children": [ { + "id": "def-public.createSessionStorageStateStorage.$1", "type": "Object", "label": "storage", "isRequired": true, @@ -1934,6 +2109,7 @@ "type": "Function", "children": [ { + "id": "def-public.createStartServicesGetter.$1", "type": "Function", "label": "accessor", "isRequired": true, @@ -2015,6 +2191,7 @@ ], "children": [ { + "id": "def-public.createStateContainer.$1", "type": "Uncategorized", "label": "defaultState", "isRequired": true, @@ -2060,6 +2237,7 @@ ], "children": [ { + "id": "def-public.createStateContainer.$1", "type": "Uncategorized", "label": "defaultState", "isRequired": true, @@ -2075,6 +2253,7 @@ } }, { + "id": "def-public.createStateContainer.$2", "type": "Uncategorized", "label": "pureTransitions", "isRequired": true, @@ -2128,6 +2307,7 @@ ], "children": [ { + "id": "def-public.createStateContainer.$1", "type": "Uncategorized", "label": "defaultState", "isRequired": true, @@ -2143,6 +2323,7 @@ } }, { + "id": "def-public.createStateContainer.$2", "type": "Uncategorized", "label": "pureTransitions", "isRequired": true, @@ -2158,6 +2339,7 @@ } }, { + "id": "def-public.createStateContainer.$3", "type": "Uncategorized", "label": "pureSelectors", "isRequired": true, @@ -2173,6 +2355,7 @@ } }, { + "id": "def-public.createStateContainer.$4", "type": "Object", "label": "options", "isRequired": false, @@ -2275,6 +2458,7 @@ "description": [], "children": [ { + "id": "def-public.createStateHash.$1", "type": "string", "label": "json", "isRequired": true, @@ -2288,6 +2472,7 @@ } }, { + "id": "def-public.createStateHash.$2", "type": "Function", "label": "existingJsonProvider", "isRequired": false, @@ -2322,6 +2507,7 @@ ], "children": [ { + "id": "def-public.createUrlTracker.$1", "type": "string", "label": "key", "isRequired": true, @@ -2335,6 +2521,7 @@ } }, { + "id": "def-public.createUrlTracker.$2", "type": "Object", "label": "storage", "isRequired": true, @@ -2391,6 +2578,7 @@ "description": [], "children": [ { + "id": "def-public.dispatchRenderComplete.$1", "type": "Object", "label": "el", "isRequired": true, @@ -2422,6 +2610,7 @@ "description": [], "children": [ { + "id": "def-public.dispatchRenderStart.$1", "type": "Object", "label": "el", "isRequired": true, @@ -2453,6 +2642,7 @@ "description": [], "children": [ { + "id": "def-public.fieldWildcardFilter.$1", "type": "Array", "label": "globs", "isRequired": true, @@ -2466,6 +2656,7 @@ } }, { + "id": "def-public.fieldWildcardFilter.$2", "type": "Array", "label": "metaFields", "isRequired": true, @@ -2497,6 +2688,7 @@ "description": [], "children": [ { + "id": "def-public.fieldWildcardMatcher.$1", "type": "Array", "label": "globs", "isRequired": true, @@ -2510,6 +2702,7 @@ } }, { + "id": "def-public.fieldWildcardMatcher.$2", "type": "Array", "label": "metaFields", "isRequired": true, @@ -2531,39 +2724,6 @@ }, "initialIsOpen": false }, - { - "id": "def-public.getCombinedAbortSignal", - "type": "Function", - "label": "getCombinedAbortSignal", - "signature": [ - "(signals: AbortSignal[]) => { signal: AbortSignal; cleanup: () => void; }" - ], - "description": [ - "\nReturns an `AbortSignal` that will be aborted when the first of the given signals aborts.\n" - ], - "children": [ - { - "type": "Array", - "label": "signals", - "isRequired": true, - "signature": [ - "AbortSignal[]" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_utils/common/abort_utils.ts", - "lineNumber": 55 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_utils/common/abort_utils.ts", - "lineNumber": 54 - }, - "initialIsOpen": false - }, { "id": "def-public.getQueryParams", "type": "Function", @@ -2578,6 +2738,7 @@ "description": [], "children": [ { + "id": "def-public.getQueryParams.$1", "type": "Object", "label": "location", "isRequired": true, @@ -2612,6 +2773,7 @@ ], "children": [ { + "id": "def-public.getStateFromKbnUrl.$1", "type": "string", "label": "key", "isRequired": true, @@ -2625,6 +2787,7 @@ } }, { + "id": "def-public.getStateFromKbnUrl.$2", "type": "string", "label": "url", "isRequired": true, @@ -2638,7 +2801,7 @@ } }, { - "id": "def-public.getStateFromKbnUrl.{-getFromHashQuery = true }", + "id": "def-public.getStateFromKbnUrl.$3.getFromHashQuerytrue", "type": "Object", "label": "{ getFromHashQuery = true }", "tags": [], @@ -2646,7 +2809,7 @@ "children": [ { "tags": [], - "id": "def-public.getStateFromKbnUrl.{-getFromHashQuery = true }.getFromHashQuery", + "id": "def-public.getStateFromKbnUrl.$3.getFromHashQuerytrue.getFromHashQuery", "type": "boolean", "label": "getFromHashQuery", "description": [], @@ -2682,6 +2845,7 @@ ], "children": [ { + "id": "def-public.getStatesFromKbnUrl.$1", "type": "string", "label": "url", "isRequired": true, @@ -2695,6 +2859,7 @@ } }, { + "id": "def-public.getStatesFromKbnUrl.$2", "type": "Array", "label": "keys", "isRequired": false, @@ -2708,7 +2873,7 @@ } }, { - "id": "def-public.getStatesFromKbnUrl.{-getFromHashQuery = true }", + "id": "def-public.getStatesFromKbnUrl.$3.getFromHashQuerytrue", "type": "Object", "label": "{ getFromHashQuery = true }", "tags": [], @@ -2716,7 +2881,7 @@ "children": [ { "tags": [], - "id": "def-public.getStatesFromKbnUrl.{-getFromHashQuery = true }.getFromHashQuery", + "id": "def-public.getStatesFromKbnUrl.$3.getFromHashQuerytrue.getFromHashQuery", "type": "boolean", "label": "getFromHashQuery", "description": [], @@ -2780,6 +2945,7 @@ "description": [], "children": [ { + "id": "def-public.isStateHash.$1", "type": "string", "label": "str", "isRequired": true, @@ -2806,6 +2972,7 @@ "type": "Function", "children": [ { + "id": "def-public.of.$1", "type": "Object", "label": "promise", "isRequired": true, @@ -2844,6 +3011,7 @@ "description": [], "children": [ { + "id": "def-public.persistState.$1", "type": "Uncategorized", "label": "state", "isRequired": true, @@ -2910,7 +3078,7 @@ ], "children": [ { - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect", "type": "Object", "label": "{\n history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}", "tags": [], @@ -2918,7 +3086,7 @@ "children": [ { "tags": [], - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}.history", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.history", "type": "Object", "label": "history", "description": [], @@ -2933,7 +3101,7 @@ }, { "tags": [], - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}.navigateToApp", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.navigateToApp", "type": "Function", "label": "navigateToApp", "description": [], @@ -2955,7 +3123,7 @@ }, { "tags": [], - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}.basePath", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.basePath", "type": "Object", "label": "basePath", "description": [], @@ -2975,7 +3143,7 @@ }, { "tags": [], - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}.mapping", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.mapping", "type": "CompoundType", "label": "mapping", "description": [ @@ -2991,7 +3159,7 @@ }, { "tags": [], - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}.toastNotifications", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.toastNotifications", "type": "Object", "label": "toastNotifications", "description": [ @@ -3015,7 +3183,7 @@ }, { "tags": [], - "id": "def-public.redirectWhenMissing.{\n- history,\n navigateToApp,\n basePath,\n mapping,\n toastNotifications,\n onBeforeRedirect,\n}.onBeforeRedirect", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.onBeforeRedirect", "type": "Function", "label": "onBeforeRedirect", "description": [ @@ -3064,6 +3232,7 @@ "description": [], "children": [ { + "id": "def-public.removeQueryParam.$1", "type": "Object", "label": "history", "isRequired": true, @@ -3078,6 +3247,7 @@ } }, { + "id": "def-public.removeQueryParam.$2", "type": "string", "label": "param", "isRequired": true, @@ -3091,6 +3261,7 @@ } }, { + "id": "def-public.removeQueryParam.$3", "type": "boolean", "label": "replace", "isRequired": true, @@ -3126,6 +3297,7 @@ "description": [], "children": [ { + "id": "def-public.replaceUrlHashQuery.$1", "type": "string", "label": "rawUrl", "isRequired": true, @@ -3139,6 +3311,7 @@ } }, { + "id": "def-public.replaceUrlHashQuery.$2", "type": "Function", "label": "queryReplacer", "isRequired": true, @@ -3178,6 +3351,7 @@ "description": [], "children": [ { + "id": "def-public.replaceUrlQuery.$1", "type": "string", "label": "rawUrl", "isRequired": true, @@ -3191,6 +3365,7 @@ } }, { + "id": "def-public.replaceUrlQuery.$2", "type": "Function", "label": "queryReplacer", "isRequired": true, @@ -3226,6 +3401,7 @@ "description": [], "children": [ { + "id": "def-public.retrieveState.$1", "type": "string", "label": "stateHash", "isRequired": true, @@ -3259,6 +3435,7 @@ ], "children": [ { + "id": "def-public.setStateToKbnUrl.$1", "type": "string", "label": "key", "isRequired": true, @@ -3272,6 +3449,7 @@ } }, { + "id": "def-public.setStateToKbnUrl.$2", "type": "Uncategorized", "label": "state", "isRequired": true, @@ -3285,7 +3463,7 @@ } }, { - "id": "def-public.setStateToKbnUrl.{-useHash = false, storeInHashQuery = true }", + "id": "def-public.setStateToKbnUrl.$3.useHashfalsestoreInHashQuerytrue", "type": "Object", "label": "{ useHash = false, storeInHashQuery = true }", "tags": [], @@ -3293,7 +3471,7 @@ "children": [ { "tags": [], - "id": "def-public.setStateToKbnUrl.{-useHash = false, storeInHashQuery = true }.useHash", + "id": "def-public.setStateToKbnUrl.$3.useHashfalsestoreInHashQuerytrue.useHash", "type": "boolean", "label": "useHash", "description": [], @@ -3304,7 +3482,7 @@ }, { "tags": [], - "id": "def-public.setStateToKbnUrl.{-useHash = false, storeInHashQuery = true }.storeInHashQuery", + "id": "def-public.setStateToKbnUrl.$3.useHashfalsestoreInHashQuerytrue.storeInHashQuery", "type": "CompoundType", "label": "storeInHashQuery", "description": [], @@ -3323,6 +3501,7 @@ } }, { + "id": "def-public.setStateToKbnUrl.$4", "type": "string", "label": "rawUrl", "isRequired": true, @@ -3376,6 +3555,7 @@ ], "children": [ { + "id": "def-public.syncState.$1", "type": "Object", "label": "{\n storageKey,\n stateStorage,\n stateContainer,\n}", "isRequired": true, @@ -3388,13 +3568,7 @@ "text": "IStateSyncConfig" }, "" ], "description": [], @@ -3446,6 +3620,7 @@ "description": [], "children": [ { + "id": "def-public.syncStates.$1", "type": "Array", "label": "stateSyncConfigs", "isRequired": true, @@ -3458,13 +3633,7 @@ "text": "IStateSyncConfig" }, "[]" ], "description": [ @@ -3519,6 +3688,7 @@ "type": "Function", "children": [ { + "id": "def-public.useContainerSelector.$1", "type": "Uncategorized", "label": "container", "isRequired": true, @@ -3532,6 +3702,7 @@ } }, { + "id": "def-public.useContainerSelector.$2", "type": "Function", "label": "selector", "isRequired": true, @@ -3553,6 +3724,7 @@ } }, { + "id": "def-public.useContainerSelector.$3", "type": "Function", "label": "comparator", "isRequired": true, @@ -3621,6 +3793,7 @@ "type": "Function", "children": [ { + "id": "def-public.useContainerState.$1", "type": "Uncategorized", "label": "container", "isRequired": true, @@ -3674,6 +3847,7 @@ "type": "Function", "children": [ { + "id": "def-public.withNotifyOnErrors.$1", "type": "Object", "label": "toasts", "isRequired": true, @@ -4091,13 +4265,7 @@ "lineNumber": 50 }, "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IKbnUrlControls", - "text": "IKbnUrlControls" - } + "IKbnUrlControls" ] } ], @@ -4741,13 +4909,7 @@ }, "signature": [ "(action: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.TransitionDescription", - "text": "TransitionDescription" - }, + "TransitionDescription", ") => void" ] }, @@ -4901,13 +5063,7 @@ }, "signature": [ "Readonly<", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.PureTransitionsToTransitions", - "text": "PureTransitionsToTransitions" - }, + "PureTransitionsToTransitions", ">" ] }, @@ -4971,6 +5127,7 @@ ], "children": [ { + "id": "def-public.UiComponentInstance.render.$1", "type": "Object", "label": "el", "isRequired": true, @@ -4986,6 +5143,7 @@ } }, { + "id": "def-public.UiComponentInstance.render.$2", "type": "Uncategorized", "label": "props", "isRequired": true, @@ -5546,13 +5704,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.encodeUriQuery", - "text": "encodeUriQuery" - } + "encodeUriQuery" ] }, { @@ -5611,6 +5763,7 @@ "description": [], "children": [ { + "id": "def-server.AbortError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -5686,6 +5839,7 @@ "description": [], "children": [ { + "id": "def-server.KbnServerError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -5699,6 +5853,7 @@ } }, { + "id": "def-server.KbnServerError.Unnamed.$2", "type": "number", "label": "statusCode", "isRequired": true, @@ -5712,6 +5867,7 @@ } }, { + "id": "def-server.KbnServerError.Unnamed.$3", "type": "Object", "label": "errBody", "isRequired": false, @@ -5753,6 +5909,7 @@ ], "children": [ { + "id": "def-server.abortSignalToPromise.$1", "type": "Object", "label": "signal", "isRequired": true, @@ -5781,6 +5938,7 @@ "type": "Function", "children": [ { + "id": "def-server.createGetterSetter.$1", "type": "string", "label": "name", "isRequired": true, @@ -5833,6 +5991,7 @@ "description": [], "children": [ { + "id": "def-server.fieldWildcardFilter.$1", "type": "Array", "label": "globs", "isRequired": true, @@ -5846,6 +6005,7 @@ } }, { + "id": "def-server.fieldWildcardFilter.$2", "type": "Array", "label": "metaFields", "isRequired": true, @@ -5877,6 +6037,7 @@ "description": [], "children": [ { + "id": "def-server.fieldWildcardMatcher.$1", "type": "Array", "label": "globs", "isRequired": true, @@ -5890,6 +6051,7 @@ } }, { + "id": "def-server.fieldWildcardMatcher.$2", "type": "Array", "label": "metaFields", "isRequired": true, @@ -5911,39 +6073,6 @@ }, "initialIsOpen": false }, - { - "id": "def-server.getCombinedAbortSignal", - "type": "Function", - "label": "getCombinedAbortSignal", - "signature": [ - "(signals: AbortSignal[]) => { signal: AbortSignal; cleanup: () => void; }" - ], - "description": [ - "\nReturns an `AbortSignal` that will be aborted when the first of the given signals aborts.\n" - ], - "children": [ - { - "type": "Array", - "label": "signals", - "isRequired": true, - "signature": [ - "AbortSignal[]" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_utils/common/abort_utils.ts", - "lineNumber": 55 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_utils/common/abort_utils.ts", - "lineNumber": 54 - }, - "initialIsOpen": false - }, { "id": "def-server.getKbnServerError", "type": "Function", @@ -5963,6 +6092,7 @@ ], "children": [ { + "id": "def-server.getKbnServerError.$1", "type": "Object", "label": "e", "isRequired": true, @@ -6021,6 +6151,7 @@ ], "children": [ { + "id": "def-server.reportServerError.$1", "type": "Object", "label": "res", "isRequired": true, @@ -6036,13 +6167,7 @@ "text": "CustomHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - }, + "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", @@ -6052,13 +6177,7 @@ "text": "ErrorHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - } + "KibanaResponse" ], "description": [ "Formats a `KbnServerError` into a server error response" @@ -6069,6 +6188,7 @@ } }, { + "id": "def-server.reportServerError.$2", "type": "Object", "label": "err", "isRequired": true, @@ -6167,13 +6287,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.encodeUriQuery", - "text": "encodeUriQuery" - } + "encodeUriQuery" ] }, { @@ -6232,6 +6346,7 @@ "description": [], "children": [ { + "id": "def-common.AbortError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -6363,6 +6478,7 @@ "description": [], "children": [ { + "id": "def-common.DuplicateField.Unnamed.$1", "type": "string", "label": "name", "isRequired": true, @@ -6426,6 +6542,7 @@ "description": [], "children": [ { + "id": "def-common.InvalidJSONProperty.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -6435,7 +6552,7 @@ "description": [], "source": { "path": "src/plugins/kibana_utils/common/errors/errors.ts", - "lineNumber": 56 + "lineNumber": 74 } } ], @@ -6443,13 +6560,13 @@ "returnComment": [], "source": { "path": "src/plugins/kibana_utils/common/errors/errors.ts", - "lineNumber": 56 + "lineNumber": 74 } } ], "source": { "path": "src/plugins/kibana_utils/common/errors/errors.ts", - "lineNumber": 55 + "lineNumber": 73 }, "initialIsOpen": false }, @@ -6480,6 +6597,7 @@ "description": [], "children": [ { + "id": "def-common.KbnError.Unnamed.$1", "type": "string", "label": "message", "isRequired": true, @@ -6507,6 +6625,134 @@ }, "initialIsOpen": false }, + { + "id": "def-common.SavedFieldNotFound", + "type": "Class", + "tags": [], + "label": "SavedFieldNotFound", + "description": [ + "\nA saved field doesn't exist anymore" + ], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SavedFieldNotFound", + "text": "SavedFieldNotFound" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } + ], + "children": [ + { + "id": "def-common.SavedFieldNotFound.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-common.SavedFieldNotFound.Unnamed.$1", + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 54 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 54 + } + } + ], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 53 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedFieldTypeInvalidForAgg", + "type": "Class", + "tags": [], + "label": "SavedFieldTypeInvalidForAgg", + "description": [ + "\nA saved field type isn't compatible with aggregation" + ], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SavedFieldTypeInvalidForAgg", + "text": "SavedFieldTypeInvalidForAgg" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } + ], + "children": [ + { + "id": "def-common.SavedFieldTypeInvalidForAgg.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-common.SavedFieldTypeInvalidForAgg.Unnamed.$1", + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 63 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 63 + } + } + ], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 62 + }, + "initialIsOpen": false + }, { "id": "def-common.SavedObjectNotFound", "type": "Class", @@ -6568,6 +6814,7 @@ "description": [], "children": [ { + "id": "def-common.SavedObjectNotFound.Unnamed.$1", "type": "string", "label": "type", "isRequired": true, @@ -6581,6 +6828,7 @@ } }, { + "id": "def-common.SavedObjectNotFound.Unnamed.$2", "type": "string", "label": "id", "isRequired": false, @@ -6594,6 +6842,7 @@ } }, { + "id": "def-common.SavedObjectNotFound.Unnamed.$3", "type": "string", "label": "link", "isRequired": false, @@ -6605,6 +6854,20 @@ "path": "src/plugins/kibana_utils/common/errors/errors.ts", "lineNumber": 35 } + }, + { + "id": "def-common.SavedObjectNotFound.Unnamed.$4", + "type": "string", + "label": "customMessage", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_utils/common/errors/errors.ts", + "lineNumber": 35 + } } ], "tags": [], @@ -6635,6 +6898,7 @@ ], "children": [ { + "id": "def-common.abortSignalToPromise.$1", "type": "Object", "label": "signal", "isRequired": true, @@ -6678,6 +6942,7 @@ "type": "Function", "children": [ { + "id": "def-common.createGetterSetter.$1", "type": "string", "label": "name", "isRequired": true, @@ -6740,6 +7005,7 @@ ], "children": [ { + "id": "def-common.createStateContainer.$1", "type": "Uncategorized", "label": "defaultState", "isRequired": true, @@ -6785,6 +7051,7 @@ ], "children": [ { + "id": "def-common.createStateContainer.$1", "type": "Uncategorized", "label": "defaultState", "isRequired": true, @@ -6800,6 +7067,7 @@ } }, { + "id": "def-common.createStateContainer.$2", "type": "Uncategorized", "label": "pureTransitions", "isRequired": true, @@ -6853,6 +7121,7 @@ ], "children": [ { + "id": "def-common.createStateContainer.$1", "type": "Uncategorized", "label": "defaultState", "isRequired": true, @@ -6868,6 +7137,7 @@ } }, { + "id": "def-common.createStateContainer.$2", "type": "Uncategorized", "label": "pureTransitions", "isRequired": true, @@ -6883,6 +7153,7 @@ } }, { + "id": "def-common.createStateContainer.$3", "type": "Uncategorized", "label": "pureSelectors", "isRequired": true, @@ -6898,6 +7169,7 @@ } }, { + "id": "def-common.createStateContainer.$4", "type": "Object", "label": "options", "isRequired": false, @@ -7027,6 +7299,7 @@ "description": [], "children": [ { + "id": "def-common.distinctUntilChangedWithInitialValue.$1", "type": "CompoundType", "label": "initialValue", "isRequired": true, @@ -7040,6 +7313,7 @@ } }, { + "id": "def-common.distinctUntilChangedWithInitialValue.$2", "type": "Function", "label": "compare", "isRequired": false, @@ -7071,6 +7345,7 @@ "description": [], "children": [ { + "id": "def-common.fieldWildcardFilter.$1", "type": "Array", "label": "globs", "isRequired": true, @@ -7084,6 +7359,7 @@ } }, { + "id": "def-common.fieldWildcardFilter.$2", "type": "Array", "label": "metaFields", "isRequired": true, @@ -7115,6 +7391,7 @@ "description": [], "children": [ { + "id": "def-common.fieldWildcardMatcher.$1", "type": "Array", "label": "globs", "isRequired": true, @@ -7128,6 +7405,7 @@ } }, { + "id": "def-common.fieldWildcardMatcher.$2", "type": "Array", "label": "metaFields", "isRequired": true, @@ -7149,39 +7427,6 @@ }, "initialIsOpen": false }, - { - "id": "def-common.getCombinedAbortSignal", - "type": "Function", - "label": "getCombinedAbortSignal", - "signature": [ - "(signals: AbortSignal[]) => { signal: AbortSignal; cleanup: () => void; }" - ], - "description": [ - "\nReturns an `AbortSignal` that will be aborted when the first of the given signals aborts.\n" - ], - "children": [ - { - "type": "Array", - "label": "signals", - "isRequired": true, - "signature": [ - "AbortSignal[]" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_utils/common/abort_utils.ts", - "lineNumber": 55 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/kibana_utils/common/abort_utils.ts", - "lineNumber": 54 - }, - "initialIsOpen": false - }, { "tags": [], "id": "def-common.makeRegEx", @@ -7219,6 +7464,7 @@ "type": "Function", "children": [ { + "id": "def-common.of.$1", "type": "Object", "label": "promise", "isRequired": true, @@ -7252,6 +7498,7 @@ "type": "Function", "children": [ { + "id": "def-common.useContainerSelector.$1", "type": "Uncategorized", "label": "container", "isRequired": true, @@ -7265,6 +7512,7 @@ } }, { + "id": "def-common.useContainerSelector.$2", "type": "Function", "label": "selector", "isRequired": true, @@ -7286,6 +7534,7 @@ } }, { + "id": "def-common.useContainerSelector.$3", "type": "Function", "label": "comparator", "isRequired": true, @@ -7354,6 +7603,7 @@ "type": "Function", "children": [ { + "id": "def-common.useContainerState.$1", "type": "Uncategorized", "label": "container", "isRequired": true, @@ -7683,13 +7933,7 @@ }, "signature": [ "(state: P, references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => P" ] }, @@ -7707,13 +7951,7 @@ }, "signature": [ "(state: P) => { state: P; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ] }, @@ -7793,13 +8031,7 @@ }, "signature": [ "(state: P, references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => P" ] }, @@ -7817,13 +8049,7 @@ }, "signature": [ "(state: P) => { state: P; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ] }, @@ -7987,13 +8213,7 @@ }, "signature": [ "(action: ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.TransitionDescription", - "text": "TransitionDescription" - }, + "TransitionDescription", ") => void" ] }, @@ -8081,13 +8301,7 @@ }, "signature": [ "Readonly<", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.PureTransitionsToTransitions", - "text": "PureTransitionsToTransitions" - }, + "PureTransitionsToTransitions", ">" ] }, @@ -8151,6 +8365,7 @@ ], "children": [ { + "id": "def-common.UiComponentInstance.render.$1", "type": "Object", "label": "el", "isRequired": true, @@ -8166,6 +8381,7 @@ } }, { + "id": "def-common.UiComponentInstance.render.$2", "type": "Uncategorized", "label": "props", "isRequired": true, @@ -8753,13 +8969,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.encodeUriQuery", - "text": "encodeUriQuery" - } + "encodeUriQuery" ] }, { diff --git a/api_docs/lens.json b/api_docs/lens.json index b5321bf24ba6..8176ea2dfb7a 100644 --- a/api_docs/lens.json +++ b/api_docs/lens.json @@ -110,13 +110,7 @@ "lineNumber": 43 }, "signature": [ - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.ColumnState", - "text": "ColumnState" - }, + "ColumnState", "[]" ] }, @@ -142,13 +136,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.SortingState", - "text": "SortingState" - }, + "SortingState", " | undefined" ] } @@ -256,13 +244,7 @@ }, "signature": [ "{ filters: ", - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.Filter", - "text": "Filter" - }, + "Filter", "[]; }" ] } @@ -291,7 +273,7 @@ "lineNumber": 46 }, "signature": [ - "\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"percentile\" | \"last_value\" | undefined" + "\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | undefined" ] }, { @@ -334,13 +316,7 @@ }, "signature": [ "Record>" ] } @@ -513,13 +489,7 @@ }, "signature": [ "(input: ", - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.LensEmbeddableInput", - "text": "LensEmbeddableInput" - }, + "LensEmbeddableInput", ") => void" ] }, @@ -553,13 +523,7 @@ }, "signature": [ "() => Promise<", - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.VisualizationType", - "text": "VisualizationType" - }, + "VisualizationType", "[]>" ] } @@ -609,6 +573,67 @@ }, "initialIsOpen": false }, + { + "id": "def-public.OperationMetadata", + "type": "Interface", + "label": "OperationMetadata", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.OperationMetadata.dataType", + "type": "CompoundType", + "label": "dataType", + "description": [], + "source": { + "path": "x-pack/plugins/lens/public/types.ts", + "lineNumber": 360 + }, + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.DataType", + "text": "DataType" + } + ] + }, + { + "tags": [], + "id": "def-public.OperationMetadata.isBucketed", + "type": "boolean", + "label": "isBucketed", + "description": [], + "source": { + "path": "x-pack/plugins/lens/public/types.ts", + "lineNumber": 363 + } + }, + { + "tags": [], + "id": "def-public.OperationMetadata.scale", + "type": "CompoundType", + "label": "scale", + "description": [ + "\nordinal: Each name is a unique value, but the names are in sorted order, like \"Top values\"\ninterval: Histogram data, like date or number histograms\nratio: Most number data is rendered as a ratio that includes 0" + ], + "source": { + "path": "x-pack/plugins/lens/public/types.ts", + "lineNumber": 369 + }, + "signature": [ + "\"interval\" | \"ordinal\" | \"ratio\" | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/lens/public/types.ts", + "lineNumber": 358 + }, + "initialIsOpen": false + }, { "id": "def-public.PercentileIndexPatternColumn", "type": "Interface", @@ -776,21 +801,9 @@ }, "signature": [ "{ type: ", - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.MODES_TYPES", - "text": "MODES_TYPES" - }, + "MODES_TYPES", "; maxBars: number | \"auto\"; ranges: ", - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.RangeTypeLens", - "text": "RangeTypeLens" - }, + "RangeTypeLens", "[]; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; parentFormat?: { id: string; params?: { id?: string | undefined; template?: string | undefined; replaceInfinity?: boolean | undefined; } | undefined; } | undefined; }" ] } @@ -1051,13 +1064,7 @@ "lineNumber": 381 }, "signature": [ - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.YConfig", - "text": "YConfig" - }, + "YConfig", "[] | undefined" ] }, @@ -1411,6 +1418,21 @@ ], "initialIsOpen": false }, + { + "id": "def-public.DataType", + "type": "Type", + "label": "DataType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/lens/public/types.ts", + "lineNumber": 347 + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"date\" | \"ip\" | \"histogram\" | \"document\"" + ], + "initialIsOpen": false + }, { "id": "def-public.DerivativeIndexPatternColumn", "type": "Type", @@ -1576,10 +1598,10 @@ ], "source": { "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts", - "lineNumber": 406 + "lineNumber": 399 }, "signature": [ - "\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"percentile\" | \"last_value\"" + "\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\"" ], "initialIsOpen": false }, @@ -1656,7 +1678,7 @@ "lineNumber": 38 }, "signature": [ - "Pick & { attributes: LensAttributes<'lnsXY', XYState> | LensAttributes<'lnsPie', PieVisualizationState> | LensAttributes<'lnsDatatable', DatatableVisualizationState> | LensAttributes<'lnsMetric', MetricState>; }" + "Pick & { attributes: LensAttributes<'lnsXY', XYState> | LensAttributes<'lnsPie', PieVisualizationState> | LensAttributes<'lnsDatatable', DatatableVisualizationState> | LensAttributes<'lnsMetric', MetricState>; }" ], "initialIsOpen": false }, @@ -1675,6 +1697,21 @@ ], "initialIsOpen": false }, + { + "id": "def-public.XYCurveType", + "type": "Type", + "label": "XYCurveType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "lineNumber": 419 + }, + "signature": [ + "\"LINEAR\" | \"CURVE_MONOTONE_X\"" + ], + "initialIsOpen": false + }, { "id": "def-public.YAxisMode", "type": "Type", @@ -1730,6 +1767,7 @@ "description": [], "children": [ { + "id": "def-server.LensServerPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -1791,6 +1829,7 @@ "description": [], "children": [ { + "id": "def-server.LensServerPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1819,6 +1858,7 @@ } }, { + "id": "def-server.LensServerPlugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, @@ -1871,6 +1911,7 @@ "description": [], "children": [ { + "id": "def-server.LensServerPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1890,6 +1931,7 @@ } }, { + "id": "def-server.LensServerPlugin.start.$2", "type": "Object", "label": "plugins", "isRequired": true, @@ -1961,13 +2003,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorSet", - "text": "CollectorSet" - }, + "CollectorSet", ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" ] }, @@ -2089,6 +2125,7 @@ "description": [], "children": [ { + "id": "def-common.getEditPath.$1", "type": "string", "label": "id", "isRequired": false, @@ -2120,6 +2157,7 @@ "description": [], "children": [ { + "id": "def-common.getFullPath.$1", "type": "string", "label": "id", "isRequired": false, diff --git a/api_docs/licensing.json b/api_docs/licensing.json index 1f97d24e2618..df2511925bd6 100644 --- a/api_docs/licensing.json +++ b/api_docs/licensing.json @@ -148,13 +148,7 @@ }, "signature": [ "() => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.PublicLicenseJSON", - "text": "PublicLicenseJSON" - } + "PublicLicenseJSON" ] }, { @@ -201,6 +195,7 @@ ], "children": [ { + "id": "def-public.ILicense.hasAtLeast.$1", "type": "CompoundType", "label": "minimumLicenseRequired", "isRequired": true, @@ -229,19 +224,14 @@ "label": "check", "signature": [ "(pluginName: string, minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseCheck", - "text": "LicenseCheck" - } + "LicenseCheck" ], "description": [ "\nFor a given plugin and license type, receive information about the status of the license." ], "children": [ { + "id": "def-public.ILicense.check.$1", "type": "string", "label": "pluginName", "isRequired": true, @@ -257,6 +247,7 @@ } }, { + "id": "def-public.ILicense.check.$2", "type": "CompoundType", "label": "minimumLicenseRequired", "isRequired": true, @@ -285,19 +276,14 @@ "label": "getFeature", "signature": [ "(name: string) => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseFeature", - "text": "LicenseFeature" - } + "LicenseFeature" ], "description": [ "\nA specific API for interacting with the specific features of the license." ], "children": [ { + "id": "def-public.ILicense.getFeature.$1", "type": "string", "label": "name", "isRequired": true, @@ -349,13 +335,7 @@ "lineNumber": 89 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseCheckState", - "text": "LicenseCheckState" - } + "LicenseCheckState" ] }, { @@ -456,13 +436,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseStatus", - "text": "LicenseStatus" - } + "LicenseStatus" ] }, { @@ -541,13 +515,7 @@ "lineNumber": 75 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.PublicLicense", - "text": "PublicLicense" - }, + "PublicLicense", " | undefined" ] }, @@ -563,13 +531,7 @@ }, "signature": [ "Record | undefined" ] }, @@ -703,13 +665,7 @@ "signature": [ "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ] }, @@ -719,13 +675,7 @@ "label": "refresh", "signature": [ "() => Promise<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ], "description": [ @@ -754,13 +704,7 @@ "lineNumber": 28 }, "signature": [ - { - "pluginId": "licensing", - "scope": "public", - "docId": "kibLicensingPluginApi", - "section": "def-public.FeatureUsageServiceSetup", - "text": "FeatureUsageServiceSetup" - } + "FeatureUsageServiceSetup" ] } ], @@ -795,13 +739,7 @@ "signature": [ "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ] }, @@ -811,13 +749,7 @@ "label": "refresh", "signature": [ "() => Promise<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ], "description": [ @@ -844,13 +776,7 @@ "lineNumber": 44 }, "signature": [ - { - "pluginId": "licensing", - "scope": "public", - "docId": "kibLicensingPluginApi", - "section": "def-public.FeatureUsageServiceStart", - "text": "FeatureUsageServiceStart" - } + "FeatureUsageServiceStart" ] } ], @@ -902,6 +828,7 @@ "description": [], "children": [ { + "id": "def-server.wrapRouteWithLicenseCheck.$1", "type": "Function", "label": "checkLicense", "isRequired": true, @@ -921,6 +848,7 @@ } }, { + "id": "def-server.wrapRouteWithLicenseCheck.$2", "type": "Function", "label": "handler", "isRequired": true, @@ -943,13 +871,7 @@ "text": "CustomHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - }, + "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", @@ -1035,6 +957,7 @@ ], "children": [ { + "id": "def-server.FeatureUsageServiceSetup.register.$1", "type": "string", "label": "featureName", "isRequired": true, @@ -1048,6 +971,7 @@ } }, { + "id": "def-server.FeatureUsageServiceSetup.register.$2", "type": "CompoundType", "label": "licenseType", "isRequired": true, @@ -1096,6 +1020,7 @@ ], "children": [ { + "id": "def-server.FeatureUsageServiceStart.notifyUsage.$1", "type": "string", "label": "featureName", "isRequired": true, @@ -1111,6 +1036,7 @@ } }, { + "id": "def-server.FeatureUsageServiceStart.notifyUsage.$2", "type": "CompoundType", "label": "usedAt", "isRequired": false, @@ -1139,13 +1065,7 @@ "label": "getLastUsages", "signature": [ "() => ", - { - "pluginId": "licensing", - "scope": "server", - "docId": "kibLicensingPluginApi", - "section": "def-server.LastFeatureUsage", - "text": "LastFeatureUsage" - }, + "LastFeatureUsage", "[]" ], "description": [ @@ -1310,13 +1230,7 @@ }, "signature": [ "() => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.PublicLicenseJSON", - "text": "PublicLicenseJSON" - } + "PublicLicenseJSON" ] }, { @@ -1363,6 +1277,7 @@ ], "children": [ { + "id": "def-server.ILicense.hasAtLeast.$1", "type": "CompoundType", "label": "minimumLicenseRequired", "isRequired": true, @@ -1391,19 +1306,14 @@ "label": "check", "signature": [ "(pluginName: string, minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseCheck", - "text": "LicenseCheck" - } + "LicenseCheck" ], "description": [ "\nFor a given plugin and license type, receive information about the status of the license." ], "children": [ { + "id": "def-server.ILicense.check.$1", "type": "string", "label": "pluginName", "isRequired": true, @@ -1419,6 +1329,7 @@ } }, { + "id": "def-server.ILicense.check.$2", "type": "CompoundType", "label": "minimumLicenseRequired", "isRequired": true, @@ -1447,19 +1358,14 @@ "label": "getFeature", "signature": [ "(name: string) => ", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseFeature", - "text": "LicenseFeature" - } + "LicenseFeature" ], "description": [ "\nA specific API for interacting with the specific features of the license." ], "children": [ { + "id": "def-server.ILicense.getFeature.$1", "type": "string", "label": "name", "isRequired": true, @@ -1511,13 +1417,7 @@ "lineNumber": 89 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseCheckState", - "text": "LicenseCheckState" - } + "LicenseCheckState" ] }, { @@ -1623,13 +1523,7 @@ "lineNumber": 51 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - } + "ILicense" ] } ], @@ -1676,13 +1570,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.LicenseStatus", - "text": "LicenseStatus" - } + "LicenseStatus" ] }, { @@ -1761,13 +1649,7 @@ "lineNumber": 75 }, "signature": [ - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.PublicLicense", - "text": "PublicLicense" - }, + "PublicLicense", " | undefined" ] }, @@ -1783,13 +1665,7 @@ }, "signature": [ "Record | undefined" ] }, @@ -1940,13 +1816,7 @@ "signature": [ "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ] }, @@ -1956,13 +1826,7 @@ "label": "refresh", "signature": [ "() => Promise<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ], "description": [ @@ -2004,21 +1868,9 @@ ", \"callAsInternalUser\" | \"asScoped\">, pollingFrequency: number) => { license$: ", "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">; refresh(): Promise<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">; }" ] }, @@ -2076,13 +1928,7 @@ "signature": [ "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ] }, @@ -2092,13 +1938,7 @@ "label": "refresh", "signature": [ "() => Promise<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">" ], "description": [ @@ -2136,21 +1976,9 @@ ", \"callAsInternalUser\" | \"asScoped\">, pollingFrequency: number) => { license$: ", "Observable", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">; refresh(): Promise<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", ">; }" ] }, diff --git a/api_docs/lists.json b/api_docs/lists.json index fc935809cd7d..df8518608f35 100644 --- a/api_docs/lists.json +++ b/api_docs/lists.json @@ -54,6 +54,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -95,13 +96,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ", ", { "pluginId": "lists", @@ -111,13 +106,7 @@ "text": "PluginStart" }, ">, plugins: ", - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.SetupPlugins", - "text": "SetupPlugins" - }, + "SetupPlugins", ") => ", { "pluginId": "lists", @@ -130,6 +119,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -142,13 +132,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ", ", { "pluginId": "lists", @@ -166,17 +150,12 @@ } }, { + "id": "def-public.Plugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.SetupPlugins", - "text": "SetupPlugins" - } + "SetupPlugins" ], "description": [], "source": { @@ -206,13 +185,7 @@ "text": "CoreStart" }, ", plugins: ", - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ") => ", { "pluginId": "lists", @@ -225,6 +198,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -244,17 +218,12 @@ } }, { + "id": "def-public.Plugin.start.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.StartPlugins", - "text": "StartPlugins" - } + "StartPlugins" ], "description": [], "source": { @@ -284,17 +253,12 @@ "type": "Function", "children": [ { + "id": "def-public.addEndpointExceptionListWithValidation.$1", "type": "Object", "label": "{\n http,\n signal,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.AddEndpointExceptionListProps", - "text": "AddEndpointExceptionListProps" - } + "AddEndpointExceptionListProps" ], "description": [], "source": { @@ -306,7 +270,7 @@ "signature": [ "({ http, signal, }: ", "AddEndpointExceptionListProps", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | {}>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | {}>" ], "description": [], "label": "addEndpointExceptionListWithValidation", @@ -323,17 +287,12 @@ "type": "Function", "children": [ { + "id": "def-public.addExceptionListItemWithValidation.$1", "type": "Object", "label": "{\n http,\n listItem,\n signal,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.AddExceptionListItemProps", - "text": "AddExceptionListItemProps" - } + "AddExceptionListItemProps" ], "description": [], "source": { @@ -345,7 +304,7 @@ "signature": [ "({ http, listItem, signal, }: ", "AddExceptionListItemProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [], "label": "addExceptionListItemWithValidation", @@ -362,17 +321,12 @@ "type": "Function", "children": [ { + "id": "def-public.addExceptionListWithValidation.$1", "type": "Object", "label": "{\n http,\n list,\n signal,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.AddExceptionListProps", - "text": "AddExceptionListProps" - } + "AddExceptionListProps" ], "description": [], "source": { @@ -384,7 +338,7 @@ "signature": [ "({ http, list, signal, }: ", "AddExceptionListProps", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "addExceptionListWithValidation", @@ -401,17 +355,12 @@ "type": "Function", "children": [ { + "id": "def-public.exportListWithValidation.$1", "type": "Object", "label": "{\n http,\n listId,\n signal,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.ExportListParams", - "text": "ExportListParams" - } + "ExportListParams" ], "description": [], "source": { @@ -440,17 +389,12 @@ "type": "Function", "children": [ { + "id": "def-public.fetchExceptionListByIdWithValidation.$1", "type": "Object", "label": "{\n http,\n id,\n namespaceType,\n signal,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.ApiCallByIdProps", - "text": "ApiCallByIdProps" - } + "ApiCallByIdProps" ], "description": [], "source": { @@ -462,7 +406,7 @@ "signature": [ "({ http, id, namespaceType, signal, }: ", "ApiCallByIdProps", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "fetchExceptionListByIdWithValidation", @@ -479,17 +423,12 @@ "type": "Function", "children": [ { + "id": "def-public.updateExceptionListItemWithValidation.$1", "type": "Object", "label": "{\n http,\n listItem,\n signal,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.UpdateExceptionListItemProps", - "text": "UpdateExceptionListItemProps" - } + "UpdateExceptionListItemProps" ], "description": [], "source": { @@ -501,7 +440,7 @@ "signature": [ "({ http, listItem, signal, }: ", "UpdateExceptionListItemProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [], "label": "updateExceptionListItemWithValidation", @@ -518,6 +457,7 @@ "type": "Function", "children": [ { + "id": "def-public.useApi.$1", "type": "Object", "label": "http", "isRequired": true, @@ -564,6 +504,7 @@ "type": "Function", "children": [ { + "id": "def-public.useAsync.$1", "type": "Function", "label": "fn", "isRequired": true, @@ -624,17 +565,12 @@ "type": "Function", "children": [ { + "id": "def-public.useCursor.$1", "type": "Object", "label": "{ pageIndex, pageSize }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.UseCursorProps", - "text": "UseCursorProps" - } + "UseCursorProps" ], "description": [], "source": { @@ -669,7 +605,7 @@ "OptionalSignalArgs", "<", "DeleteListParams", - ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "useDeleteList", @@ -686,17 +622,12 @@ "type": "Function", "children": [ { + "id": "def-public.useExceptionListItems.$1", "type": "Object", "label": "{\n http,\n lists,\n pagination = {\n page: 1,\n perPage: 20,\n total: 0,\n },\n filterOptions,\n showDetectionsListsOnly,\n showEndpointListsOnly,\n matchFilters,\n onError,\n onSuccess,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.UseExceptionListProps", - "text": "UseExceptionListProps" - } + "UseExceptionListProps" ], "description": [], "source": { @@ -728,17 +659,12 @@ "type": "Function", "children": [ { + "id": "def-public.useExceptionLists.$1", "type": "Object", "label": "{\n errorMessage,\n http,\n pagination = {\n page: 1,\n perPage: 20,\n total: 0,\n },\n filterOptions = {},\n namespaceTypes,\n notifications,\n showTrustedApps = false,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.UseExceptionListsProps", - "text": "UseExceptionListsProps" - } + "UseExceptionListsProps" ], "description": [], "source": { @@ -799,7 +725,7 @@ "OptionalSignalArgs", "<", "FindListsParams", - ">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "description": [], "label": "useFindLists", @@ -822,7 +748,7 @@ "OptionalSignalArgs", "<", "ImportListParams", - ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "useImportList", @@ -860,17 +786,12 @@ "type": "Function", "children": [ { + "id": "def-public.usePersistExceptionItem.$1", "type": "Object", "label": "{\n http,\n onError,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.PersistHookProps", - "text": "PersistHookProps" - } + "PersistHookProps" ], "description": [], "source": { @@ -902,17 +823,12 @@ "type": "Function", "children": [ { + "id": "def-public.usePersistExceptionList.$1", "type": "Object", "label": "{\n http,\n onError,\n}", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "public", - "docId": "kibListsPluginApi", - "section": "def-public.PersistHookProps", - "text": "PersistHookProps" - } + "PersistHookProps" ], "description": [], "source": { @@ -990,6 +906,7 @@ "type": "Function", "children": [ { + "id": "def-public.withOptionalSignal.$1", "type": "Function", "label": "fn", "isRequired": true, @@ -1036,7 +953,7 @@ "section": "def-public.ExceptionList", "text": "ExceptionList" }, - " extends { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }" + " extends { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }" ], "description": [], "tags": [], @@ -1197,7 +1114,7 @@ "lineNumber": 66 }, "signature": [ - "\"endpoint\" | \"detection\"" + "\"endpoint\" | \"detection\" | \"endpoint_events\"" ] } ], @@ -1275,7 +1192,7 @@ "lineNumber": 46 }, "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" ] }, { @@ -1323,7 +1240,7 @@ "lineNumber": 121 }, "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }[]" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }[]" ] }, { @@ -1356,7 +1273,24 @@ ], "enums": [], "misc": [], - "objects": [], + "objects": [ + { + "id": "def-public.ExceptionBuilder", + "type": "Object", + "label": "ExceptionBuilder", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/lists/public/shared_exports.ts", + "lineNumber": 41 + }, + "signature": [ + "typeof ", + "x-pack/plugins/lists/public/exceptions/components/builder/index" + ], + "initialIsOpen": false + } + ], "setup": { "id": "def-public.PluginSetup", "type": "Interface", @@ -1405,17 +1339,12 @@ "description": [], "children": [ { + "id": "def-server.ExceptionListClient.Unnamed.$1", "type": "Object", "label": "{ user, savedObjectsClient }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.ConstructorOptions", - "text": "ConstructorOptions" - } + "ConstructorOptions" ], "description": [], "source": { @@ -1436,17 +1365,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.getExceptionList.$1", "type": "Object", "label": "{\n listId,\n id,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetExceptionListOptions", - "text": "GetExceptionListOptions" - } + "GetExceptionListOptions" ], "description": [], "source": { @@ -1457,14 +1381,8 @@ ], "signature": [ "({ listId, id, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetExceptionListOptions", - "text": "GetExceptionListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>" + "GetExceptionListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "getExceptionList", @@ -1480,17 +1398,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.getExceptionListItem.$1", "type": "Object", "label": "{\n itemId,\n id,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetExceptionListItemOptions", - "text": "GetExceptionListItemOptions" - } + "GetExceptionListItemOptions" ], "description": [], "source": { @@ -1501,14 +1414,8 @@ ], "signature": [ "({ itemId, id, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetExceptionListItemOptions", - "text": "GetExceptionListItemOptions" - }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + "GetExceptionListItemOptions", + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [], "label": "getExceptionListItem", @@ -1524,7 +1431,7 @@ "type": "Function", "children": [], "signature": [ - "() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>" + "() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [ "\nThis creates an agnostic space endpoint list if it does not exist. This tries to be\nas fast as possible by ignoring conflict errors and not returning the contents of the\nlist if it already exists." @@ -1544,7 +1451,7 @@ "type": "Function", "children": [], "signature": [ - "() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>" + "() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [ "\nCreate the Trusted Apps Agnostic list if it does not yet exist (`null` is returned if it does exist)" @@ -1562,17 +1469,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.createEndpointListItem.$1", "type": "Object", "label": "{\n comments,\n description,\n entries,\n itemId,\n meta,\n name,\n osTypes,\n tags,\n type,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateEndpointListItemOptions", - "text": "CreateEndpointListItemOptions" - } + "CreateEndpointListItemOptions" ], "description": [], "source": { @@ -1583,14 +1485,8 @@ ], "signature": [ "({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateEndpointListItemOptions", - "text": "CreateEndpointListItemOptions" - }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + "CreateEndpointListItemOptions", + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [ "\nThis is the same as \"createListItem\" except it applies specifically to the agnostic endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the agnostic endpoint\nbeing there and existing before the item is inserted into the agnostic endpoint list." @@ -1608,17 +1504,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.updateEndpointListItem.$1", "type": "Object", "label": "{\n _version,\n comments,\n description,\n entries,\n id,\n itemId,\n meta,\n name,\n osTypes,\n tags,\n type,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateEndpointListItemOptions", - "text": "UpdateEndpointListItemOptions" - } + "UpdateEndpointListItemOptions" ], "description": [], "source": { @@ -1629,14 +1520,8 @@ ], "signature": [ "({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateEndpointListItemOptions", - "text": "UpdateEndpointListItemOptions" - }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + "UpdateEndpointListItemOptions", + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [ "\nThis is the same as \"updateExceptionListItem\" except it applies specifically to the endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the endpoint\nbeing there if it did not exist before. If the list did not exist before, then creating it here will still cause a\nreturn of null but at least the list exists again." @@ -1654,17 +1539,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.getEndpointListItem.$1", "type": "Object", "label": "{\n itemId,\n id,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetEndpointListItemOptions", - "text": "GetEndpointListItemOptions" - } + "GetEndpointListItemOptions" ], "description": [], "source": { @@ -1675,14 +1555,8 @@ ], "signature": [ "({ itemId, id, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetEndpointListItemOptions", - "text": "GetEndpointListItemOptions" - }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + "GetEndpointListItemOptions", + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [ "\nThis is the same as \"getExceptionListItem\" except it applies specifically to the endpoint list." @@ -1700,17 +1574,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.createExceptionList.$1", "type": "Object", "label": "{\n description,\n immutable,\n listId,\n meta,\n name,\n namespaceType,\n tags,\n type,\n version,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateExceptionListOptions", - "text": "CreateExceptionListOptions" - } + "CreateExceptionListOptions" ], "description": [], "source": { @@ -1721,14 +1590,8 @@ ], "signature": [ "({ description, immutable, listId, meta, name, namespaceType, tags, type, version, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateExceptionListOptions", - "text": "CreateExceptionListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }>" + "CreateExceptionListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "createExceptionList", @@ -1744,17 +1607,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.updateExceptionList.$1", "type": "Object", "label": "{\n _version,\n id,\n description,\n listId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n version,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateExceptionListOptions", - "text": "UpdateExceptionListOptions" - } + "UpdateExceptionListOptions" ], "description": [], "source": { @@ -1765,14 +1623,8 @@ ], "signature": [ "({ _version, id, description, listId, meta, name, namespaceType, osTypes, tags, type, version, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateExceptionListOptions", - "text": "UpdateExceptionListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>" + "UpdateExceptionListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "updateExceptionList", @@ -1788,17 +1640,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.deleteExceptionList.$1", "type": "Object", "label": "{\n id,\n listId,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteExceptionListOptions", - "text": "DeleteExceptionListOptions" - } + "DeleteExceptionListOptions" ], "description": [], "source": { @@ -1809,14 +1656,8 @@ ], "signature": [ "({ id, listId, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteExceptionListOptions", - "text": "DeleteExceptionListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>" + "DeleteExceptionListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "deleteExceptionList", @@ -1832,6 +1673,7 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.createExceptionListItem.$1", "type": "Object", "label": "{\n comments,\n description,\n entries,\n itemId,\n listId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n }", "isRequired": true, @@ -1860,7 +1702,7 @@ "section": "def-server.CreateExceptionListItemOptions", "text": "CreateExceptionListItemOptions" }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [], "label": "createExceptionListItem", @@ -1876,6 +1718,7 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.updateExceptionListItem.$1", "type": "Object", "label": "{\n _version,\n comments,\n description,\n entries,\n id,\n itemId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n }", "isRequired": true, @@ -1904,7 +1747,7 @@ "section": "def-server.UpdateExceptionListItemOptions", "text": "UpdateExceptionListItemOptions" }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [], "label": "updateExceptionListItem", @@ -1920,17 +1763,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.deleteExceptionListItem.$1", "type": "Object", "label": "{\n id,\n itemId,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteExceptionListItemOptions", - "text": "DeleteExceptionListItemOptions" - } + "DeleteExceptionListItemOptions" ], "description": [], "source": { @@ -1941,14 +1779,8 @@ ], "signature": [ "({ id, itemId, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteExceptionListItemOptions", - "text": "DeleteExceptionListItemOptions" - }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + "DeleteExceptionListItemOptions", + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [], "label": "deleteExceptionListItem", @@ -1964,17 +1796,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.deleteExceptionListItemById.$1", "type": "Object", "label": "{\n id,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteExceptionListItemByIdOptions", - "text": "DeleteExceptionListItemByIdOptions" - } + "DeleteExceptionListItemByIdOptions" ], "description": [], "source": { @@ -1985,13 +1812,7 @@ ], "signature": [ "({ id, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteExceptionListItemByIdOptions", - "text": "DeleteExceptionListItemByIdOptions" - }, + "DeleteExceptionListItemByIdOptions", ") => Promise" ], "description": [], @@ -2008,17 +1829,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.deleteEndpointListItem.$1", "type": "Object", "label": "{\n id,\n itemId,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteEndpointListItemOptions", - "text": "DeleteEndpointListItemOptions" - } + "DeleteEndpointListItemOptions" ], "description": [], "source": { @@ -2029,14 +1845,8 @@ ], "signature": [ "({ id, itemId, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteEndpointListItemOptions", - "text": "DeleteEndpointListItemOptions" - }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + "DeleteEndpointListItemOptions", + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [ "\nThis is the same as \"deleteExceptionListItem\" except it applies specifically to the endpoint list." @@ -2054,17 +1864,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.findExceptionListItem.$1", "type": "Object", "label": "{\n listId,\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindExceptionListItemOptions", - "text": "FindExceptionListItemOptions" - } + "FindExceptionListItemOptions" ], "description": [], "source": { @@ -2075,14 +1880,8 @@ ], "signature": [ "({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindExceptionListItemOptions", - "text": "FindExceptionListItemOptions" - }, - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + "FindExceptionListItemOptions", + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findExceptionListItem", @@ -2098,17 +1897,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.findExceptionListsItem.$1", "type": "Object", "label": "{\n listId,\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindExceptionListsItemOptions", - "text": "FindExceptionListsItemOptions" - } + "FindExceptionListsItemOptions" ], "description": [], "source": { @@ -2119,14 +1913,8 @@ ], "signature": [ "({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindExceptionListsItemOptions", - "text": "FindExceptionListsItemOptions" - }, - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + "FindExceptionListsItemOptions", + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findExceptionListsItem", @@ -2142,17 +1930,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.findValueListExceptionListItems.$1", "type": "Object", "label": "{\n perPage,\n page,\n sortField,\n sortOrder,\n valueListId,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindValueListExceptionListsItems", - "text": "FindValueListExceptionListsItems" - } + "FindValueListExceptionListsItems" ], "description": [], "source": { @@ -2163,14 +1946,8 @@ ], "signature": [ "({ perPage, page, sortField, sortOrder, valueListId, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindValueListExceptionListsItems", - "text": "FindValueListExceptionListsItems" - }, - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + "FindValueListExceptionListsItems", + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findValueListExceptionListItems", @@ -2186,17 +1963,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.findExceptionList.$1", "type": "Object", "label": "{\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindExceptionListOptions", - "text": "FindExceptionListOptions" - } + "FindExceptionListOptions" ], "description": [], "source": { @@ -2207,14 +1979,8 @@ ], "signature": [ "({ filter, perPage, page, sortField, sortOrder, namespaceType, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindExceptionListOptions", - "text": "FindExceptionListOptions" - }, - ") => Promise<{ data: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + "FindExceptionListOptions", + ") => Promise<{ data: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "description": [], "label": "findExceptionList", @@ -2230,17 +1996,12 @@ "type": "Function", "children": [ { + "id": "def-server.ExceptionListClient.findEndpointListItem.$1", "type": "Object", "label": "{\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindEndpointListItemOptions", - "text": "FindEndpointListItemOptions" - } + "FindEndpointListItemOptions" ], "description": [], "source": { @@ -2251,14 +2012,8 @@ ], "signature": [ "({ filter, perPage, page, sortField, sortOrder, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindEndpointListItemOptions", - "text": "FindEndpointListItemOptions" - }, - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + "FindEndpointListItemOptions", + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [ "\nThis is the same as \"findExceptionList\" except it applies specifically to the endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the endpoint\nbeing there if it did not exist before. If the list did not exist before, then creating it here should give you\na good guarantee that you will get an empty record set rather than null. I keep the null as the return value in\nthe off chance that you still might somehow not get into a race condition where the endpoint list does\nnot exist because someone deleted it in-between the initial create and then the find." @@ -2295,17 +2050,12 @@ "description": [], "children": [ { + "id": "def-server.ListClient.Unnamed.$1", "type": "Object", "label": "{ spaceId, user, config, esClient }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.ConstructorOptions", - "text": "ConstructorOptions" - } + "ConstructorOptions" ], "description": [], "source": { @@ -2358,17 +2108,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.getList.$1", "type": "Object", "label": "{ id }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListOptions", - "text": "GetListOptions" - } + "GetListOptions" ], "description": [], "source": { @@ -2379,14 +2124,8 @@ ], "signature": [ "({ id }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListOptions", - "text": "GetListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>" + "GetListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "getList", @@ -2402,17 +2141,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.createList.$1", "type": "Object", "label": "{\n id,\n deserializer,\n immutable,\n serializer,\n name,\n description,\n type,\n meta,\n version,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateListOptions", - "text": "CreateListOptions" - } + "CreateListOptions" ], "description": [], "source": { @@ -2423,14 +2157,8 @@ ], "signature": [ "({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateListOptions", - "text": "CreateListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>" + "CreateListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "createList", @@ -2446,17 +2174,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.createListIfItDoesNotExist.$1", "type": "Object", "label": "{\n id,\n deserializer,\n serializer,\n name,\n description,\n immutable,\n type,\n meta,\n version,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateListIfItDoesNotExistOptions", - "text": "CreateListIfItDoesNotExistOptions" - } + "CreateListIfItDoesNotExistOptions" ], "description": [], "source": { @@ -2467,14 +2190,8 @@ ], "signature": [ "({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateListIfItDoesNotExistOptions", - "text": "CreateListIfItDoesNotExistOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>" + "CreateListIfItDoesNotExistOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "createListIfItDoesNotExist", @@ -2810,17 +2527,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.deleteListItem.$1", "type": "Object", "label": "{ id }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteListItemOptions", - "text": "DeleteListItemOptions" - } + "DeleteListItemOptions" ], "description": [], "source": { @@ -2831,14 +2543,8 @@ ], "signature": [ "({ id }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteListItemOptions", - "text": "DeleteListItemOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>" + "DeleteListItemOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "deleteListItem", @@ -2854,17 +2560,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.deleteListItemByValue.$1", "type": "Object", "label": "{\n listId,\n value,\n type,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteListItemByValueOptions", - "text": "DeleteListItemByValueOptions" - } + "DeleteListItemByValueOptions" ], "description": [], "source": { @@ -2875,14 +2576,8 @@ ], "signature": [ "({ listId, value, type, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteListItemByValueOptions", - "text": "DeleteListItemByValueOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]>" + "DeleteListItemByValueOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "description": [], "label": "deleteListItemByValue", @@ -2898,17 +2593,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.deleteList.$1", "type": "Object", "label": "{ id }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteListOptions", - "text": "DeleteListOptions" - } + "DeleteListOptions" ], "description": [], "source": { @@ -2919,14 +2609,8 @@ ], "signature": [ "({ id }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.DeleteListOptions", - "text": "DeleteListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>" + "DeleteListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "deleteList", @@ -2942,17 +2626,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.exportListItemsToStream.$1", "type": "Object", "label": "{\n stringToAppend,\n listId,\n stream,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.ExportListItemsToStreamOptions", - "text": "ExportListItemsToStreamOptions" - } + "ExportListItemsToStreamOptions" ], "description": [], "source": { @@ -2963,13 +2642,7 @@ ], "signature": [ "({ stringToAppend, listId, stream, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.ExportListItemsToStreamOptions", - "text": "ExportListItemsToStreamOptions" - }, + "ExportListItemsToStreamOptions", ") => void" ], "description": [], @@ -2986,17 +2659,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.importListItemsToStream.$1", "type": "Object", "label": "{\n deserializer,\n serializer,\n type,\n listId,\n stream,\n meta,\n version,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.ImportListItemsToStreamOptions", - "text": "ImportListItemsToStreamOptions" - } + "ImportListItemsToStreamOptions" ], "description": [], "source": { @@ -3007,14 +2675,8 @@ ], "signature": [ "({ deserializer, serializer, type, listId, stream, meta, version, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.ImportListItemsToStreamOptions", - "text": "ImportListItemsToStreamOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>" + "ImportListItemsToStreamOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "importListItemsToStream", @@ -3030,17 +2692,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.getListItemByValue.$1", "type": "Object", "label": "{\n listId,\n value,\n type,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListItemByValueOptions", - "text": "GetListItemByValueOptions" - } + "GetListItemByValueOptions" ], "description": [], "source": { @@ -3051,14 +2708,8 @@ ], "signature": [ "({ listId, value, type, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListItemByValueOptions", - "text": "GetListItemByValueOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]>" + "GetListItemByValueOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "description": [], "label": "getListItemByValue", @@ -3074,17 +2725,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.createListItem.$1", "type": "Object", "label": "{\n id,\n deserializer,\n serializer,\n listId,\n value,\n type,\n meta,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateListItemOptions", - "text": "CreateListItemOptions" - } + "CreateListItemOptions" ], "description": [], "source": { @@ -3095,14 +2741,8 @@ ], "signature": [ "({ id, deserializer, serializer, listId, value, type, meta, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.CreateListItemOptions", - "text": "CreateListItemOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>" + "CreateListItemOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "createListItem", @@ -3118,17 +2758,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.updateListItem.$1", "type": "Object", "label": "{\n _version,\n id,\n value,\n meta,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateListItemOptions", - "text": "UpdateListItemOptions" - } + "UpdateListItemOptions" ], "description": [], "source": { @@ -3139,14 +2774,8 @@ ], "signature": [ "({ _version, id, value, meta, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateListItemOptions", - "text": "UpdateListItemOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>" + "UpdateListItemOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "updateListItem", @@ -3162,17 +2791,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.updateList.$1", "type": "Object", "label": "{\n _version,\n id,\n name,\n description,\n meta,\n version,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateListOptions", - "text": "UpdateListOptions" - } + "UpdateListOptions" ], "description": [], "source": { @@ -3183,14 +2807,8 @@ ], "signature": [ "({ _version, id, name, description, meta, version, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.UpdateListOptions", - "text": "UpdateListOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>" + "UpdateListOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "updateList", @@ -3206,17 +2824,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.getListItem.$1", "type": "Object", "label": "{ id }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListItemOptions", - "text": "GetListItemOptions" - } + "GetListItemOptions" ], "description": [], "source": { @@ -3227,14 +2840,8 @@ ], "signature": [ "({ id }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListItemOptions", - "text": "GetListItemOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>" + "GetListItemOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "getListItem", @@ -3250,17 +2857,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.getListItemByValues.$1", "type": "Object", "label": "{\n type,\n listId,\n value,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListItemsByValueOptions", - "text": "GetListItemsByValueOptions" - } + "GetListItemsByValueOptions" ], "description": [], "source": { @@ -3271,14 +2873,8 @@ ], "signature": [ "({ type, listId, value, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListItemsByValueOptions", - "text": "GetListItemsByValueOptions" - }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]>" + "GetListItemsByValueOptions", + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "description": [], "label": "getListItemByValues", @@ -3294,17 +2890,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.searchListItemByValues.$1", "type": "Object", "label": "{\n type,\n listId,\n value,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.SearchListItemByValuesOptions", - "text": "SearchListItemByValuesOptions" - } + "SearchListItemByValuesOptions" ], "description": [], "source": { @@ -3315,14 +2906,8 @@ ], "signature": [ "({ type, listId, value, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.SearchListItemByValuesOptions", - "text": "SearchListItemByValuesOptions" - }, - ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" + "SearchListItemByValuesOptions", + ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" ], "description": [], "label": "searchListItemByValues", @@ -3338,17 +2923,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.findList.$1", "type": "Object", "label": "{\n filter,\n currentIndexPosition,\n perPage,\n page,\n sortField,\n sortOrder,\n searchAfter,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindListOptions", - "text": "FindListOptions" - } + "FindListOptions" ], "description": [], "source": { @@ -3359,14 +2939,8 @@ ], "signature": [ "({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindListOptions", - "text": "FindListOptions" - }, - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + "FindListOptions", + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "description": [], "label": "findList", @@ -3382,17 +2956,12 @@ "type": "Function", "children": [ { + "id": "def-server.ListClient.findListItem.$1", "type": "Object", "label": "{\n listId,\n filter,\n currentIndexPosition,\n perPage,\n page,\n sortField,\n sortOrder,\n searchAfter,\n }", "isRequired": true, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindListItemOptions", - "text": "FindListItemOptions" - } + "FindListItemOptions" ], "description": [], "source": { @@ -3403,14 +2972,8 @@ ], "signature": [ "({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.FindListItemOptions", - "text": "FindListItemOptions" - }, - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" + "FindListItemOptions", + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findListItem", @@ -3463,7 +3026,7 @@ "lineNumber": 119 }, "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" ] }, { @@ -3605,13 +3168,7 @@ "lineNumber": 41 }, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetExceptionListClientType", - "text": "GetExceptionListClientType" - } + "GetExceptionListClientType" ] }, { @@ -3625,13 +3182,7 @@ "lineNumber": 42 }, "signature": [ - { - "pluginId": "lists", - "scope": "server", - "docId": "kibListsPluginApi", - "section": "def-server.GetListClientType", - "text": "GetListClientType" - } + "GetListClientType" ] } ], @@ -3745,7 +3296,7 @@ "lineNumber": 146 }, "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" ] }, { @@ -3894,7 +3445,7 @@ "type": "Function", "children": [ { - "id": "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}", + "id": "def-common.buildExceptionFilter.$1.listsexcludeExceptionschunkSize", "type": "Object", "label": "{\n lists,\n excludeExceptions,\n chunkSize,\n}", "tags": [], @@ -3902,7 +3453,7 @@ "children": [ { "tags": [], - "id": "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}.lists", + "id": "def-common.buildExceptionFilter.$1.listsexcludeExceptionschunkSize.lists", "type": "Array", "label": "lists", "description": [], @@ -3911,12 +3462,12 @@ "lineNumber": 74 }, "signature": [ - "(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]" + "(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]" ] }, { "tags": [], - "id": "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}.excludeExceptions", + "id": "def-common.buildExceptionFilter.$1.listsexcludeExceptionschunkSize.excludeExceptions", "type": "boolean", "label": "excludeExceptions", "description": [], @@ -3927,7 +3478,7 @@ }, { "tags": [], - "id": "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}.chunkSize", + "id": "def-common.buildExceptionFilter.$1.listsexcludeExceptionschunkSize.chunkSize", "type": "number", "label": "chunkSize", "description": [], @@ -3944,7 +3495,7 @@ } ], "signature": [ - "({ lists, excludeExceptions, chunkSize, }: { lists: (({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]; excludeExceptions: boolean; chunkSize: number; }) => ", + "({ lists, excludeExceptions, chunkSize, }: { lists: (({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]; excludeExceptions: boolean; chunkSize: number; }) => ", { "pluginId": "data", "scope": "common", @@ -3975,7 +3526,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 219 + "lineNumber": 223 }, "initialIsOpen": false }, @@ -3987,7 +3538,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 276 + "lineNumber": 281 }, "initialIsOpen": false }, @@ -3999,7 +3550,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 281 + "lineNumber": 286 }, "initialIsOpen": false } @@ -4076,7 +3627,7 @@ "lineNumber": 55 }, "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "initialIsOpen": false }, @@ -4091,7 +3642,7 @@ "lineNumber": 50 }, "signature": [ - "{ description: string; name: string; type: \"endpoint\" | \"detection\"; } & { list_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; version?: number | undefined; }" + "{ description: string; name: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; } & { list_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; version?: number | undefined; }" ], "initialIsOpen": false }, @@ -4140,7 +3691,7 @@ "lineNumber": 22 }, "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" ], "initialIsOpen": false }, @@ -4155,7 +3706,7 @@ "lineNumber": 17 }, "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }" + "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }" ], "initialIsOpen": false }, @@ -4185,7 +3736,7 @@ "lineNumber": 21 }, "signature": [ - "{ field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" + "{ field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" ], "initialIsOpen": false }, @@ -4245,7 +3796,7 @@ "lineNumber": 53 }, "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "initialIsOpen": false }, @@ -4260,7 +3811,7 @@ "lineNumber": 52 }, "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }" ], "initialIsOpen": false }, @@ -4272,10 +3823,10 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 217 + "lineNumber": 221 }, "signature": [ - "\"endpoint\" | \"detection\"" + "\"endpoint\" | \"detection\" | \"endpoint_events\"" ], "initialIsOpen": false }, @@ -4290,7 +3841,7 @@ "lineNumber": 48 }, "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" ], "initialIsOpen": false }, @@ -4332,7 +3883,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 275 + "lineNumber": 280 }, "signature": [ "\"excluded\" | \"included\"" @@ -4347,7 +3898,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 325 + "lineNumber": 330 }, "signature": [ "(\"windows\" | \"linux\" | \"macos\")[]" @@ -4365,7 +3916,7 @@ "lineNumber": 123 }, "signature": [ - "\"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"" + "\"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"" ], "initialIsOpen": false }, @@ -4380,7 +3931,7 @@ "lineNumber": 55 }, "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "initialIsOpen": false } @@ -4605,7 +4156,7 @@ }, "signature": [ "KeyofC", - "<{ detection: null; endpoint: null; }>" + "<{ detection: null; endpoint: null; endpoint_events: null; }>" ], "initialIsOpen": false }, @@ -4679,7 +4230,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 317 + "lineNumber": 322 }, "signature": [ "KeyofC", @@ -4695,7 +4246,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 324 + "lineNumber": 329 }, "signature": [ "Type", diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 5d5f77154835..9c6edcab18c9 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -19,6 +19,9 @@ import listsObj from './lists.json'; ### Start +### Objects + + ### Functions diff --git a/api_docs/management.json b/api_docs/management.json index fb3c2ad2c33c..981689af8802 100644 --- a/api_docs/management.json +++ b/api_docs/management.json @@ -31,13 +31,7 @@ "lineNumber": 20 }, "signature": [ - { - "pluginId": "management", - "scope": "public", - "docId": "kibManagementPluginApi", - "section": "def-public.Mount", - "text": "Mount" - } + "Mount" ] }, { @@ -81,6 +75,7 @@ "description": [], "children": [ { + "id": "def-public.ManagementApp.Unnamed.$1", "type": "Object", "label": "args", "isRequired": true, @@ -163,18 +158,13 @@ "description": [], "children": [ { + "id": "def-public.ManagementSection.Unnamed.$1", "type": "Object", "label": "args", "isRequired": true, "signature": [ "Pick & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"title\" | \"id\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">" ], "description": [], @@ -216,6 +206,7 @@ "description": [], "children": [ { + "id": "def-public.ManagementSection.registerApp.$1", "type": "Object", "label": "args", "isRequired": true, @@ -262,6 +253,7 @@ "description": [], "children": [ { + "id": "def-public.ManagementSection.getApp.$1", "type": "string", "label": "id", "isRequired": true, @@ -555,13 +547,7 @@ "lineNumber": 14 }, "signature": [ - { - "pluginId": "management", - "scope": "public", - "docId": "kibManagementPluginApi", - "section": "def-public.Mount", - "text": "Mount" - } + "Mount" ] }, { @@ -641,13 +627,7 @@ "lineNumber": 14 }, "signature": [ - { - "pluginId": "management", - "scope": "public", - "docId": "kibManagementPluginApi", - "section": "def-public.SectionsServiceSetup", - "text": "SectionsServiceSetup" - } + "SectionsServiceSetup" ] } ], diff --git a/api_docs/maps.json b/api_docs/maps.json index 7d25efab1f6f..fca5e82bc0e1 100644 --- a/api_docs/maps.json +++ b/api_docs/maps.json @@ -1,7 +1,788 @@ { "id": "maps", "client": { - "classes": [], + "classes": [ + { + "id": "def-public.MapEmbeddable", + "type": "Class", + "tags": [], + "label": "MapEmbeddable", + "description": [], + "signature": [ + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.MapEmbeddable", + "text": "MapEmbeddable" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + "<", + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.MapEmbeddableInput", + "text": "MapEmbeddableInput" + }, + ", ", + "MapEmbeddableOutput", + "> implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ReferenceOrValueEmbeddable", + "text": "ReferenceOrValueEmbeddable" + } + ], + "children": [ + { + "tags": [], + "id": "def-public.MapEmbeddable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 94 + } + }, + { + "id": "def-public.MapEmbeddable.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.MapEmbeddable.Unnamed.$1", + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "MapEmbeddableConfig" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 111 + } + }, + { + "id": "def-public.MapEmbeddable.Unnamed.$2", + "type": "CompoundType", + "label": "initialInput", + "isRequired": true, + "signature": [ + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.MapEmbeddableInput", + "text": "MapEmbeddableInput" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 111 + } + }, + { + "id": "def-public.MapEmbeddable.Unnamed.$3", + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 111 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 111 + } + }, + { + "id": "def-public.MapEmbeddable.inputIsRefType", + "type": "Function", + "label": "inputIsRefType", + "signature": [ + "(input: ", + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.MapEmbeddableInput", + "text": "MapEmbeddableInput" + }, + ") => input is ", + "MapByReferenceInput" + ], + "description": [], + "children": [ + { + "id": "def-public.MapEmbeddable.inputIsRefType.$1", + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.MapEmbeddableInput", + "text": "MapEmbeddableInput" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 186 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 185 + } + }, + { + "id": "def-public.MapEmbeddable.getInputAsRefType", + "type": "Function", + "label": "getInputAsRefType", + "signature": [ + "() => Promise<", + "MapByReferenceInput", + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 191 + } + }, + { + "id": "def-public.MapEmbeddable.getInputAsValueType", + "type": "Function", + "label": "getInputAsValueType", + "signature": [ + "() => Promise<", + "MapByValueInput", + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 199 + } + }, + { + "id": "def-public.MapEmbeddable.getDescription", + "type": "Function", + "label": "getDescription", + "signature": [ + "() => string | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 204 + } + }, + { + "id": "def-public.MapEmbeddable.supportedTriggers", + "type": "Function", + "label": "supportedTriggers", + "signature": [ + "() => string[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 208 + } + }, + { + "id": "def-public.MapEmbeddable.setRenderTooltipContent", + "type": "Function", + "children": [ + { + "id": "def-public.MapEmbeddable.setRenderTooltipContent.$1", + "type": "Function", + "label": "renderTooltipContent", + "isRequired": true, + "signature": [ + "RenderToolTipContent" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 212 + } + } + ], + "signature": [ + "(renderTooltipContent: ", + "RenderToolTipContent", + ") => void" + ], + "description": [], + "label": "setRenderTooltipContent", + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 212 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.MapEmbeddable.setEventHandlers", + "type": "Function", + "children": [ + { + "id": "def-public.MapEmbeddable.setEventHandlers.$1", + "type": "Object", + "label": "eventHandlers", + "isRequired": true, + "signature": [ + "EventHandlers" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 216 + } + } + ], + "signature": [ + "(eventHandlers: ", + "EventHandlers", + ") => void" + ], + "description": [], + "label": "setEventHandlers", + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 216 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.MapEmbeddable.getInspectorAdapters", + "type": "Function", + "label": "getInspectorAdapters", + "signature": [ + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 220 + } + }, + { + "id": "def-public.MapEmbeddable.onUpdate", + "type": "Function", + "label": "onUpdate", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 224 + } + }, + { + "id": "def-public.MapEmbeddable._dispatchSetQuery", + "type": "Function", + "label": "_dispatchSetQuery", + "signature": [ + "({ forceRefresh }: { forceRefresh: boolean; }) => void" + ], + "description": [], + "children": [ + { + "id": "def-public.MapEmbeddable._dispatchSetQuery.$1.forceRefresh", + "type": "Object", + "label": "{ forceRefresh }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.MapEmbeddable._dispatchSetQuery.$1.forceRefresh.forceRefresh", + "type": "boolean", + "label": "forceRefresh", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 256 + } + } + ], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 256 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 256 + } + }, + { + "id": "def-public.MapEmbeddable._dispatchSetRefreshConfig", + "type": "Function", + "label": "_dispatchSetRefreshConfig", + "signature": [ + "(refreshConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + ") => void" + ], + "description": [], + "children": [ + { + "id": "def-public.MapEmbeddable._dispatchSetRefreshConfig.$1", + "type": "Object", + "label": "refreshConfig", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 278 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 278 + } + }, + { + "id": "def-public.MapEmbeddable._dispatchSetChartsPaletteServiceGetColor", + "type": "Function", + "label": "_dispatchSetChartsPaletteServiceGetColor", + "signature": [ + "(syncColors?: boolean | undefined) => Promise" + ], + "description": [], + "children": [ + { + "id": "def-public.MapEmbeddable._dispatchSetChartsPaletteServiceGetColor.$1", + "type": "CompoundType", + "label": "syncColors", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 288 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 288 + } + }, + { + "id": "def-public.MapEmbeddable.render", + "type": "Function", + "label": "render", + "signature": [ + "(domNode: HTMLElement) => void" + ], + "description": [ + "\n" + ], + "children": [ + { + "id": "def-public.MapEmbeddable.render.$1", + "type": "Object", + "label": "domNode", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 306 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 306 + } + }, + { + "id": "def-public.MapEmbeddable.setLayerList", + "type": "Function", + "label": "setLayerList", + "signature": [ + "(layerList: ", + "LayerDescriptor", + "[]) => void" + ], + "description": [], + "children": [ + { + "id": "def-public.MapEmbeddable.setLayerList.$1", + "type": "Array", + "label": "layerList", + "isRequired": true, + "signature": [ + "LayerDescriptor", + "[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 332 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 332 + } + }, + { + "id": "def-public.MapEmbeddable.onSingleValueTrigger", + "type": "Function", + "children": [ + { + "id": "def-public.MapEmbeddable.onSingleValueTrigger.$1", + "type": "string", + "label": "actionId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 349 + } + }, + { + "id": "def-public.MapEmbeddable.onSingleValueTrigger.$2", + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 349 + } + }, + { + "id": "def-public.MapEmbeddable.onSingleValueTrigger.$3", + "type": "CompoundType", + "label": "value", + "isRequired": false, + "signature": [ + { + "pluginId": "maps", + "scope": "common", + "docId": "kibMapsPluginApi", + "section": "def-common.RawValue", + "text": "RawValue" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 349 + } + } + ], + "signature": [ + "(actionId: string, key: string, value: ", + { + "pluginId": "maps", + "scope": "common", + "docId": "kibMapsPluginApi", + "section": "def-common.RawValue", + "text": "RawValue" + }, + ") => void" + ], + "description": [], + "label": "onSingleValueTrigger", + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 349 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.MapEmbeddable.addFilters", + "type": "Function", + "children": [ + { + "id": "def-public.MapEmbeddable.addFilters.$1", + "type": "Array", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 363 + } + }, + { + "id": "def-public.MapEmbeddable.addFilters.$2", + "type": "string", + "label": "actionId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 363 + } + } + ], + "signature": [ + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], actionId?: string) => Promise" + ], + "description": [], + "label": "addFilters", + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 363 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.MapEmbeddable.getFilterActions", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "[]>" + ], + "description": [], + "label": "getFilterActions", + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 375 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.MapEmbeddable.getActionContext", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionExecutionContext", + "text": "ActionExecutionContext" + }, + "" + ], + "description": [], + "label": "getActionContext", + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 396 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.MapEmbeddable.destroy", + "type": "Function", + "label": "destroy", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 407 + } + }, + { + "id": "def-public.MapEmbeddable.reload", + "type": "Function", + "label": "reload", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 423 + } + }, + { + "id": "def-public.MapEmbeddable._handleStoreChanges", + "type": "Function", + "label": "_handleStoreChanges", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 429 + } + } + ], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "lineNumber": 91 + }, + "initialIsOpen": false + } + ], "functions": [], "interfaces": [ { @@ -21,6 +802,7 @@ "description": [], "children": [ { + "id": "def-public.RenderTooltipContentParams.addFilters.$1", "type": "Uncategorized", "label": "filter", "isRequired": true, @@ -34,6 +816,7 @@ } }, { + "id": "def-public.RenderTooltipContentParams.addFilters.$2", "type": "string", "label": "actionId", "isRequired": true, @@ -81,13 +864,7 @@ "lineNumber": 34 }, "signature": [ - { - "pluginId": "maps", - "scope": "common", - "docId": "kibMapsPluginApi", - "section": "def-common.TooltipFeature", - "text": "TooltipFeature" - }, + "TooltipFeature", "[]" ] }, @@ -112,6 +889,7 @@ "description": [], "children": [ { + "id": "def-public.RenderTooltipContentParams.getLayerName.$1", "type": "string", "label": "layerId", "isRequired": true, @@ -138,37 +916,20 @@ "label": "loadFeatureProperties", "signature": [ "({ layerId, featureId }: ", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.LoadFeatureProps", - "text": "LoadFeatureProps" - }, + "LoadFeatureProps", ") => Promise<", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.ITooltipProperty", - "text": "ITooltipProperty" - }, + "ITooltipProperty", "[]>" ], "description": [], "children": [ { + "id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1", "type": "Object", "label": "{ layerId, featureId }", "isRequired": true, "signature": [ - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.LoadFeatureProps", - "text": "LoadFeatureProps" - } + "LoadFeatureProps" ], "description": [], "source": { @@ -190,36 +951,19 @@ "label": "loadFeatureGeometry", "signature": [ "({ layerId, featureId }: ", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.LoadFeatureProps", - "text": "LoadFeatureProps" - }, + "LoadFeatureProps", ") => ", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.FeatureGeometry", - "text": "FeatureGeometry" - } + "FeatureGeometry" ], "description": [], "children": [ { + "id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1", "type": "Object", "label": "{ layerId, featureId }", "isRequired": true, "signature": [ - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.LoadFeatureProps", - "text": "LoadFeatureProps" - } + "LoadFeatureProps" ], "description": [], "source": { @@ -259,6 +1003,23 @@ "\"map\"" ], "initialIsOpen": false + }, + { + "id": "def-public.MapEmbeddableInput", + "type": "Type", + "label": "MapEmbeddableInput", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/types.ts", + "lineNumber": 41 + }, + "signature": [ + "MapByValueInput", + " | ", + "MapByReferenceInput" + ], + "initialIsOpen": false } ], "objects": [], @@ -277,41 +1038,17 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/api/start_api.ts", - "lineNumber": 14 + "lineNumber": 15 }, "signature": [ "{ createSecurityLayerDescriptors: (indexPatternId: string, indexPatternTitle: string) => Promise<", - { - "pluginId": "maps", - "scope": "common", - "docId": "kibMapsPluginApi", - "section": "def-common.LayerDescriptor", - "text": "LayerDescriptor" - }, + "LayerDescriptor", "[]>; createBasemapLayerDescriptor: () => Promise<", - { - "pluginId": "maps", - "scope": "common", - "docId": "kibMapsPluginApi", - "section": "def-common.LayerDescriptor", - "text": "LayerDescriptor" - }, + "LayerDescriptor", " | null>; createESSearchSourceLayerDescriptor: (params: ", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.CreateLayerDescriptorParams", - "text": "CreateLayerDescriptorParams" - }, + "CreateLayerDescriptorParams", ") => Promise<", - { - "pluginId": "maps", - "scope": "common", - "docId": "kibMapsPluginApi", - "section": "def-common.LayerDescriptor", - "text": "LayerDescriptor" - }, + "LayerDescriptor", ">; }" ] }, @@ -321,34 +1058,23 @@ "label": "registerLayerWizard", "signature": [ "(layerWizard: ", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.LayerWizard", - "text": "LayerWizard" - }, + "LayerWizard", ") => Promise" ], "description": [], "children": [ { + "id": "def-public.MapsStartApi.registerLayerWizard.$1", "type": "Object", "label": "layerWizard", "isRequired": true, "signature": [ - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.LayerWizard", - "text": "LayerWizard" - } + "LayerWizard" ], "description": [], "source": { "path": "x-pack/plugins/maps/public/api/start_api.ts", - "lineNumber": 24 + "lineNumber": 25 } } ], @@ -356,7 +1082,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/api/start_api.ts", - "lineNumber": 24 + "lineNumber": 25 } }, { @@ -365,34 +1091,23 @@ "label": "registerSource", "signature": [ "(entry: ", - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.SourceRegistryEntry", - "text": "SourceRegistryEntry" - }, + "SourceRegistryEntry", ") => Promise" ], "description": [], "children": [ { + "id": "def-public.MapsStartApi.registerSource.$1", "type": "Object", "label": "entry", "isRequired": true, "signature": [ - { - "pluginId": "maps", - "scope": "public", - "docId": "kibMapsPluginApi", - "section": "def-public.SourceRegistryEntry", - "text": "SourceRegistryEntry" - } + "SourceRegistryEntry" ], "description": [], "source": { "path": "x-pack/plugins/maps/public/api/start_api.ts", - "lineNumber": 25 + "lineNumber": 26 } } ], @@ -400,13 +1115,48 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/api/start_api.ts", - "lineNumber": 25 + "lineNumber": 26 + } + }, + { + "id": "def-public.MapsStartApi.suggestEMSTermJoinConfig", + "type": "Function", + "label": "suggestEMSTermJoinConfig", + "signature": [ + "(config: ", + "SampleValuesConfig", + ") => Promise<", + "EMSTermJoinConfig", + " | null>" + ], + "description": [], + "children": [ + { + "id": "def-public.MapsStartApi.suggestEMSTermJoinConfig.$1", + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "SampleValuesConfig" + ], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/api/start_api.ts", + "lineNumber": 27 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/maps/public/api/start_api.ts", + "lineNumber": 27 } } ], "source": { "path": "x-pack/plugins/maps/public/api/start_api.ts", - "lineNumber": 13 + "lineNumber": 14 }, "lifecycle": "start", "initialIsOpen": true @@ -433,6 +1183,7 @@ "description": [], "children": [ { + "id": "def-common.getEditPath.$1", "type": "string", "label": "id", "isRequired": true, @@ -464,6 +1215,7 @@ "description": [], "children": [ { + "id": "def-common.getExistingMapPath.$1", "type": "string", "label": "id", "isRequired": true, @@ -612,6 +1364,59 @@ "lineNumber": 13 }, "initialIsOpen": false + }, + { + "id": "def-common.WriteSettings", + "type": "Interface", + "label": "WriteSettings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.WriteSettings.index", + "type": "string", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/types.ts", + "lineNumber": 27 + } + }, + { + "tags": [], + "id": "def-common.WriteSettings.body", + "type": "Uncategorized", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/types.ts", + "lineNumber": 28 + }, + "signature": [ + "object" + ] + }, + { + "id": "def-common.WriteSettings.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/types.ts", + "lineNumber": 29 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/maps/common/types.ts", + "lineNumber": 26 + }, + "initialIsOpen": false } ], "enums": [ @@ -1346,6 +2151,51 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.emsRegionLayerId", + "type": "string", + "label": "emsRegionLayerId", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/constants.ts", + "lineNumber": 305 + }, + "signature": [ + "\"administrative_regions_lvl2\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.emsUsaZipLayerId", + "type": "string", + "label": "emsUsaZipLayerId", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/constants.ts", + "lineNumber": 306 + }, + "signature": [ + "\"usa_zip_codes\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.emsWorldLayerId", + "type": "string", + "label": "emsWorldLayerId", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/constants.ts", + "lineNumber": 304 + }, + "signature": [ + "\"world_countries\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.ES_GEO_FIELD_TYPES", @@ -1669,6 +2519,21 @@ }, "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.MAX_DRAWING_SIZE_BYTES", + "type": "number", + "label": "MAX_DRAWING_SIZE_BYTES", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/constants.ts", + "lineNumber": 302 + }, + "signature": [ + "10485760" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.MAX_ZOOM", diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 9799fa176939..f4f5594b1934 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -16,6 +16,9 @@ import mapsObj from './maps.json'; ### Start +### Classes + + ### Interfaces diff --git a/api_docs/maps_ems.json b/api_docs/maps_ems.json index 472f69742076..2619d711f9b7 100644 --- a/api_docs/maps_ems.json +++ b/api_docs/maps_ems.json @@ -228,6 +228,7 @@ "description": [], "children": [ { + "id": "def-public.IServiceSettings.getEMSHotLink.$1", "type": "Object", "label": "layer", "isRequired": true, @@ -320,6 +321,7 @@ "description": [], "children": [ { + "id": "def-public.IServiceSettings.getUrlForRegionLayer.$1", "type": "Object", "label": "layer", "isRequired": true, @@ -356,14 +358,14 @@ "description": [], "children": [ { - "id": "def-public.IServiceSettings.setQueryParams.params", + "id": "def-public.IServiceSettings.setQueryParams.$1.params", "type": "Object", "label": "params", "tags": [], "description": [], "children": [ { - "id": "def-public.IServiceSettings.setQueryParams.params.Unnamed", + "id": "def-public.IServiceSettings.setQueryParams.$1.params.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], @@ -390,38 +392,6 @@ "lineNumber": 48 } }, - { - "id": "def-public.IServiceSettings.enableZoomMessage", - "type": "Function", - "label": "enableZoomMessage", - "signature": [ - "() => void" - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/maps_ems/public/service_settings/service_settings_types.ts", - "lineNumber": 49 - } - }, - { - "id": "def-public.IServiceSettings.disableZoomMessage", - "type": "Function", - "label": "disableZoomMessage", - "signature": [ - "() => void" - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/maps_ems/public/service_settings/service_settings_types.ts", - "lineNumber": 50 - } - }, { "id": "def-public.IServiceSettings.getAttributesForTMSLayer", "type": "Function", @@ -440,6 +410,7 @@ "description": [], "children": [ { + "id": "def-public.IServiceSettings.getAttributesForTMSLayer.$1", "type": "Object", "label": "tmsServiceConfig", "isRequired": true, @@ -455,10 +426,11 @@ "description": [], "source": { "path": "src/plugins/maps_ems/public/service_settings/service_settings_types.ts", - "lineNumber": 52 + "lineNumber": 50 } }, { + "id": "def-public.IServiceSettings.getAttributesForTMSLayer.$2", "type": "boolean", "label": "isDesaturated", "isRequired": true, @@ -468,10 +440,11 @@ "description": [], "source": { "path": "src/plugins/maps_ems/public/service_settings/service_settings_types.ts", - "lineNumber": 53 + "lineNumber": 51 } }, { + "id": "def-public.IServiceSettings.getAttributesForTMSLayer.$3", "type": "boolean", "label": "isDarkMode", "isRequired": true, @@ -481,7 +454,7 @@ "description": [], "source": { "path": "src/plugins/maps_ems/public/service_settings/service_settings_types.ts", - "lineNumber": 54 + "lineNumber": 52 } } ], @@ -489,7 +462,7 @@ "returnComment": [], "source": { "path": "src/plugins/maps_ems/public/service_settings/service_settings_types.ts", - "lineNumber": 51 + "lineNumber": 49 } } ], @@ -902,6 +875,7 @@ "description": [], "children": [ { + "id": "def-server.MapsEmsPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -947,6 +921,7 @@ "description": [], "children": [ { + "id": "def-server.MapsEmsPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, diff --git a/api_docs/ml.json b/api_docs/ml.json index 067ae4c0ea21..fc9d09c22c4a 100644 --- a/api_docs/ml.json +++ b/api_docs/ml.json @@ -37,6 +37,7 @@ "description": [], "children": [ { + "id": "def-public.MlUrlGenerator.Unnamed.$1", "type": "Object", "label": "params", "isRequired": true, @@ -76,17 +77,12 @@ "type": "Function", "children": [ { + "id": "def-public.MlUrlGenerator.createUrl.$1", "type": "CompoundType", "label": "mlUrlGeneratorParams", "isRequired": true, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.MlUrlGeneratorState", - "text": "MlUrlGeneratorState" - } + "MlUrlGeneratorState" ], "description": [], "source": { @@ -97,13 +93,7 @@ ], "signature": [ "(mlUrlGeneratorParams: ", - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.MlUrlGeneratorState", - "text": "MlUrlGeneratorState" - }, + "MlUrlGeneratorState", ") => Promise" ], "description": [], @@ -136,6 +126,7 @@ ], "children": [ { + "id": "def-public.getFormattedSeverityScore.$1", "type": "number", "label": "score", "isRequired": true, @@ -145,7 +136,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 116 + "lineNumber": 124 } } ], @@ -153,7 +144,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 116 + "lineNumber": 124 }, "initialIsOpen": false }, @@ -186,6 +177,7 @@ "description": [], "children": [ { + "id": "def-public.getSeverityColor.$1", "type": "number", "label": "normalizedScore", "isRequired": true, @@ -195,7 +187,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 177 + "lineNumber": 185 } } ], @@ -203,7 +195,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 177 + "lineNumber": 185 }, "initialIsOpen": false }, @@ -224,6 +216,7 @@ "description": [], "children": [ { + "id": "def-public.getSeverityType.$1", "type": "number", "label": "normalizedScore", "isRequired": true, @@ -233,7 +226,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 138 + "lineNumber": 146 } } ], @@ -241,7 +234,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 138 + "lineNumber": 146 }, "initialIsOpen": false }, @@ -250,6 +243,7 @@ "type": "Function", "children": [ { + "id": "def-public.useMlHref.$1", "type": "Object", "label": "ml", "isRequired": false, @@ -271,6 +265,7 @@ } }, { + "id": "def-public.useMlHref.$2", "type": "string", "label": "basePath", "isRequired": false, @@ -284,17 +279,12 @@ } }, { + "id": "def-public.useMlHref.$3", "type": "CompoundType", "label": "params", "isRequired": true, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.MlUrlGeneratorState", - "text": "MlUrlGeneratorState" - } + "MlUrlGeneratorState" ], "description": [], "source": { @@ -359,13 +349,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.AnomalyRecordDoc", - "text": "AnomalyRecordDoc" - } + "AnomalyRecordDoc" ] }, { @@ -549,13 +533,7 @@ "lineNumber": 94 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.DatafeedResponse", - "text": "DatafeedResponse" - }, + "DatafeedResponse", "[]" ] }, @@ -570,13 +548,7 @@ "lineNumber": 95 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.JobResponse", - "text": "JobResponse" - }, + "JobResponse", "[]" ] }, @@ -592,29 +564,11 @@ }, "signature": [ "{ search: ", - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.KibanaObjectResponse", - "text": "KibanaObjectResponse" - }, + "KibanaObjectResponse", "[]; visualization: ", - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.KibanaObjectResponse", - "text": "KibanaObjectResponse" - }, + "KibanaObjectResponse", "[]; dashboard: ", - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.KibanaObjectResponse", - "text": "KibanaObjectResponse" - }, + "KibanaObjectResponse", "[]; }" ] } @@ -693,13 +647,7 @@ "lineNumber": 17 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.JobStat", - "text": "JobStat" - }, + "JobStat", "[]" ] } @@ -789,13 +737,7 @@ "lineNumber": 151 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.MlCapabilities", - "text": "MlCapabilities" - } + "MlCapabilities" ] }, { @@ -1020,13 +962,7 @@ "lineNumber": 28 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.CombinedJob", - "text": "CombinedJob" - }, + "CombinedJob", " | undefined" ] }, @@ -1056,13 +992,7 @@ }, "signature": [ "Partial<", - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.AuditMessage", - "text": "AuditMessage" - }, + "AuditMessage", "> | undefined" ] }, @@ -1165,7 +1095,7 @@ }, " extends Pick<", "UseDataGridReturnType", - ", \"status\" | \"baseline\" | \"pagination\" | \"errorMessage\" | \"chartsVisible\" | \"chartsButtonVisible\" | \"columnsWithCharts\" | \"invalidSortingColumnns\" | \"noDataMessage\" | \"onChangeItemsPerPage\" | \"onChangePage\" | \"onSort\" | \"setPagination\" | \"setVisibleColumns\" | \"rowCount\" | \"rowCountRelation\" | \"sortingColumns\" | \"tableItems\" | \"toggleChartVisibility\" | \"visibleColumns\" | \"predictionFieldName\" | \"resultsField\">" + ", \"status\" | \"baseline\" | \"pagination\" | \"errorMessage\" | \"chartsVisible\" | \"chartsButtonVisible\" | \"ccsWarning\" | \"columnsWithCharts\" | \"invalidSortingColumnns\" | \"noDataMessage\" | \"onChangeItemsPerPage\" | \"onChangePage\" | \"onSort\" | \"setPagination\" | \"setVisibleColumns\" | \"rowCount\" | \"rowCountRelation\" | \"sortingColumns\" | \"tableItems\" | \"toggleChartVisibility\" | \"visibleColumns\" | \"predictionFieldName\" | \"resultsField\">" ], "description": [], "tags": [], @@ -1178,7 +1108,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", - "lineNumber": 83 + "lineNumber": 84 }, "signature": [ { @@ -1236,7 +1166,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/public/embeddables/types.ts", - "lineNumber": 40 + "lineNumber": 49 }, "signature": [ "EmbeddableInput & AnomalySwimlaneEmbeddableCustomInput" @@ -1310,16 +1240,18 @@ "objects": [ { "tags": [], - "id": "def-public.HITS_TOTAL_RELATION", + "id": "def-public.ES_CLIENT_TOTAL_HITS_RELATION", "type": "Object", - "label": "HITS_TOTAL_RELATION", + "label": "ES_CLIENT_TOTAL_HITS_RELATION", "description": [], "source": { "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 10 + "lineNumber": 20 }, "signature": [ - "{ readonly EQ: \"eq\"; readonly GTE: \"gte\"; }" + "Record<\"GTE\" | \"EQ\", ", + "TotalHitsRelation", + ">" ], "initialIsOpen": false }, @@ -1401,6 +1333,7 @@ "description": [], "children": [ { + "id": "def-server.InsufficientMLCapabilities.Unnamed.$1", "type": "string", "label": "message", "isRequired": false, @@ -1455,6 +1388,7 @@ "description": [], "children": [ { + "id": "def-server.MLPrivilegesUninitialized.Unnamed.$1", "type": "string", "label": "message", "isRequired": false, @@ -1509,6 +1443,7 @@ "description": [], "children": [ { + "id": "def-server.UnknownMLCapabilitiesError.Unnamed.$1", "type": "string", "label": "message", "isRequired": false, @@ -1543,6 +1478,7 @@ "type": "Function", "children": [ { + "id": "def-server.getHistogramsForFields.$1", "type": "Object", "label": "client", "isRequired": true, @@ -1562,6 +1498,7 @@ } }, { + "id": "def-server.getHistogramsForFields.$2", "type": "string", "label": "indexPatternTitle", "isRequired": true, @@ -1575,6 +1512,7 @@ } }, { + "id": "def-server.getHistogramsForFields.$3", "type": "Any", "label": "query", "isRequired": true, @@ -1588,17 +1526,12 @@ } }, { + "id": "def-server.getHistogramsForFields.$4", "type": "Array", "label": "fields", "isRequired": true, "signature": [ - { - "pluginId": "ml", - "scope": "server", - "docId": "kibMlPluginApi", - "section": "def-server.HistogramField", - "text": "HistogramField" - }, + "HistogramField", "[]" ], "description": [], @@ -1608,6 +1541,7 @@ } }, { + "id": "def-server.getHistogramsForFields.$5", "type": "number", "label": "samplerShardSize", "isRequired": true, @@ -1621,6 +1555,7 @@ } }, { + "id": "def-server.getHistogramsForFields.$6", "type": "Object", "label": "runtimeMappings", "isRequired": false, @@ -1671,6 +1606,7 @@ "description": [], "children": [ { + "id": "def-server.isCombinedJobWithStats.$1", "type": "Any", "label": "arg", "isRequired": true, @@ -1723,13 +1659,7 @@ "lineNumber": 45 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.AnomalyRecordDoc", - "text": "AnomalyRecordDoc" - } + "AnomalyRecordDoc" ] }, { @@ -2287,13 +2217,7 @@ "lineNumber": 32 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.Influencer", - "text": "Influencer" - }, + "Influencer", "[] | undefined" ] }, @@ -2566,13 +2490,7 @@ "lineNumber": 25 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.DatafeedWithStats", - "text": "DatafeedWithStats" - } + "DatafeedWithStats" ] } ], @@ -2600,13 +2518,7 @@ "lineNumber": 16 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.UrlConfig", - "text": "UrlConfig" - }, + "UrlConfig", "[] | undefined" ] }, @@ -2621,13 +2533,7 @@ "lineNumber": 17 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.CREATED_BY_LABEL", - "text": "CREATED_BY_LABEL" - }, + "CREATED_BY_LABEL", " | undefined" ] }, @@ -2896,13 +2802,7 @@ "lineNumber": 13 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.DATAFEED_STATE", - "text": "DATAFEED_STATE" - } + "DATAFEED_STATE" ] }, { @@ -2916,13 +2816,7 @@ "lineNumber": 14 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.Node", - "text": "Node" - } + "Node" ] }, { @@ -3117,13 +3011,7 @@ "lineNumber": 12 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.DataCounts", - "text": "DataCounts" - } + "DataCounts" ] }, { @@ -3137,13 +3025,7 @@ "lineNumber": 13 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.ModelSizeStats", - "text": "ModelSizeStats" - } + "ModelSizeStats" ] }, { @@ -3157,13 +3039,7 @@ "lineNumber": 14 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.ForecastsStats", - "text": "ForecastsStats" - } + "ForecastsStats" ] }, { @@ -3177,13 +3053,7 @@ "lineNumber": 15 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.JOB_STATE", - "text": "JOB_STATE" - } + "JOB_STATE" ] }, { @@ -3197,13 +3067,7 @@ "lineNumber": 16 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.Node", - "text": "Node" - } + "Node" ] }, { @@ -3503,13 +3367,7 @@ "lineNumber": 28 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.CombinedJob", - "text": "CombinedJob" - }, + "CombinedJob", " | undefined" ] }, @@ -3539,13 +3397,7 @@ }, "signature": [ "Partial<", - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.AuditMessage", - "text": "AuditMessage" - }, + "AuditMessage", "> | undefined" ] }, @@ -3950,13 +3802,7 @@ "lineNumber": 18 }, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.ModelSizeStats", - "text": "ModelSizeStats" - } + "ModelSizeStats" ] }, { @@ -4172,7 +4018,7 @@ "lineNumber": 81 }, "signature": [ - "\"bucket\" | \"record\" | \"influencer\"" + "\"record\" | \"bucket\" | \"influencer\"" ], "initialIsOpen": false }, @@ -4491,6 +4337,7 @@ ], "children": [ { + "id": "def-common.composeValidators.$1", "type": "Array", "label": "validators", "isRequired": true, @@ -4517,17 +4364,12 @@ "type": "Function", "children": [ { + "id": "def-common.extractErrorMessage.$1", "type": "CompoundType", "label": "error", "isRequired": false, "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.ErrorType", - "text": "ErrorType" - } + "ErrorType" ], "description": [], "source": { @@ -4561,6 +4403,7 @@ "description": [], "children": [ { + "id": "def-common.getSeverityColor.$1", "type": "number", "label": "normalizedScore", "isRequired": true, @@ -4570,7 +4413,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 177 + "lineNumber": 185 } } ], @@ -4578,7 +4421,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 177 + "lineNumber": 185 }, "initialIsOpen": false }, @@ -4599,6 +4442,7 @@ "description": [], "children": [ { + "id": "def-common.getSeverityType.$1", "type": "number", "label": "normalizedScore", "isRequired": true, @@ -4608,7 +4452,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 138 + "lineNumber": 146 } } ], @@ -4616,148 +4460,156 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "lineNumber": 138 + "lineNumber": 146 }, "initialIsOpen": false }, { - "id": "def-common.patternValidator", + "id": "def-common.isPopulatedObject", "type": "Function", - "label": "patternValidator", + "children": [ + { + "id": "def-common.isPopulatedObject.$1", + "type": "Unknown", + "label": "arg", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/util/object_utils.ts", + "lineNumber": 26 + } + }, + { + "id": "def-common.isPopulatedObject.$2", + "type": "Array", + "label": "requiredAttributes", + "isRequired": true, + "signature": [ + "U[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/util/object_utils.ts", + "lineNumber": 27 + } + } + ], "signature": [ - "(pattern: RegExp) => (value: string) => { pattern: { matchPattern: string; }; } | null" + "(arg: unknown, requiredAttributes?: U[]) => arg is Record" ], - "description": [ - "\nProvides a validator function for checking against pattern." + "description": [], + "label": "isPopulatedObject", + "source": { + "path": "x-pack/plugins/ml/common/util/object_utils.ts", + "lineNumber": 25 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isRuntimeField", + "type": "Function", + "label": "isRuntimeField", + "signature": [ + "(arg: unknown) => boolean" ], + "description": [], "children": [ { - "type": "Object", - "label": "pattern", + "id": "def-common.isRuntimeField.$1", + "type": "Unknown", + "label": "arg", "isRequired": true, "signature": [ - "RegExp" + "unknown" ], "description": [], "source": { - "path": "x-pack/plugins/ml/common/util/validators.ts", - "lineNumber": 34 + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "lineNumber": 14 } } ], "tags": [], "returnComment": [], "source": { - "path": "x-pack/plugins/ml/common/util/validators.ts", - "lineNumber": 33 + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "lineNumber": 14 }, "initialIsOpen": false - } - ], - "interfaces": [ + }, { - "id": "def-common.SearchResponse7", - "type": "Interface", - "label": "SearchResponse7", + "id": "def-common.isRuntimeMappings", + "type": "Function", + "label": "isRuntimeMappings", "signature": [ - { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.SearchResponse7", - "text": "SearchResponse7" - }, - "" + "(arg: unknown) => boolean" ], "description": [], - "tags": [], "children": [ { - "tags": [], - "id": "def-common.SearchResponse7.took", - "type": "number", - "label": "took", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 26 - } - }, - { - "tags": [], - "id": "def-common.SearchResponse7.timed_out", - "type": "boolean", - "label": "timed_out", + "id": "def-common.isRuntimeMappings.$1", + "type": "Unknown", + "label": "arg", + "isRequired": true, + "signature": [ + "unknown" + ], "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", "lineNumber": 27 } - }, - { - "tags": [], - "id": "def-common.SearchResponse7._scroll_id", - "type": "string", - "label": "_scroll_id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 28 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-common.SearchResponse7._shards", - "type": "Object", - "label": "_shards", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 29 - }, - "signature": [ - "ShardsResponse" - ] - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "lineNumber": 27 + }, + "initialIsOpen": false + }, + { + "id": "def-common.patternValidator", + "type": "Function", + "label": "patternValidator", + "signature": [ + "(pattern: RegExp) => (value: string) => { pattern: { matchPattern: string; }; } | null" + ], + "description": [ + "\nProvides a validator function for checking against pattern." + ], + "children": [ { - "tags": [], - "id": "def-common.SearchResponse7.hits", + "id": "def-common.patternValidator.$1", "type": "Object", - "label": "hits", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 30 - }, + "label": "pattern", + "isRequired": true, "signature": [ - "SearchResponse7Hits" - ] - }, - { - "tags": [], - "id": "def-common.SearchResponse7.aggregations", - "type": "Any", - "label": "aggregations", + "RegExp" + ], "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 31 - }, - "signature": [ - "any" - ] + "path": "x-pack/plugins/ml/common/util/validators.ts", + "lineNumber": 34 + } } ], + "tags": [], + "returnComment": [], "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 25 + "path": "x-pack/plugins/ml/common/util/validators.ts", + "lineNumber": 33 }, "initialIsOpen": false } ], + "interfaces": [], "enums": [ { "id": "def-common.ANOMALY_SEVERITY", @@ -4805,17 +4657,17 @@ "initialIsOpen": false }, { - "id": "def-common.HitsTotalRelation", + "id": "def-common.RuntimeMappings", "type": "Type", - "label": "HitsTotalRelation", + "label": "RuntimeMappings", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 14 + "path": "x-pack/plugins/ml/common/types/fields.ts", + "lineNumber": 111 }, "signature": [ - "\"gte\" | \"eq\"" + "{ [x: string]: estypes.RuntimeField; }" ], "initialIsOpen": false } @@ -4823,16 +4675,18 @@ "objects": [ { "tags": [], - "id": "def-common.HITS_TOTAL_RELATION", + "id": "def-common.ES_CLIENT_TOTAL_HITS_RELATION", "type": "Object", - "label": "HITS_TOTAL_RELATION", + "label": "ES_CLIENT_TOTAL_HITS_RELATION", "description": [], "source": { "path": "x-pack/plugins/ml/common/types/es_client.ts", - "lineNumber": 10 + "lineNumber": 20 }, "signature": [ - "{ readonly EQ: \"eq\"; readonly GTE: \"gte\"; }" + "Record<\"GTE\" | \"EQ\", ", + "TotalHitsRelation", + ">" ], "initialIsOpen": false }, diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index aca7f85b3d2d..010bf2d2c3de 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -65,9 +65,6 @@ import mlObj from './ml.json'; ### Functions -### Interfaces - - ### Enums diff --git a/api_docs/monitoring.json b/api_docs/monitoring.json index d8b8b60495f8..831e4015cd84 100644 --- a/api_docs/monitoring.json +++ b/api_docs/monitoring.json @@ -119,9 +119,9 @@ "lineNumber": 92 }, "signature": [ - "{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; logs: Readonly<{} & { index: string; }>; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; ccs: Readonly<{} & { enabled: boolean; }>; metricbeat: Readonly<{} & { index: string; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; cluster_alerts: Readonly<{} & { enabled: boolean; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; licensing: Readonly<{} & { api_polling_frequency: ", + "{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; metricbeat: Readonly<{} & { index: string; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; licensing: Readonly<{} & { api_polling_frequency: ", "Duration", - "; }>; agent: Readonly<{} & { interval: string; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }" + "; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }" ], "initialIsOpen": false } diff --git a/api_docs/navigation.json b/api_docs/navigation.json index fce341c24ac7..7d07d06bd30e 100644 --- a/api_docs/navigation.json +++ b/api_docs/navigation.json @@ -53,6 +53,7 @@ "description": [], "children": [ { + "id": "def-public.NavigationPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -105,6 +106,7 @@ "description": [], "children": [ { + "id": "def-public.NavigationPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -146,13 +148,7 @@ "text": "CoreStart" }, ", { data }: ", - { - "pluginId": "navigation", - "scope": "public", - "docId": "kibNavigationPluginApi", - "section": "def-public.NavigationPluginStartDependencies", - "text": "NavigationPluginStartDependencies" - }, + "NavigationPluginStartDependencies", ") => ", { "pluginId": "navigation", @@ -165,6 +161,7 @@ "description": [], "children": [ { + "id": "def-public.NavigationPublicPlugin.start.$1", "type": "Object", "label": "{ i18n }", "isRequired": true, @@ -184,17 +181,12 @@ } }, { + "id": "def-public.NavigationPublicPlugin.start.$2", "type": "Object", "label": "{ data }", "isRequired": true, "signature": [ - { - "pluginId": "navigation", - "scope": "public", - "docId": "kibNavigationPluginApi", - "section": "def-public.NavigationPluginStartDependencies", - "text": "NavigationPluginStartDependencies" - } + "NavigationPluginStartDependencies" ], "description": [], "source": { @@ -253,6 +245,7 @@ "description": [], "children": [ { + "id": "def-public.TopNavMenu.$1", "type": "CompoundType", "label": "props", "isRequired": true, @@ -325,13 +318,7 @@ "lineNumber": 16 }, "signature": [ - { - "pluginId": "navigation", - "scope": "public", - "docId": "kibNavigationPluginApi", - "section": "def-public.TopNavMenuAction", - "text": "TopNavMenuAction" - } + "TopNavMenuAction" ] }, { @@ -482,7 +469,7 @@ }, "signature": [ "SearchBarOwnProps", - " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; } & Pick & { config?: TopNavMenuData[] | undefined; badges?: (({ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; iconSide?: \"left\" | \"right\" | undefined; color?: string | undefined; isDisabled?: boolean | undefined; closeButtonProps?: Partial<", + " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; } & Pick & { config?: TopNavMenuData[] | undefined; badges?: (({ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; iconSide?: \"left\" | \"right\" | undefined; color?: string | undefined; isDisabled?: boolean | undefined; closeButtonProps?: Partial<", "EuiIconProps", "> | undefined; } & ", "CommonProps", @@ -514,13 +501,7 @@ }, "signature": [ "(menuItem: ", - { - "pluginId": "navigation", - "scope": "public", - "docId": "kibNavigationPluginApi", - "section": "def-public.RegisteredTopNavMenuData", - "text": "RegisteredTopNavMenuData" - }, + "RegisteredTopNavMenuData", ") => void" ] } diff --git a/api_docs/observability.json b/api_docs/observability.json index 2128e27f0106..e35a98a31aa0 100644 --- a/api_docs/observability.json +++ b/api_docs/observability.json @@ -13,6 +13,7 @@ "description": [], "children": [ { + "id": "def-public.ActionMenu.$1", "type": "CompoundType", "label": "props", "isRequired": true, @@ -51,6 +52,56 @@ }, "initialIsOpen": false }, + { + "id": "def-public.createExploratoryViewUrl", + "type": "Function", + "label": "createExploratoryViewUrl", + "signature": [ + "(allSeries: Record, baseHref: string) => string" + ], + "description": [], + "children": [ + { + "id": "def-public.createExploratoryViewUrl.$1", + "type": "Object", + "label": "allSeries", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "lineNumber": 36 + } + }, + { + "id": "def-public.createExploratoryViewUrl.$2", + "type": "string", + "label": "baseHref", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "lineNumber": 36 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "lineNumber": 36 + }, + "initialIsOpen": false + }, { "id": "def-public.FieldValueSuggestions", "type": "Function", @@ -63,17 +114,12 @@ "description": [], "children": [ { + "id": "def-public.FieldValueSuggestions.$1", "type": "Object", "label": "props", "isRequired": true, "signature": [ - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.FieldValueSuggestionsProps", - "text": "FieldValueSuggestionsProps" - } + "FieldValueSuggestionsProps" ], "description": [], "source": { @@ -100,7 +146,7 @@ "description": [], "children": [ { - "id": "def-public.getApmTraceUrl.{\n- traceId,\n rangeFrom,\n rangeTo,\n}", + "id": "def-public.getApmTraceUrl.$1.traceIdrangeFromrangeTo", "type": "Object", "label": "{\n traceId,\n rangeFrom,\n rangeTo,\n}", "tags": [], @@ -108,7 +154,7 @@ "children": [ { "tags": [], - "id": "def-public.getApmTraceUrl.{\n- traceId,\n rangeFrom,\n rangeTo,\n}.traceId", + "id": "def-public.getApmTraceUrl.$1.traceIdrangeFromrangeTo.traceId", "type": "string", "label": "traceId", "description": [], @@ -119,7 +165,7 @@ }, { "tags": [], - "id": "def-public.getApmTraceUrl.{\n- traceId,\n rangeFrom,\n rangeTo,\n}.rangeFrom", + "id": "def-public.getApmTraceUrl.$1.traceIdrangeFromrangeTo.rangeFrom", "type": "string", "label": "rangeFrom", "description": [], @@ -130,7 +176,7 @@ }, { "tags": [], - "id": "def-public.getApmTraceUrl.{\n- traceId,\n rangeFrom,\n rangeTo,\n}.rangeTo", + "id": "def-public.getApmTraceUrl.$1.traceIdrangeFromrangeTo.rangeTo", "type": "string", "label": "rangeTo", "description": [], @@ -166,17 +212,12 @@ "description": [], "children": [ { + "id": "def-public.getCoreVitalsComponent.$1", "type": "Object", "label": "props", "isRequired": true, "signature": [ - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.CoreVitalProps", - "text": "CoreVitalProps" - } + "CoreVitalProps" ], "description": [], "source": { @@ -205,17 +246,12 @@ "description": [], "children": [ { + "id": "def-public.HeaderMenuPortal.$1", "type": "Object", "label": "props", "isRequired": true, "signature": [ - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.HeaderMenuPortalProps", - "text": "HeaderMenuPortalProps" - } + "HeaderMenuPortalProps" ], "description": [], "source": { @@ -260,6 +296,7 @@ "description": [], "children": [ { + "id": "def-public.SectionLink.$1", "type": "CompoundType", "label": "props", "isRequired": true, @@ -295,6 +332,7 @@ "description": [], "children": [ { + "id": "def-public.SectionLinks.$1", "type": "CompoundType", "label": "{ children, ...props }", "isRequired": true, @@ -347,7 +385,7 @@ "description": [], "children": [ { - "id": "def-public.SectionSubtitle.{-children }", + "id": "def-public.SectionSubtitle.$1.children", "type": "Object", "label": "{ children }", "tags": [], @@ -355,7 +393,7 @@ "children": [ { "tags": [], - "id": "def-public.SectionSubtitle.{-children }.children", + "id": "def-public.SectionSubtitle.$1.children.children", "type": "CompoundType", "label": "children", "description": [], @@ -392,7 +430,7 @@ "description": [], "children": [ { - "id": "def-public.SectionTitle.{-children }", + "id": "def-public.SectionTitle.$1.children", "type": "Object", "label": "{ children }", "tags": [], @@ -400,7 +438,7 @@ "children": [ { "tags": [], - "id": "def-public.SectionTitle.{-children }.children", + "id": "def-public.SectionTitle.$1.children.children", "type": "CompoundType", "label": "children", "description": [], @@ -465,6 +503,7 @@ "description": [], "children": [ { + "id": "def-public.useFetcher.$1", "type": "Function", "label": "fn", "isRequired": true, @@ -478,6 +517,7 @@ } }, { + "id": "def-public.useFetcher.$2", "type": "Array", "label": "fnDeps", "isRequired": true, @@ -491,7 +531,7 @@ } }, { - "id": "def-public.useFetcher.options", + "id": "def-public.useFetcher.$3.options", "type": "Object", "label": "options", "tags": [], @@ -499,7 +539,7 @@ "children": [ { "tags": [], - "id": "def-public.useFetcher.options.preservePreviousData", + "id": "def-public.useFetcher.$3.options.preservePreviousData", "type": "CompoundType", "label": "preservePreviousData", "description": [], @@ -568,6 +608,7 @@ "description": [], "children": [ { + "id": "def-public.useTrackMetric.$1", "type": "CompoundType", "label": "{ app, metric, metricType = METRIC_TYPE.COUNT, delay = 0 }", "isRequired": true, @@ -587,6 +628,7 @@ } }, { + "id": "def-public.useTrackMetric.$2", "type": "Array", "label": "effectDependencies", "isRequired": true, @@ -618,6 +660,7 @@ "description": [], "children": [ { + "id": "def-public.useTrackPageview.$1", "type": "CompoundType", "label": "{ path, ...rest }", "isRequired": true, @@ -631,6 +674,7 @@ } }, { + "id": "def-public.useTrackPageview.$2", "type": "Array", "label": "effectDependencies", "isRequired": true, @@ -657,7 +701,7 @@ "type": "Function", "label": "useUiTracker", "signature": [ - "({\n app: defaultApp,\n}: { app?: \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"uptime\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined; }) => ({ app, metric, metricType }: ", + "({\n app: defaultApp,\n}: { app?: \"uptime\" | \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined; }) => ({ app, metric, metricType }: ", { "pluginId": "observability", "scope": "public", @@ -670,7 +714,7 @@ "description": [], "children": [ { - "id": "def-public.useUiTracker.{\n- app: defaultApp,\n}", + "id": "def-public.useUiTracker.$1.appdefaultApp", "type": "Object", "label": "{\n app: defaultApp,\n}", "tags": [], @@ -678,7 +722,7 @@ "children": [ { "tags": [], - "id": "def-public.useUiTracker.{\n- app: defaultApp,\n}.app", + "id": "def-public.useUiTracker.$1.appdefaultApp.app", "type": "CompoundType", "label": "app", "description": [], @@ -687,7 +731,7 @@ "lineNumber": 40 }, "signature": [ - "\"apm\" | \"infra_metrics\" | \"infra_logs\" | \"uptime\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined" + "\"uptime\" | \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined" ] } ], @@ -739,7 +783,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 91 + "lineNumber": 111 }, "signature": [ "{ services: ", @@ -769,7 +813,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 95 + "lineNumber": 115 }, "signature": [ "{ transactions: ", @@ -786,7 +830,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 90 + "lineNumber": 110 }, "initialIsOpen": false }, @@ -805,27 +849,27 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 17 + "lineNumber": 16 } }, { "tags": [], "id": "def-public.Coordinates.y", - "type": "number", + "type": "CompoundType", "label": "y", "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 18 + "lineNumber": 17 }, "signature": [ - "number | undefined" + "number | null | undefined" ] } ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 16 + "lineNumber": 15 }, "initialIsOpen": false }, @@ -854,7 +898,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 57 + "lineNumber": 56 }, "signature": [ { @@ -883,7 +927,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 58 + "lineNumber": 57 }, "signature": [ { @@ -899,7 +943,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 54 + "lineNumber": 53 }, "initialIsOpen": false }, @@ -918,7 +962,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 26 + "lineNumber": 25 }, "signature": [ "{ start: number; end: number; }" @@ -932,7 +976,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 27 + "lineNumber": 26 }, "signature": [ "{ start: string; end: string; }" @@ -946,7 +990,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 28 + "lineNumber": 27 } }, { @@ -957,7 +1001,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 29 + "lineNumber": 28 }, "signature": [ "string | undefined" @@ -966,7 +1010,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 25 + "lineNumber": 24 }, "initialIsOpen": false }, @@ -985,13 +1029,13 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 62 + "lineNumber": 61 } } ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 61 + "lineNumber": 60 }, "initialIsOpen": false }, @@ -1010,7 +1054,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 33 + "lineNumber": 32 }, "signature": [ "{ start: number; end: number; }" @@ -1019,7 +1063,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 32 + "lineNumber": 31 }, "initialIsOpen": false }, @@ -1055,7 +1099,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 66 + "lineNumber": 65 }, "signature": [ "Record Promise<", { "pluginId": "observability", "scope": "public", "docId": "kibObservabilityPluginApi", - "section": "def-public.Stat", - "text": "Stat" - }, - "; cpu: ", - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.Stat", - "text": "Stat" + "section": "def-public.MetricsFetchDataResponse", + "text": "MetricsFetchDataResponse" }, - "; memory: ", + ">" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataResponse.series", + "type": "Array", + "label": "series", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 95 + }, + "signature": [ { "pluginId": "observability", "scope": "public", "docId": "kibObservabilityPluginApi", - "section": "def-public.Stat", - "text": "Stat" + "section": "def-public.MetricsFetchDataSeries", + "text": "MetricsFetchDataSeries" }, - "; }" + "[]" ] } ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 70 + "lineNumber": 93 + }, + "initialIsOpen": false + }, + { + "id": "def-public.MetricsFetchDataSeries", + "type": "Interface", + "label": "MetricsFetchDataSeries", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 73 + } + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.name", + "type": "CompoundType", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 74 + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.platform", + "type": "CompoundType", + "label": "platform", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 75 + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.provider", + "type": "CompoundType", + "label": "provider", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 76 + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.cpu", + "type": "CompoundType", + "label": "cpu", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 77 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.iowait", + "type": "CompoundType", + "label": "iowait", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 78 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.load", + "type": "CompoundType", + "label": "load", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 79 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.uptime", + "type": "CompoundType", + "label": "uptime", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 80 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.rx", + "type": "CompoundType", + "label": "rx", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 81 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.tx", + "type": "CompoundType", + "label": "tx", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 82 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-public.MetricsFetchDataSeries.timeseries", + "type": "Array", + "label": "timeseries", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 83 + }, + "signature": [ + "{ timestamp: number; cpu: number | null; iowait: number | null; load: number | null; rx: number | null; tx: number | null; }[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 72 }, "initialIsOpen": false }, @@ -1182,7 +1396,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 105 + "lineNumber": 125 }, "signature": [ { @@ -1202,7 +1416,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 106 + "lineNumber": 126 }, "signature": [ { @@ -1222,7 +1436,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 107 + "lineNumber": 127 }, "signature": [ { @@ -1242,7 +1456,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 108 + "lineNumber": 128 }, "signature": [ { @@ -1262,7 +1476,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 109 + "lineNumber": 129 }, "signature": [ { @@ -1277,7 +1491,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 104 + "lineNumber": 124 }, "initialIsOpen": false }, @@ -1296,7 +1510,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 113 + "lineNumber": 133 } }, { @@ -1307,7 +1521,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 114 + "lineNumber": 134 } }, { @@ -1318,7 +1532,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 115 + "lineNumber": 135 } }, { @@ -1329,7 +1543,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 116 + "lineNumber": 136 } }, { @@ -1340,7 +1554,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 117 + "lineNumber": 137 }, "signature": [ { @@ -1355,7 +1569,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 112 + "lineNumber": 132 }, "initialIsOpen": false }, @@ -1504,7 +1718,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 22 + "lineNumber": 21 }, "signature": [ { @@ -1520,7 +1734,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 21 + "lineNumber": 20 }, "initialIsOpen": false }, @@ -1539,7 +1753,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 12 + "lineNumber": 11 }, "signature": [ "\"number\" | \"percent\" | \"bytesPerSecond\"" @@ -1553,13 +1767,13 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 13 + "lineNumber": 12 } } ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 11 + "lineNumber": 10 }, "initialIsOpen": false }, @@ -1595,7 +1809,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 79 + "lineNumber": 99 }, "signature": [ "{ monitors: ", @@ -1633,7 +1847,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 84 + "lineNumber": 104 }, "signature": [ "{ up: ", @@ -1658,7 +1872,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 78 + "lineNumber": 98 }, "initialIsOpen": false }, @@ -1694,7 +1908,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 101 + "lineNumber": 121 }, "signature": [ { @@ -1709,7 +1923,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 100 + "lineNumber": 120 }, "initialIsOpen": false }, @@ -1728,7 +1942,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 37 + "lineNumber": 36 } }, { @@ -1739,7 +1953,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 38 + "lineNumber": 37 }, "signature": [ "string | number | undefined" @@ -1748,7 +1962,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 36 + "lineNumber": 35 }, "initialIsOpen": false }, @@ -1948,6 +2162,21 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-public.enableInspectEsQueries", + "type": "string", + "label": "enableInspectEsQueries", + "description": [], + "source": { + "path": "x-pack/plugins/observability/common/ui_settings_keys.ts", + "lineNumber": 9 + }, + "signature": [ + "\"observability:enableInspectEsQueries\"" + ], + "initialIsOpen": false + }, { "id": "def-public.FetchData", "type": "Type", @@ -1956,7 +2185,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 41 + "lineNumber": 40 }, "signature": [ "(fetchDataParams: ", @@ -1979,7 +2208,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 45 + "lineNumber": 44 }, "signature": [ "(params: ", @@ -2002,6 +2231,21 @@ ], "initialIsOpen": false }, + { + "id": "def-public.NumberOrNull", + "type": "Type", + "label": "NumberOrNull", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 70 + }, + "signature": [ + "null | number" + ], + "initialIsOpen": false + }, { "id": "def-public.ObservabilityFetchDataPlugins", "type": "Type", @@ -2010,10 +2254,10 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 49 + "lineNumber": 48 }, "signature": [ - "\"apm\" | \"infra_metrics\" | \"infra_logs\" | \"uptime\" | \"ux\"" + "\"uptime\" | \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"ux\"" ], "initialIsOpen": false }, @@ -2040,6 +2284,21 @@ ], "initialIsOpen": false }, + { + "id": "def-public.StringOrNull", + "type": "Type", + "label": "StringOrNull", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 69 + }, + "signature": [ + "null | string" + ], + "initialIsOpen": false + }, { "id": "def-public.TrackMetricOptions", "type": "Type", @@ -2099,13 +2358,7 @@ }, "signature": [ "{ register: typeof ", - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.registerDataHandler", - "text": "registerDataHandler" - }, + "registerDataHandler", "; }" ] } @@ -2177,6 +2430,7 @@ "description": [], "children": [ { + "id": "def-server.WrappedElasticsearchClientError.Unnamed.$1", "type": "Object", "label": "originalError", "isRequired": true, @@ -2234,7 +2488,7 @@ "description": [], "children": [ { - "id": "def-server.createOrUpdateIndex.{\n- index,\n mappings,\n client,\n logger,\n}", + "id": "def-server.createOrUpdateIndex.$1.indexmappingsclientlogger", "type": "Object", "label": "{\n index,\n mappings,\n client,\n logger,\n}", "tags": [], @@ -2242,7 +2496,7 @@ "children": [ { "tags": [], - "id": "def-server.createOrUpdateIndex.{\n- index,\n mappings,\n client,\n logger,\n}.index", + "id": "def-server.createOrUpdateIndex.$1.indexmappingsclientlogger.index", "type": "string", "label": "index", "description": [], @@ -2253,7 +2507,7 @@ }, { "tags": [], - "id": "def-server.createOrUpdateIndex.{\n- index,\n mappings,\n client,\n logger,\n}.mappings", + "id": "def-server.createOrUpdateIndex.$1.indexmappingsclientlogger.mappings", "type": "CompoundType", "label": "mappings", "description": [], @@ -2273,7 +2527,7 @@ }, { "tags": [], - "id": "def-server.createOrUpdateIndex.{\n- index,\n mappings,\n client,\n logger,\n}.client", + "id": "def-server.createOrUpdateIndex.$1.indexmappingsclientlogger.client", "type": "CompoundType", "label": "client", "description": [], @@ -2293,7 +2547,7 @@ }, { "tags": [], - "id": "def-server.createOrUpdateIndex.{\n- index,\n mappings,\n client,\n logger,\n}.logger", + "id": "def-server.createOrUpdateIndex.$1.indexmappingsclientlogger.logger", "type": "Object", "label": "logger", "description": [], @@ -2332,6 +2586,7 @@ "description": [], "children": [ { + "id": "def-server.unwrapEsResponse.$1", "type": "Uncategorized", "label": "responsePromise", "isRequired": true, @@ -2420,30 +2675,32 @@ "objects": [], "setup": { "id": "def-server.ObservabilityPluginSetup", - "type": "Interface", + "type": "Type", "label": "ObservabilityPluginSetup", - "description": [], "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.ObservabilityPluginSetup.getScopedAnnotationsClient", - "type": "Function", - "label": "getScopedAnnotationsClient", - "description": [], - "source": { - "path": "x-pack/plugins/observability/server/plugin.ts", - "lineNumber": 23 - }, - "signature": [ - "LazyScopedAnnotationsClientFactory" - ] - } - ], + "description": [], "source": { "path": "x-pack/plugins/observability/server/plugin.ts", - "lineNumber": 22 + "lineNumber": 20 }, + "signature": [ + "{ getScopedAnnotationsClient: (requestContext: ", + "ObservabilityRequestHandlerContext", + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "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" + ], "lifecycle": "setup", "initialIsOpen": true } diff --git a/api_docs/presentation_util.json b/api_docs/presentation_util.json index 55204d129800..351fd76adf70 100644 --- a/api_docs/presentation_util.json +++ b/api_docs/presentation_util.json @@ -4,87 +4,119 @@ "classes": [], "functions": [ { - "id": "def-public.DashboardPicker", + "tags": [], + "id": "def-public.LazyDashboardPicker", "type": "Function", - "label": "DashboardPicker", - "signature": [ - "(props: ", - "DashboardPickerProps", - ") => JSX.Element" - ], + "label": "LazyDashboardPicker", "description": [], - "children": [ - { - "type": "Object", - "label": "props", - "isRequired": true, - "signature": [ - { - "pluginId": "presentationUtil", - "scope": "public", - "docId": "kibPresentationUtilPluginApi", - "section": "def-public.DashboardPickerProps", - "text": "DashboardPickerProps" - } - ], - "description": [], - "source": { - "path": "src/plugins/presentation_util/public/components/dashboard_picker.tsx", - "lineNumber": 27 - } - } + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 34 + }, + "signature": [ + "React.LazyExoticComponent" ], + "initialIsOpen": false + }, + { "tags": [], - "returnComment": [], + "id": "def-public.LazyLabsBeakerButton", + "type": "Function", + "label": "LazyLabsBeakerButton", + "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/dashboard_picker.tsx", - "lineNumber": 27 + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 28 }, + "signature": [ + "(props: ", + "Props", + ") => JSX.Element" + ], "initialIsOpen": false }, { - "id": "def-public.SavedObjectSaveModalDashboard", + "tags": [], + "id": "def-public.LazyLabsFlyout", "type": "Function", - "label": "SavedObjectSaveModalDashboard", + "label": "LazyLabsFlyout", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 32 + }, "signature": [ "(props: ", - { - "pluginId": "presentationUtil", - "scope": "public", - "docId": "kibPresentationUtilPluginApi", - "section": "def-public.SaveModalDashboardProps", - "text": "SaveModalDashboardProps" - }, + "Props", ") => JSX.Element" ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.LazySavedObjectSaveModalDashboard", + "type": "Function", + "label": "LazySavedObjectSaveModalDashboard", "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 36 + }, + "signature": [ + "React.LazyExoticComponent" + ], + "initialIsOpen": false + }, + { + "id": "def-public.withSuspense", + "type": "Function", "children": [ { - "type": "Object", - "label": "props", + "id": "def-public.withSuspense.$1", + "type": "CompoundType", + "label": "Component", "isRequired": true, "signature": [ - { - "pluginId": "presentationUtil", - "scope": "public", - "docId": "kibPresentationUtilPluginApi", - "section": "def-public.SaveModalDashboardProps", - "text": "SaveModalDashboardProps" - } + "React.ComponentType

" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 18 + } + }, + { + "id": "def-public.withSuspense.$2", + "type": "CompoundType", + "label": "fallback", + "isRequired": false, + "signature": [ + "React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null" ], "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 37 + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 19 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "

(Component: React.ComponentType

, fallback?: React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null) => (props: P) => JSX.Element" + ], + "description": [ + "\nA HOC which supplies React.Suspense with a fallback component, and a `EuiErrorBoundary` to contain errors." + ], + "label": "withSuspense", "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 37 + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 17 }, + "tags": [], + "returnComment": [], "initialIsOpen": false } ], @@ -103,13 +135,24 @@ "label": "documentInfo", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 30 + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 18 }, "signature": [ "SaveModalDocumentInfo" ] }, + { + "tags": [], + "id": "def-public.SaveModalDashboardProps.canSaveByReference", + "type": "boolean", + "label": "canSaveByReference", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 19 + } + }, { "tags": [], "id": "def-public.SaveModalDashboardProps.objectType", @@ -117,8 +160,8 @@ "label": "objectType", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 31 + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 20 } }, { @@ -128,8 +171,8 @@ "label": "onClose", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 32 + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 21 }, "signature": [ "() => void" @@ -142,8 +185,8 @@ "label": "onSave", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 33 + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 22 }, "signature": [ "(props: ", @@ -164,8 +207,8 @@ "label": "tagOptions", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 34 + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 23 }, "signature": [ "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | ((state: ", @@ -181,15 +224,62 @@ } ], "source": { - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx", - "lineNumber": 29 + "path": "src/plugins/presentation_util/public/components/types.ts", + "lineNumber": 17 }, "initialIsOpen": false } ], "enums": [], - "misc": [], - "objects": [], + "misc": [ + { + "id": "def-public.Project", + "type": "Type", + "label": "Project", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 59 + }, + "signature": [ + "ProjectConfig & { status: ProjectStatus; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ProjectID", + "type": "Type", + "label": "ProjectID", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 36 + }, + "signature": [ + "\"labs:presentation:unifiedToolbar\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-public.projectIDs", + "type": "Object", + "label": "projectIDs", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 13 + }, + "signature": [ + "readonly [\"labs:presentation:unifiedToolbar\"]" + ], + "initialIsOpen": false + } + ], "setup": { "id": "def-public.PresentationUtilPluginSetup", "type": "Interface", @@ -199,7 +289,7 @@ "children": [], "source": { "path": "src/plugins/presentation_util/public/types.ts", - "lineNumber": 10 + "lineNumber": 12 }, "lifecycle": "setup", "initialIsOpen": true @@ -219,16 +309,30 @@ "description": [], "source": { "path": "src/plugins/presentation_util/public/types.ts", - "lineNumber": 13 + "lineNumber": 15 }, "signature": [ "React.FC<{}>" ] + }, + { + "tags": [], + "id": "def-public.PresentationUtilPluginStart.labsService", + "type": "Object", + "label": "labsService", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/types.ts", + "lineNumber": 16 + }, + "signature": [ + "PresentationLabsService" + ] } ], "source": { "path": "src/plugins/presentation_util/public/types.ts", - "lineNumber": 12 + "lineNumber": 14 }, "lifecycle": "start", "initialIsOpen": true @@ -244,10 +348,467 @@ }, "common": { "classes": [], - "functions": [], - "interfaces": [], + "functions": [ + { + "id": "def-common.getProjectIDs", + "type": "Function", + "children": [], + "signature": [ + "() => readonly [\"labs:presentation:unifiedToolbar\"]" + ], + "description": [], + "label": "getProjectIDs", + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 61 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isProjectEnabledByStatus", + "type": "Function", + "children": [ + { + "id": "def-common.isProjectEnabledByStatus.$1", + "type": "boolean", + "label": "active", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 63 + } + }, + { + "id": "def-common.isProjectEnabledByStatus.$2", + "type": "Object", + "label": "status", + "isRequired": true, + "signature": [ + { + "pluginId": "presentationUtil", + "scope": "common", + "docId": "kibPresentationUtilPluginApi", + "section": "def-common.EnvironmentStatus", + "text": "EnvironmentStatus" + } + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 63 + } + } + ], + "signature": [ + "(active: boolean, status: ", + { + "pluginId": "presentationUtil", + "scope": "common", + "docId": "kibPresentationUtilPluginApi", + "section": "def-common.EnvironmentStatus", + "text": "EnvironmentStatus" + }, + ") => boolean" + ], + "description": [], + "label": "isProjectEnabledByStatus", + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 63 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.ProjectConfig", + "type": "Interface", + "label": "ProjectConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ProjectConfig.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 51 + }, + "signature": [ + "\"labs:presentation:unifiedToolbar\"" + ] + }, + { + "tags": [], + "id": "def-common.ProjectConfig.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 52 + } + }, + { + "tags": [], + "id": "def-common.ProjectConfig.isActive", + "type": "boolean", + "label": "isActive", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 53 + } + }, + { + "tags": [], + "id": "def-common.ProjectConfig.environments", + "type": "Array", + "label": "environments", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 54 + }, + "signature": [ + "(\"kibana\" | \"browser\" | \"session\")[]" + ] + }, + { + "tags": [], + "id": "def-common.ProjectConfig.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 55 + } + }, + { + "tags": [], + "id": "def-common.ProjectConfig.solutions", + "type": "Array", + "label": "solutions", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 56 + }, + "signature": [ + "(\"dashboard\" | \"canvas\" | \"presentation\")[]" + ] + } + ], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 50 + }, + "initialIsOpen": false + } + ], "enums": [], - "misc": [], - "objects": [] + "misc": [ + { + "id": "def-common.EnvironmentName", + "type": "Type", + "label": "EnvironmentName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 37 + }, + "signature": [ + "\"kibana\" | \"browser\" | \"session\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EnvironmentStatus", + "type": "Type", + "label": "EnvironmentStatus", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 40 + }, + "signature": [ + "{ kibana?: boolean | undefined; browser?: boolean | undefined; session?: boolean | undefined; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PLUGIN_ID", + "type": "string", + "label": "PLUGIN_ID", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/index.ts", + "lineNumber": 9 + }, + "signature": [ + "\"presentationUtil\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PLUGIN_NAME", + "type": "string", + "label": "PLUGIN_NAME", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/index.ts", + "lineNumber": 10 + }, + "signature": [ + "\"presentationUtil\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Project", + "type": "Type", + "label": "Project", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 59 + }, + "signature": [ + "ProjectConfig & { status: ProjectStatus; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ProjectID", + "type": "Type", + "label": "ProjectID", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 36 + }, + "signature": [ + "\"labs:presentation:unifiedToolbar\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ProjectStatus", + "type": "Type", + "label": "ProjectStatus", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 44 + }, + "signature": [ + "{ defaultValue: boolean; isEnabled: boolean; isOverride: boolean; } & EnvironmentStatus" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SolutionName", + "type": "Type", + "label": "SolutionName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 38 + }, + "signature": [ + "\"dashboard\" | \"canvas\" | \"presentation\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.UNIFIED_TOOLBAR", + "type": "string", + "label": "UNIFIED_TOOLBAR", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 11 + }, + "signature": [ + "\"labs:presentation:unifiedToolbar\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.environmentNames", + "type": "Object", + "label": "environmentNames", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 14 + }, + "signature": [ + "readonly [\"kibana\", \"browser\", \"session\"]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.projectIDs", + "type": "Object", + "label": "projectIDs", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 13 + }, + "signature": [ + "readonly [\"labs:presentation:unifiedToolbar\"]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.projects", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.projects.UNIFIED_TOOLBAR", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.projects.UNIFIED_TOOLBAR.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 23 + }, + "signature": [ + "\"labs:presentation:unifiedToolbar\"" + ] + }, + { + "tags": [], + "id": "def-common.projects.UNIFIED_TOOLBAR.isActive", + "type": "boolean", + "label": "isActive", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 24 + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.projects.UNIFIED_TOOLBAR.environments", + "type": "Array", + "label": "environments", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 25 + }, + "signature": [ + "(\"kibana\" | \"browser\" | \"session\")[]" + ] + }, + { + "tags": [], + "id": "def-common.projects.UNIFIED_TOOLBAR.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 26 + } + }, + { + "tags": [], + "id": "def-common.projects.UNIFIED_TOOLBAR.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 29 + } + }, + { + "tags": [], + "id": "def-common.projects.UNIFIED_TOOLBAR.solutions", + "type": "Array", + "label": "solutions", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 32 + }, + "signature": [ + "(\"dashboard\" | \"canvas\")[]" + ] + } + ], + "description": [], + "label": "[UNIFIED_TOOLBAR]", + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 22 + } + } + ], + "description": [ + "\nThis is a list of active Labs Projects for the Presentation Team. It is the \"source of truth\" for all projects\nprovided to users of our solutions in Kibana." + ], + "label": "projects", + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 21 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.solutionNames", + "type": "Object", + "label": "solutionNames", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 15 + }, + "signature": [ + "readonly [\"canvas\", \"dashboard\", \"presentation\"]" + ], + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 47088db34b9e..4cb96b938bfa 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -19,9 +19,29 @@ import presentationUtilObj from './presentation_util.json'; ### Start +### Objects + + ### Functions ### Interfaces +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/reporting.json b/api_docs/reporting.json index be0c96386603..1afa9f51a160 100644 --- a/api_docs/reporting.json +++ b/api_docs/reporting.json @@ -19,6 +19,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingAPIClient.Unnamed.$1", "type": "Object", "label": "http", "isRequired": true, @@ -55,6 +56,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingAPIClient.getReportURL.$1", "type": "string", "label": "jobId", "isRequired": true, @@ -85,6 +87,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingAPIClient.downloadReport.$1", "type": "string", "label": "jobId", "isRequired": true, @@ -115,6 +118,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingAPIClient.deleteReport.$1", "type": "string", "label": "jobId", "isRequired": true, @@ -140,6 +144,7 @@ "type": "Function", "children": [ { + "id": "def-public.ReportingAPIClient.list.$1", "type": "number", "label": "page", "isRequired": true, @@ -153,6 +158,7 @@ } }, { + "id": "def-public.ReportingAPIClient.list.$2", "type": "Array", "label": "jobIds", "isRequired": true, @@ -168,13 +174,7 @@ ], "signature": [ "(page?: number, jobIds?: string[]) => Promise<", - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.JobQueueEntry", - "text": "JobQueueEntry" - }, + "JobQueueEntry", "[]>" ], "description": [], @@ -208,18 +208,13 @@ "label": "getContent", "signature": [ "(jobId: string) => Promise<", - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.JobContent", - "text": "JobContent" - }, + "JobContent", ">" ], "description": [], "children": [ { + "id": "def-public.ReportingAPIClient.getContent.$1", "type": "string", "label": "jobId", "isRequired": true, @@ -246,18 +241,13 @@ "label": "getInfo", "signature": [ "(jobId: string) => Promise<", - { - "pluginId": "reporting", - "scope": "common", - "docId": "kibReportingPluginApi", - "section": "def-common.ReportApiJSON", - "text": "ReportApiJSON" - }, + "ReportApiJSON", ">" ], "description": [], "children": [ { + "id": "def-public.ReportingAPIClient.getInfo.$1", "type": "string", "label": "jobId", "isRequired": true, @@ -283,6 +273,7 @@ "type": "Function", "children": [ { + "id": "def-public.ReportingAPIClient.findForJobIds.$1", "type": "Array", "label": "jobIds", "isRequired": true, @@ -298,13 +289,7 @@ ], "signature": [ "(jobIds: string[]) => Promise<", - { - "pluginId": "reporting", - "scope": "common", - "docId": "kibReportingPluginApi", - "section": "def-common.ReportDocument", - "text": "ReportDocument" - }, + "ReportDocument", "[]>" ], "description": [], @@ -321,6 +306,7 @@ "type": "Function", "children": [ { + "id": "def-public.ReportingAPIClient.getReportingJobPath.$1", "type": "string", "label": "exportType", "isRequired": true, @@ -334,6 +320,7 @@ } }, { + "id": "def-public.ReportingAPIClient.getReportingJobPath.$2", "type": "Object", "label": "jobParams", "isRequired": true, @@ -364,6 +351,7 @@ "type": "Function", "children": [ { + "id": "def-public.ReportingAPIClient.createReportingJob.$1", "type": "string", "label": "exportType", "isRequired": true, @@ -377,6 +365,7 @@ } }, { + "id": "def-public.ReportingAPIClient.createReportingJob.$2", "type": "Any", "label": "jobParams", "isRequired": true, @@ -423,6 +412,7 @@ "type": "Function", "children": [ { + "id": "def-public.ReportingAPIClient.getDownloadLink.$1", "type": "string", "label": "jobId", "isRequired": true, @@ -470,13 +460,7 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.DiagnoseResponse", - "text": "DiagnoseResponse" - }, + "DiagnoseResponse", ">" ], "description": [], @@ -494,13 +478,7 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.DiagnoseResponse", - "text": "DiagnoseResponse" - }, + "DiagnoseResponse", ">" ], "description": [], @@ -518,13 +496,7 @@ "children": [], "signature": [ "() => Promise<", - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.DiagnoseResponse", - "text": "DiagnoseResponse" - }, + "DiagnoseResponse", ">" ], "description": [], @@ -595,6 +567,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -636,13 +609,7 @@ "text": "CoreSetup" }, ", { home, management, licensing, uiActions, share }: ", - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.ReportingPublicPluginSetupDendencies", - "text": "ReportingPublicPluginSetupDendencies" - }, + "ReportingPublicPluginSetupDendencies", ") => ", { "pluginId": "reporting", @@ -655,6 +622,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -675,17 +643,12 @@ } }, { + "id": "def-public.ReportingPublicPlugin.setup.$2", "type": "Object", "label": "{ home, management, licensing, uiActions, share }", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "public", - "docId": "kibReportingPluginApi", - "section": "def-public.ReportingPublicPluginSetupDendencies", - "text": "ReportingPublicPluginSetupDendencies" - } + "ReportingPublicPluginSetupDendencies" ], "description": [], "source": { @@ -726,6 +689,7 @@ "description": [], "children": [ { + "id": "def-public.ReportingPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -836,17 +800,12 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.Unnamed.$1", "type": "Object", "label": "logger", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - } + "LevelLogger" ], "description": [], "source": { @@ -855,6 +814,7 @@ } }, { + "id": "def-server.ReportingCore.Unnamed.$2", "type": "Object", "label": "context", "isRequired": true, @@ -866,9 +826,9 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", - "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" + "; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "description": [], "source": { @@ -890,29 +850,18 @@ "label": "pluginSetup", "signature": [ "(setupDeps: ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingInternalSetup", - "text": "ReportingInternalSetup" - }, + "ReportingInternalSetup", ") => void" ], "description": [], "children": [ { + "id": "def-server.ReportingCore.pluginSetup.$1", "type": "Object", "label": "setupDeps", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingInternalSetup", - "text": "ReportingInternalSetup" - } + "ReportingInternalSetup" ], "description": [], "source": { @@ -934,29 +883,18 @@ "label": "pluginStart", "signature": [ "(startDeps: ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingInternalStart", - "text": "ReportingInternalStart" - }, + "ReportingInternalStart", ") => Promise" ], "description": [], "children": [ { + "id": "def-server.ReportingCore.pluginStart.$1", "type": "Object", "label": "startDeps", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingInternalStart", - "text": "ReportingInternalStart" - } + "ReportingInternalStart" ], "description": [], "source": { @@ -1038,6 +976,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.setConfig.$1", "type": "Object", "label": "config", "isRequired": true, @@ -1111,13 +1050,7 @@ "label": "getPluginStartDeps", "signature": [ "() => Promise<", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingInternalStart", - "text": "ReportingInternalStart" - }, + "ReportingInternalStart", ">" ], "description": [], @@ -1135,13 +1068,7 @@ "label": "getExportTypesRegistry", "signature": [ "() => ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ExportTypesRegistry", - "text": "ExportTypesRegistry" - } + "ExportTypesRegistry" ], "description": [], "children": [], @@ -1158,21 +1085,9 @@ "label": "scheduleTask", "signature": [ "(report: ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportTaskParams", - "text": "ReportTaskParams" - }, + "ReportTaskParams", "<", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.BasePayload", - "text": "BasePayload" - }, + "BasePayload", ">) => Promise<", { "pluginId": "taskManager", @@ -1186,25 +1101,14 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.scheduleTask.$1", "type": "Object", "label": "report", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportTaskParams", - "text": "ReportTaskParams" - }, + "ReportTaskParams", "<", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.BasePayload", - "text": "BasePayload" - }, + "BasePayload", ">" ], "description": [], @@ -1227,13 +1131,7 @@ "label": "getStore", "signature": [ "() => Promise<", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingStore", - "text": "ReportingStore" - }, + "ReportingStore", ">" ], "description": [], @@ -1251,13 +1149,7 @@ "label": "getLicenseInfo", "signature": [ "() => Promise>" ], "description": [], @@ -1275,13 +1167,7 @@ "label": "getScreenshotsObservable", "signature": [ "() => Promise<", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ScreenshotsObservableFn", - "text": "ScreenshotsObservableFn" - }, + "ScreenshotsObservableFn", ">" ], "description": [], @@ -1299,13 +1185,7 @@ "label": "getPluginSetupDeps", "signature": [ "() => ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.ReportingInternalSetup", - "text": "ReportingInternalSetup" - } + "ReportingInternalSetup" ], "description": [], "children": [], @@ -1352,7 +1232,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">) => Promise<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise<", { "pluginId": "core", "scope": "server", @@ -1365,6 +1245,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.getUiSettingsServiceFactory.$1", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -1377,7 +1258,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "description": [], "source": { @@ -1407,18 +1288,13 @@ "text": "KibanaRequest" }, ", logger?: ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - }, + "LevelLogger", ") => string | undefined" ], "description": [], "children": [ { + "id": "def-server.ReportingCore.getSpaceId.$1", "type": "Object", "label": "request", "isRequired": true, @@ -1439,17 +1315,12 @@ } }, { + "id": "def-server.ReportingCore.getSpaceId.$2", "type": "Object", "label": "logger", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - } + "LevelLogger" ], "description": [], "source": { @@ -1471,13 +1342,7 @@ "label": "getFakeRequest", "signature": [ "(baseRequest: object, spaceId: string | undefined, logger?: ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - }, + "LevelLogger", ") => ", { "pluginId": "core", @@ -1491,6 +1356,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.getFakeRequest.$1", "type": "Uncategorized", "label": "baseRequest", "isRequired": true, @@ -1504,6 +1370,7 @@ } }, { + "id": "def-server.ReportingCore.getFakeRequest.$2", "type": "string", "label": "spaceId", "isRequired": false, @@ -1517,17 +1384,12 @@ } }, { + "id": "def-server.ReportingCore.getFakeRequest.$3", "type": "Object", "label": "logger", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - } + "LevelLogger" ], "description": [], "source": { @@ -1557,13 +1419,7 @@ "text": "KibanaRequest" }, ", logger?: ", - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - }, + "LevelLogger", ") => Promise<", { "pluginId": "core", @@ -1577,6 +1433,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.getUiSettingsClient.$1", "type": "Object", "label": "request", "isRequired": true, @@ -1597,17 +1454,12 @@ } }, { + "id": "def-server.ReportingCore.getUiSettingsClient.$2", "type": "Object", "label": "logger", "isRequired": true, "signature": [ - { - "pluginId": "reporting", - "scope": "server", - "docId": "kibReportingPluginApi", - "section": "def-server.LevelLogger", - "text": "LevelLogger" - } + "LevelLogger" ], "description": [], "source": { @@ -1681,6 +1533,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.trackReport.$1", "type": "string", "label": "reportId", "isRequired": true, @@ -1711,6 +1564,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingCore.untrackReport.$1", "type": "string", "label": "reportId", "isRequired": true, @@ -1805,6 +1659,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingPlugin.Unnamed.$1", "type": "Object", "label": "context", "isRequired": true, @@ -1816,9 +1671,9 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", - "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" + "; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "description": [], "source": { @@ -1860,6 +1715,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1880,6 +1736,7 @@ } }, { + "id": "def-server.ReportingPlugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, @@ -1932,6 +1789,7 @@ "description": [], "children": [ { + "id": "def-server.ReportingPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1951,6 +1809,7 @@ } }, { + "id": "def-server.ReportingPlugin.start.$2", "type": "Object", "label": "plugins", "isRequired": true, @@ -1999,9 +1858,9 @@ "section": "def-server.ReportingConfig", "text": "ReportingConfig" }, - " extends Config; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + " extends Config; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", - "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" + "; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "description": [], "tags": [], @@ -2148,13 +2007,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorSet", - "text": "CollectorSet" - }, + "CollectorSet", ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" ] } @@ -2254,6 +2107,7 @@ "type": "Function", "children": [ { + "id": "def-common.CancellationToken.on.$1", "type": "Object", "label": "callback", "isRequired": true, @@ -2335,6 +2189,7 @@ "description": [], "children": [ { + "id": "def-common.Poller.Unnamed.$1", "type": "Object", "label": "options", "isRequired": true, diff --git a/api_docs/rule_registry.json b/api_docs/rule_registry.json new file mode 100644 index 000000000000..dfa6643c57ba --- /dev/null +++ b/api_docs/rule_registry.json @@ -0,0 +1,400 @@ +{ + "id": "ruleRegistry", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.createLifecycleRuleTypeFactory", + "type": "Function", + "label": "createLifecycleRuleTypeFactory", + "signature": [ + "() => TRuleRegistry extends ", + "RuleRegistry", + " ? CreateLifecycleRuleType : never" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/rule_type_helpers/create_lifecycle_rule_type_factory.ts", + "lineNumber": 54 + }, + "initialIsOpen": false + }, + { + "id": "def-server.createLifecycleRuleTypeFactory", + "type": "Function", + "label": "createLifecycleRuleTypeFactory", + "signature": [ + "() => CreateLifecycleRuleType<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/rule_type_helpers/create_lifecycle_rule_type_factory.ts", + "lineNumber": 60 + }, + "initialIsOpen": false + }, + { + "id": "def-server.pickWithPatterns", + "type": "Function", + "label": "pickWithPatterns", + "signature": [ + "(map: T, patterns: TPatterns) => Pick<{ [TFieldName in keyof T]: ", + "SetIntersection", + "<", + "ValuesType", + ", PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }, { [Key in keyof { [TFieldName in keyof T]: ", + "SetIntersection", + "<", + "ValuesType", + ", PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }]-?: [{ [TFieldName in keyof T]: ", + "SetIntersection" + ], + "description": [], + "children": [ + { + "id": "def-server.pickWithPatterns.$1", + "type": "Uncategorized", + "label": "map", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts", + "lineNumber": 42 + } + }, + { + "id": "def-server.pickWithPatterns.$2", + "type": "Uncategorized", + "label": "patterns", + "isRequired": true, + "signature": [ + "TPatterns" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts", + "lineNumber": 42 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts", + "lineNumber": 39 + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.ScopedRuleRegistryClient", + "type": "Interface", + "label": "ScopedRuleRegistryClient", + "signature": [ + { + "pluginId": "ruleRegistry", + "scope": "server", + "docId": "kibRuleRegistryPluginApi", + "section": "def-server.ScopedRuleRegistryClient", + "text": "ScopedRuleRegistryClient" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.ScopedRuleRegistryClient.search", + "type": "Function", + "label": "search", + "signature": [ + ">(request: TSearchRequest) => Promise<{ body: ", + "InferSearchResponseOf", + "; events: ", + "EventsOf", + "; }>" + ], + "description": [], + "children": [ + { + "id": "def-server.ScopedRuleRegistryClient.search.$1", + "type": "Uncategorized", + "label": "request", + "isRequired": true, + "signature": [ + "TSearchRequest" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 42 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 41 + } + }, + { + "id": "def-server.ScopedRuleRegistryClient.index", + "type": "Function", + "label": "index", + "signature": [ + "(doc: Pick<", + "Mutable", + "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", + "OutputOf", + "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", + "OutputOf", + "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", + "PrepopulatedRuleEventFields" + ], + "description": [], + "children": [ + { + "id": "def-server.ScopedRuleRegistryClient.index.$1", + "type": "Object", + "label": "doc", + "isRequired": true, + "signature": [ + "Pick<", + "Mutable", + "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", + "OutputOf", + "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", + "OutputOf", + "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", + "PrepopulatedRuleEventFields" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 47 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 47 + } + }, + { + "id": "def-server.ScopedRuleRegistryClient.bulkIndex", + "type": "Function", + "label": "bulkIndex", + "signature": [ + "(doc: Pick<", + "Mutable", + "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", + "OutputOf", + "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", + "OutputOf", + "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", + "PrepopulatedRuleEventFields" + ], + "description": [], + "children": [ + { + "id": "def-server.ScopedRuleRegistryClient.bulkIndex.$1", + "type": "Array", + "label": "doc", + "isRequired": true, + "signature": [ + "Pick<", + "Mutable", + "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", + "OutputOf", + "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", + "OutputOf", + "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", + "PrepopulatedRuleEventFields" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 49 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 48 + } + } + ], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 40 + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.FieldMapOf", + "type": "Type", + "label": "FieldMapOf", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/types.ts", + "lineNumber": 98 + }, + "signature": [ + "TRuleRegistry extends RuleRegistry ? TFieldMap : never" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RuleRegistryConfig", + "type": "Type", + "label": "RuleRegistryConfig", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/index.ts", + "lineNumber": 26 + }, + "signature": [ + "{ readonly enabled: boolean; readonly writeEnabled: boolean; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-server.ecsFieldMap", + "type": "Object", + "label": "ecsFieldMap", + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/generated/ecs_field_map.ts", + "lineNumber": 8 + }, + "signature": [ + "{ readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'agent.build.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'client.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'cloud.account.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.account.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.availability_zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.machine.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.region': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.tag': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'container.labels': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'container.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.runtime': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dll.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers': { readonly type: \"object\"; readonly array: true; readonly required: false; }; readonly 'dns.answers.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.data': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.ttl': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.header_flags': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dns.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.op_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.resolved_ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'dns.response_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'ecs.version': { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly 'error.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.message': { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'error.stack_trace': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.dataset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.duration': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.end': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.ingested': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.module': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.outcome': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reason': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score_norm': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.sequence': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.severity': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.timezone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.type': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.url': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.accessed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.attributes': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.ctime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.device': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.drive_letter': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.gid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.group': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.inode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mtime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.owner': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.target_path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.uid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'host.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'host.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'host.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'http.request.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.method': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.referrer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.status_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly labels: { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.level': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.logger': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.line': { readonly type: \"integer\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.function': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.priority': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly message: { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'network.application': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.community_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.direction': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.forwarded_ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'network.iana_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.transport': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'observer.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'observer.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.build_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.checksum': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.install_scope': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.installed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'package.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'package.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.parent.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.bytes': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.strings': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'registry.data.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.hive': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.key': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.value': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'related.hash': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.hosts': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'related.user': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.author': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.ruleset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'server.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'service.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.node.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.state': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'source.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'span.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.framework': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'threat.tactic.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.cipher': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.ja3': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.server_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.supported_ciphers': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.established': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.next_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.resumed': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.ja3s': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'trace.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'transaction.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.fragment': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.password': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'url.query': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.scheme': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.username': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.target.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user_agent.device.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'vulnerability.classification': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.enumeration': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.report_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.scanner.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.base': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.environmental': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.temporal': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.severity': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }" + ], + "initialIsOpen": false + } + ], + "setup": { + "id": "def-server.RuleRegistryPluginSetupContract", + "type": "Type", + "label": "RuleRegistryPluginSetupContract", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/plugin.ts", + "lineNumber": 15 + }, + "signature": [ + "RuleRegistry<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }>" + ], + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.getAlertSeverityLevelValue", + "type": "Function", + "label": "getAlertSeverityLevelValue", + "signature": [ + "(level: ", + { + "pluginId": "ruleRegistry", + "scope": "common", + "docId": "kibRuleRegistryPluginApi", + "section": "def-common.AlertSeverityLevel", + "text": "AlertSeverityLevel" + }, + ") => number" + ], + "description": [], + "children": [ + { + "id": "def-common.getAlertSeverityLevelValue.$1", + "type": "Enum", + "label": "level", + "isRequired": true, + "signature": [ + { + "pluginId": "ruleRegistry", + "scope": "common", + "docId": "kibRuleRegistryPluginApi", + "section": "def-common.AlertSeverityLevel", + "text": "AlertSeverityLevel" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/types.ts", + "lineNumber": 18 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/types.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [ + { + "id": "def-common.AlertSeverityLevel", + "type": "Enum", + "label": "AlertSeverityLevel", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/types.ts", + "lineNumber": 8 + }, + "initialIsOpen": false + } + ], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx new file mode 100644 index 000000000000..0fdaed425ed6 --- /dev/null +++ b/api_docs/rule_registry.mdx @@ -0,0 +1,38 @@ +--- +id: kibRuleRegistryPluginApi +slug: /kibana-dev-docs/ruleRegistryPluginApi +title: ruleRegistry +image: https://source.unsplash.com/400x175/?github +summary: API docs for the ruleRegistry plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import ruleRegistryObj from './rule_registry.json'; + +## Server + +### Setup + + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Functions + + +### Enums + + diff --git a/api_docs/runtime_fields.json b/api_docs/runtime_fields.json index 3c5fac48f70d..22975ac7e377 100644 --- a/api_docs/runtime_fields.json +++ b/api_docs/runtime_fields.json @@ -8,6 +8,7 @@ "type": "Function", "children": [ { + "id": "def-public.RuntimeFieldEditor.$1", "type": "Object", "label": "{ defaultValue, onChange, docLinks, ctx }", "isRequired": true, @@ -53,6 +54,7 @@ "type": "Function", "children": [ { + "id": "def-public.RuntimeFieldEditorFlyoutContent.$1", "type": "Object", "label": "{\n onSave,\n onCancel,\n docLinks,\n defaultValue: field,\n ctx,\n}", "isRequired": true, @@ -373,13 +375,7 @@ "label": "loadEditor", "signature": [ "() => Promise<", - { - "pluginId": "runtimeFields", - "scope": "public", - "docId": "kibRuntimeFieldsPluginApi", - "section": "def-public.LoadEditorResponse", - "text": "LoadEditorResponse" - }, + "LoadEditorResponse", ">" ], "description": [], diff --git a/api_docs/saved_objects.json b/api_docs/saved_objects.json index 0842bd216383..a27a14430d0e 100644 --- a/api_docs/saved_objects.json +++ b/api_docs/saved_objects.json @@ -136,17 +136,12 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectFinderUi.Unnamed.$1", "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ - { - "pluginId": "savedObjects", - "scope": "public", - "docId": "kibSavedObjectsPluginApi", - "section": "def-public.SavedObjectFinderUiProps", - "text": "SavedObjectFinderUiProps" - } + "SavedObjectFinderUiProps" ], "description": [], "source": { @@ -272,6 +267,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectLoader.Unnamed.$1", "type": "Any", "label": "SavedObjectClass", "isRequired": true, @@ -285,6 +281,7 @@ } }, { + "id": "def-public.SavedObjectLoader.Unnamed.$2", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -297,7 +294,7 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ], "description": [], "source": { @@ -325,6 +322,7 @@ ], "children": [ { + "id": "def-public.SavedObjectLoader.get.$1", "type": "CompoundType", "label": "opts", "isRequired": false, @@ -355,6 +353,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectLoader.urlFor.$1", "type": "string", "label": "id", "isRequired": true, @@ -385,6 +384,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectLoader.delete.$1", "type": "CompoundType", "label": "ids", "isRequired": true, @@ -411,13 +411,7 @@ "label": "mapHitSource", "signature": [ "(source: Record, id: string, references?: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => Record" ], "description": [ @@ -425,6 +419,7 @@ ], "children": [ { + "id": "def-public.SavedObjectLoader.mapHitSource.$1", "type": "Object", "label": "source", "isRequired": true, @@ -438,6 +433,7 @@ } }, { + "id": "def-public.SavedObjectLoader.mapHitSource.$2", "type": "string", "label": "id", "isRequired": true, @@ -451,17 +447,12 @@ } }, { + "id": "def-public.SavedObjectLoader.mapHitSource.$3", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -486,13 +477,7 @@ "label": "mapSavedObjectApiHits", "signature": [ "({ attributes, id, references, }: { attributes: Record; id: string; references?: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined; }) => Record" ], "description": [ @@ -500,7 +485,7 @@ ], "children": [ { - "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }", + "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences", "type": "Object", "label": "{\n attributes,\n id,\n references = [],\n }", "tags": [], @@ -508,7 +493,7 @@ "children": [ { "tags": [], - "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.attributes", + "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences.attributes", "type": "Object", "label": "attributes", "description": [], @@ -522,7 +507,7 @@ }, { "tags": [], - "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.id", + "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences.id", "type": "string", "label": "id", "description": [], @@ -533,7 +518,7 @@ }, { "tags": [], - "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.{\n- attributes,\n id,\n references = [],\n }.references", + "id": "def-public.SavedObjectLoader.mapSavedObjectApiHits.$1.attributesidreferences.references", "type": "Array", "label": "references", "description": [], @@ -542,13 +527,7 @@ "lineNumber": 116 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[] | undefined" ] } @@ -586,6 +565,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectLoader.find.$1", "type": "string", "label": "search", "isRequired": true, @@ -599,6 +579,7 @@ } }, { + "id": "def-public.SavedObjectLoader.find.$2", "type": "CompoundType", "label": "sizeOrOptions", "isRequired": true, @@ -786,6 +767,7 @@ ], "children": [ { + "id": "def-public.checkForDuplicateTitle.$1", "type": "Object", "label": "savedObject", "isRequired": true, @@ -807,6 +789,7 @@ } }, { + "id": "def-public.checkForDuplicateTitle.$2", "type": "boolean", "label": "isTitleDuplicateConfirmed", "isRequired": true, @@ -820,6 +803,7 @@ } }, { + "id": "def-public.checkForDuplicateTitle.$3", "type": "Function", "label": "onTitleDuplicate", "isRequired": false, @@ -833,18 +817,13 @@ } }, { + "id": "def-public.checkForDuplicateTitle.$4", "type": "Object", "label": "services", "isRequired": true, "signature": [ "Pick<", - { - "pluginId": "savedObjects", - "scope": "public", - "docId": "kibSavedObjectsPluginApi", - "section": "def-public.SavedObjectKibanaServices", - "text": "SavedObjectKibanaServices" - }, + "SavedObjectKibanaServices", ", \"savedObjectsClient\" | \"overlays\">" ], "description": [], @@ -867,6 +846,7 @@ "type": "Function", "children": [ { + "id": "def-public.getSavedObjectFinder.$1", "type": "Object", "label": "savedObject", "isRequired": true, @@ -886,6 +866,7 @@ } }, { + "id": "def-public.getSavedObjectFinder.$2", "type": "Object", "label": "uiSettings", "isRequired": true, @@ -946,7 +927,7 @@ "description": [], "children": [ { - "id": "def-public.isErrorNonFatal.error", + "id": "def-public.isErrorNonFatal.$1.error", "type": "Object", "label": "error", "tags": [], @@ -954,7 +935,7 @@ "children": [ { "tags": [], - "id": "def-public.isErrorNonFatal.error.message", + "id": "def-public.isErrorNonFatal.$1.error.message", "type": "string", "label": "message", "description": [], @@ -998,6 +979,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectSaveModalOrigin.$1", "type": "Object", "label": "props", "isRequired": true, @@ -1048,7 +1030,7 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">; overlays: ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">; overlays: ", { "pluginId": "core", "scope": "public", @@ -1070,17 +1052,12 @@ ], "children": [ { + "id": "def-public.saveWithConfirmation.$1", "type": "Object", "label": "source", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "SavedObjectAttributes" ], "description": [ "- serialized version of this object what will be indexed into elasticsearch." @@ -1091,14 +1068,14 @@ } }, { - "id": "def-public.saveWithConfirmation.savedObject", + "id": "def-public.saveWithConfirmation.$2.savedObject", "type": "Object", "label": "savedObject", "tags": [], "description": [], "children": [ { - "id": "def-public.saveWithConfirmation.savedObject.getEsType", + "id": "def-public.saveWithConfirmation.$2.savedObject.getEsType", "type": "Function", "label": "getEsType", "signature": [ @@ -1115,7 +1092,7 @@ }, { "tags": [], - "id": "def-public.saveWithConfirmation.savedObject.title", + "id": "def-public.saveWithConfirmation.$2.savedObject.title", "type": "string", "label": "title", "description": [], @@ -1126,7 +1103,7 @@ }, { "tags": [], - "id": "def-public.saveWithConfirmation.savedObject.displayName", + "id": "def-public.saveWithConfirmation.$2.savedObject.displayName", "type": "string", "label": "displayName", "description": [], @@ -1142,6 +1119,7 @@ } }, { + "id": "def-public.saveWithConfirmation.$3", "type": "Object", "label": "options", "isRequired": true, @@ -1163,7 +1141,7 @@ } }, { - "id": "def-public.saveWithConfirmation.services", + "id": "def-public.saveWithConfirmation.$4.services", "type": "Object", "label": "services", "tags": [], @@ -1171,7 +1149,7 @@ "children": [ { "tags": [], - "id": "def-public.saveWithConfirmation.services.savedObjectsClient", + "id": "def-public.saveWithConfirmation.$4.services.savedObjectsClient", "type": "Object", "label": "savedObjectsClient", "description": [], @@ -1188,12 +1166,12 @@ "section": "def-public.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">" ] }, { "tags": [], - "id": "def-public.saveWithConfirmation.services.overlays", + "id": "def-public.saveWithConfirmation.$4.services.overlays", "type": "Object", "label": "overlays", "description": [], @@ -1240,6 +1218,7 @@ "description": [], "children": [ { + "id": "def-public.showSaveModal.$1", "type": "Object", "label": "saveModal", "isRequired": true, @@ -1253,6 +1232,7 @@ } }, { + "id": "def-public.showSaveModal.$2", "type": "Function", "label": "I18nContext", "isRequired": true, @@ -1266,6 +1246,7 @@ } }, { + "id": "def-public.showSaveModal.$3", "type": "Function", "label": "Wrapper", "isRequired": false, @@ -1535,21 +1516,9 @@ }, "signature": [ "() => { attributes: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - }, + "SavedObjectAttributes", "; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ] }, @@ -1612,13 +1581,7 @@ }, "signature": [ "(opts: ", - { - "pluginId": "savedObjects", - "scope": "public", - "docId": "kibSavedObjectsPluginApi", - "section": "def-public.SavedObjectCreationOpts", - "text": "SavedObjectCreationOpts" - }, + "SavedObjectCreationOpts", ") => Record" ] }, @@ -1912,13 +1875,7 @@ "lineNumber": 49 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", " | undefined" ] } @@ -1992,21 +1949,9 @@ }, "signature": [ "((opts: ", - { - "pluginId": "savedObjects", - "scope": "public", - "docId": "kibSavedObjectsPluginApi", - "section": "def-public.SavedObjectAttributesAndRefs", - "text": "SavedObjectAttributesAndRefs" - }, + "SavedObjectAttributesAndRefs", ") => ", - { - "pluginId": "savedObjects", - "scope": "public", - "docId": "kibSavedObjectsPluginApi", - "section": "def-public.SavedObjectAttributesAndRefs", - "text": "SavedObjectAttributesAndRefs" - }, + "SavedObjectAttributesAndRefs", ") | undefined" ] }, @@ -2030,13 +1975,7 @@ "text": "SavedObject" }, ">(object: T, references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => void) | undefined" ] }, @@ -2450,6 +2389,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectMetaData.getIconForSavedObject.$1", "type": "Object", "label": "savedObject", "isRequired": true, @@ -2495,6 +2435,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectMetaData.getTooltipForSavedObject.$1", "type": "Object", "label": "savedObject", "isRequired": true, @@ -2540,6 +2481,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectMetaData.showSavedObject.$1", "type": "Object", "label": "savedObject", "isRequired": true, diff --git a/api_docs/saved_objects_management.json b/api_docs/saved_objects_management.json index 8cd47981d455..a2ca7e318bbb 100644 --- a/api_docs/saved_objects_management.json +++ b/api_docs/saved_objects_management.json @@ -47,34 +47,34 @@ "signature": [ "{ name: string; description: string; icon: string; type: string; available?: ((item: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, ") => boolean) | undefined; enabled?: ((item: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, ") => boolean) | undefined; onClick?: ((item: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, ") => void) | undefined; render?: ((item: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, ") => any) | undefined; }" @@ -120,10 +120,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, " | null" @@ -139,6 +139,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectsManagementAction.setActionContext.$1", "type": "Object", "label": "actionContext", "isRequired": true, @@ -169,6 +170,7 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectsManagementAction.registerOnFinishCallback.$1", "type": "Object", "label": "callback", "isRequired": true, @@ -196,10 +198,10 @@ "signature": [ "(record: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, ") => void" @@ -207,15 +209,16 @@ "description": [], "children": [ { + "id": "def-public.SavedObjectsManagementAction.start.$1", "type": "Object", "label": "record", "isRequired": true, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" } ], @@ -272,11 +275,18 @@ "text": "SavedObjectsImportResponse" }, ") => ", - "ProcessedImportResponse" + { + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.ProcessedImportResponse", + "text": "ProcessedImportResponse" + } ], "description": [], "children": [ { + "id": "def-public.processImportResponse.$1", "type": "Object", "label": "response", "isRequired": true, @@ -413,10 +423,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.FailedImport", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.FailedImport", "text": "FailedImport" }, "[]" @@ -667,9 +677,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectRelationKind", "text": "SavedObjectRelationKind" } @@ -687,9 +697,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectMetadata", "text": "SavedObjectMetadata" } @@ -724,10 +734,10 @@ "signature": [ "(action: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementAction", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementAction", "text": "SavedObjectsManagementAction" }, ") => void" @@ -778,10 +788,10 @@ "signature": [ "() => ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementAction", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementAction", "text": "SavedObjectsManagementAction" }, "[]" @@ -799,7 +809,13 @@ "type": "Interface", "label": "SavedObjectsManagementColumn", "signature": [ - "SavedObjectsManagementColumn", + { + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementColumn", + "text": "SavedObjectsManagementColumn" + }, "" ], "description": [], @@ -831,10 +847,10 @@ "EuiTableFieldDataColumnType", "<", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementRecord", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, ">, \"children\" | \"headers\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"description\" | \"title\" | \"id\" | \"name\" | \"field\" | \"placeholder\" | \"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\" | \"width\" | \"render\" | \"align\" | \"abbr\" | \"footer\" | \"colSpan\" | \"rowSpan\" | \"scope\" | \"valign\" | \"dataType\" | \"isExpander\" | \"textOnly\" | \"truncateText\" | \"isMobileHeader\" | \"mobileOptions\" | \"hideForMobile\">" @@ -869,10 +885,10 @@ "signature": [ "(column: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementColumn", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementColumn", "text": "SavedObjectsManagementColumn" }, ") => void" @@ -907,10 +923,10 @@ "signature": [ "() => ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementColumn", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementColumn", "text": "SavedObjectsManagementColumn" }, "[]" @@ -985,13 +1001,7 @@ "lineNumber": 19 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ] }, @@ -1128,10 +1138,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementActionServiceSetup", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementActionServiceSetup", "text": "SavedObjectsManagementActionServiceSetup" } ] @@ -1148,10 +1158,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementColumnServiceSetup", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementColumnServiceSetup", "text": "SavedObjectsManagementColumnServiceSetup" } ] @@ -1168,13 +1178,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementServiceRegistry", - "text": "SavedObjectsManagementServiceRegistry" - }, + "SavedObjectsManagementServiceRegistry", ", \"get\" | \"register\" | \"all\">" ] } @@ -1205,10 +1209,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementActionServiceStart", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementActionServiceStart", "text": "SavedObjectsManagementActionServiceStart" } ] @@ -1225,10 +1229,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsManagementColumnServiceStart", + "pluginId": "savedObjectsManagement", + "scope": "public", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-public.SavedObjectsManagementColumnServiceStart", "text": "SavedObjectsManagementColumnServiceStart" } ] @@ -1273,9 +1277,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectRelation", "text": "SavedObjectRelation" }, @@ -1294,9 +1298,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectInvalidRelation", "text": "SavedObjectInvalidRelation" }, @@ -1351,9 +1355,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectRelationKind", "text": "SavedObjectRelationKind" } @@ -1506,9 +1510,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectRelationKind", "text": "SavedObjectRelationKind" } @@ -1526,9 +1530,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsManagement", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsManagementPluginApi", "section": "def-common.SavedObjectMetadata", "text": "SavedObjectMetadata" } diff --git a/api_docs/saved_objects_tagging.json b/api_docs/saved_objects_tagging.json index 5b09e2534453..518ca211d573 100644 --- a/api_docs/saved_objects_tagging.json +++ b/api_docs/saved_objects_tagging.json @@ -99,17 +99,12 @@ "type": "Function", "children": [ { + "id": "def-common.getTagsCapabilities.$1", "type": "Object", "label": "capabilities", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - } + "Capabilities" ], "description": [], "source": { @@ -145,6 +140,7 @@ "type": "Function", "children": [ { + "id": "def-common.validateTagColor.$1", "type": "string", "label": "color", "isRequired": true, @@ -176,6 +172,7 @@ "type": "Function", "children": [ { + "id": "def-common.validateTagDescription.$1", "type": "string", "label": "description", "isRequired": true, @@ -207,6 +204,7 @@ "type": "Function", "children": [ { + "id": "def-common.validateTagName.$1", "type": "string", "label": "name", "isRequired": true, @@ -249,17 +247,17 @@ "signature": [ "(attributes: ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -268,14 +266,15 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.create.$1", "type": "Object", "label": "attributes", "isRequired": true, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } @@ -301,9 +300,9 @@ "signature": [ "(id: string) => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -312,6 +311,7 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -339,17 +339,17 @@ "signature": [ "(options?: ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, " | undefined) => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -358,14 +358,15 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.getAll.$1", "type": "Object", "label": "options", "isRequired": false, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, @@ -395,6 +396,7 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.delete.$1", "type": "string", "label": "id", "isRequired": true, @@ -422,17 +424,17 @@ "signature": [ "(id: string, attributes: ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -441,6 +443,7 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.update.$1", "type": "string", "label": "id", "isRequired": true, @@ -454,14 +457,15 @@ } }, { + "id": "def-common.ITagsClient.update.$2", "type": "Object", "label": "attributes", "isRequired": true, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } diff --git a/api_docs/saved_objects_tagging_oss.json b/api_docs/saved_objects_tagging_oss.json index fa7943ee5bd6..d6681914391e 100644 --- a/api_docs/saved_objects_tagging_oss.json +++ b/api_docs/saved_objects_tagging_oss.json @@ -70,9 +70,9 @@ "signature": [ "() => ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -98,9 +98,9 @@ "Observable", "<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -306,9 +306,9 @@ }, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.ITagsClient", "text": "ITagsClient" } @@ -328,10 +328,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.ITagsCache", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.ITagsCache", "text": "ITagsCache" } ] @@ -350,10 +350,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsTaggingApiUi", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApiUi", "text": "SavedObjectsTaggingApiUi" } ] @@ -383,9 +383,9 @@ "signature": [ "(tagId: string) => ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -396,6 +396,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.getTag.$1", "type": "string", "label": "tagId", "isRequired": true, @@ -431,10 +432,10 @@ }, ") => object is ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.TagDecoratedSavedObject", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.TagDecoratedSavedObject", "text": "TagDecoratedSavedObject" } ], @@ -443,6 +444,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.hasTagDecoration.$1", "type": "Object", "label": "object", "isRequired": true, @@ -476,10 +478,10 @@ "signature": [ "(options?: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.GetSearchBarFilterOptions", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.GetSearchBarFilterOptions", "text": "GetSearchBarFilterOptions" }, " | undefined) => ", @@ -490,15 +492,16 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.getSearchBarFilter.$1", "type": "Object", "label": "options", "isRequired": false, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.GetSearchBarFilterOptions", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.GetSearchBarFilterOptions", "text": "GetSearchBarFilterOptions" }, " | undefined" @@ -525,13 +528,7 @@ "() => ", "EuiTableFieldDataColumnType", "<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", ">" ], "description": [ @@ -565,6 +562,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.convertNameToReference.$1", "type": "string", "label": "tagName", "isRequired": true, @@ -592,18 +590,18 @@ "signature": [ "(query: string, options?: ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.ParseSearchQueryOptions", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.ParseSearchQueryOptions", "text": "ParseSearchQueryOptions" }, " | undefined) => ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.ParsedSearchQuery", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.ParsedSearchQuery", "text": "ParsedSearchQuery" } ], @@ -612,6 +610,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.parseSearchQuery.$1", "type": "string", "label": "query", "isRequired": true, @@ -627,15 +626,16 @@ } }, { + "id": "def-public.SavedObjectsTaggingApiUi.parseSearchQuery.$2", "type": "Object", "label": "options", "isRequired": false, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.ParseSearchQueryOptions", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.ParseSearchQueryOptions", "text": "ParseSearchQueryOptions" }, " | undefined" @@ -662,13 +662,7 @@ "label": "getTagIdsFromReferences", "signature": [ "(references: (", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", " | ", { "pluginId": "core", @@ -684,18 +678,13 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.getTagIdsFromReferences.$1", "type": "Array", "label": "references", "isRequired": true, "signature": [ "(", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", " | ", { "pluginId": "core", @@ -732,6 +721,7 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.getTagIdFromName.$1", "type": "string", "label": "tagName", "isRequired": true, @@ -758,21 +748,9 @@ "label": "updateTagsReferences", "signature": [ "(references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[], newTagIds: string[]) => ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [ @@ -780,17 +758,12 @@ ], "children": [ { + "id": "def-public.SavedObjectsTaggingApiUi.updateTagsReferences.$1", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -800,6 +773,7 @@ } }, { + "id": "def-public.SavedObjectsTaggingApiUi.updateTagsReferences.$2", "type": "Array", "label": "newTagIds", "isRequired": true, @@ -834,10 +808,10 @@ }, "signature": [ { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsTaggingApiUiComponent", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApiUiComponent", "text": "SavedObjectsTaggingApiUiComponent" } ] @@ -875,10 +849,10 @@ "signature": [ "React.FunctionComponent<", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.TagListComponentProps", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.TagListComponentProps", "text": "TagListComponentProps" }, ">" @@ -899,10 +873,10 @@ "signature": [ "React.FunctionComponent<", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.TagSelectorComponentProps", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.TagSelectorComponentProps", "text": "TagSelectorComponentProps" }, ">" @@ -923,10 +897,10 @@ "signature": [ "React.FunctionComponent<", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectSaveModalTagSelectorComponentProps", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectSaveModalTagSelectorComponentProps", "text": "SavedObjectSaveModalTagSelectorComponentProps" }, ">" @@ -963,13 +937,7 @@ "lineNumber": 218 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, + "SavedObject", "" ] } @@ -1091,10 +1059,10 @@ "signature": [ "(provider: Promise<", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsTaggingApi", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApi", "text": "SavedObjectsTaggingApi" }, ">) => void" @@ -1104,16 +1072,17 @@ ], "children": [ { + "id": "def-public.SavedObjectTaggingOssPluginSetup.registerTaggingApi.$1", "type": "Object", "label": "provider", "isRequired": true, "signature": [ "Promise<", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsTaggingApi", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApi", "text": "SavedObjectsTaggingApi" }, ">" @@ -1172,10 +1141,10 @@ "signature": [ "() => ", { - "pluginId": "savedObjects", - "scope": "common", - "docId": "kibSavedObjectsPluginApi", - "section": "def-common.SavedObjectsTaggingApi", + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApi", "text": "SavedObjectsTaggingApi" }, " | undefined" @@ -1254,17 +1223,17 @@ "signature": [ "(attributes: ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -1273,14 +1242,15 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.create.$1", "type": "Object", "label": "attributes", "isRequired": true, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } @@ -1306,9 +1276,9 @@ "signature": [ "(id: string) => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -1317,6 +1287,7 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.get.$1", "type": "string", "label": "id", "isRequired": true, @@ -1344,17 +1315,17 @@ "signature": [ "(options?: ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, " | undefined) => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -1363,14 +1334,15 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.getAll.$1", "type": "Object", "label": "options", "isRequired": false, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, @@ -1400,6 +1372,7 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.delete.$1", "type": "string", "label": "id", "isRequired": true, @@ -1427,17 +1400,17 @@ "signature": [ "(id: string, attributes: ", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.Tag", "text": "Tag" }, @@ -1446,6 +1419,7 @@ "description": [], "children": [ { + "id": "def-common.ITagsClient.update.$1", "type": "string", "label": "id", "isRequired": true, @@ -1459,14 +1433,15 @@ } }, { + "id": "def-common.ITagsClient.update.$2", "type": "Object", "label": "attributes", "isRequired": true, "signature": [ { - "pluginId": "savedObjects", + "pluginId": "savedObjectsTaggingOss", "scope": "common", - "docId": "kibSavedObjectsPluginApi", + "docId": "kibSavedObjectsTaggingOssPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } diff --git a/api_docs/security.json b/api_docs/security.json index 938a043a555c..7b29bb75e087 100644 --- a/api_docs/security.json +++ b/api_docs/security.json @@ -31,13 +31,7 @@ "lineNumber": 25 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.UserRealm", - "text": "UserRealm" - } + "UserRealm" ] }, { @@ -53,13 +47,7 @@ "lineNumber": 30 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.UserRealm", - "text": "UserRealm" - } + "UserRealm" ] }, { @@ -75,13 +63,7 @@ "lineNumber": 35 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.AuthenticationProvider", - "text": "AuthenticationProvider" - } + "AuthenticationProvider" ] }, { @@ -165,13 +147,7 @@ "label": "getFeatures", "signature": [ "() => ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SecurityLicenseFeatures", - "text": "SecurityLicenseFeatures" - } + "SecurityLicenseFeatures" ], "description": [], "children": [], @@ -195,13 +171,7 @@ "signature": [ "Observable", "<", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SecurityLicenseFeatures", - "text": "SecurityLicenseFeatures" - }, + "SecurityLicenseFeatures", ">" ] } @@ -404,7 +374,7 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", - "lineNumber": 29 + "lineNumber": 28 } }, { @@ -415,7 +385,7 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", - "lineNumber": 30 + "lineNumber": 29 }, "signature": [ "IconType" @@ -429,7 +399,7 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", - "lineNumber": 31 + "lineNumber": 30 } }, { @@ -440,7 +410,7 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", - "lineNumber": 32 + "lineNumber": 31 }, "signature": [ "number | undefined" @@ -454,7 +424,7 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", - "lineNumber": 33 + "lineNumber": 32 }, "signature": [ "boolean | undefined" @@ -463,7 +433,7 @@ ], "source": { "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", - "lineNumber": 28 + "lineNumber": 27 }, "initialIsOpen": false } @@ -718,13 +688,7 @@ "lineNumber": 25 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.UserRealm", - "text": "UserRealm" - } + "UserRealm" ] }, { @@ -740,13 +704,7 @@ "lineNumber": 30 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.UserRealm", - "text": "UserRealm" - } + "UserRealm" ] }, { @@ -762,13 +720,7 @@ "lineNumber": 35 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.AuthenticationProvider", - "text": "AuthenticationProvider" - } + "AuthenticationProvider" ] }, { @@ -791,6 +743,48 @@ }, "initialIsOpen": false }, + { + "id": "def-server.CheckPrivilegesPayload", + "type": "Interface", + "label": "CheckPrivilegesPayload", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.CheckPrivilegesPayload.kibana", + "type": "CompoundType", + "label": "kibana", + "description": [], + "source": { + "path": "x-pack/plugins/security/server/authorization/types.ts", + "lineNumber": 71 + }, + "signature": [ + "string | string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.CheckPrivilegesPayload.elasticsearch", + "type": "Object", + "label": "elasticsearch", + "description": [], + "source": { + "path": "x-pack/plugins/security/server/authorization/types.ts", + "lineNumber": 72 + }, + "signature": [ + "{ cluster: string[]; index: Record; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/security/server/authorization/types.ts", + "lineNumber": 70 + }, + "initialIsOpen": false + }, { "id": "def-server.CreateAPIKeyResult", "type": "Interface", @@ -1083,13 +1077,7 @@ "text": "KibanaRequest" }, ") => ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.AuthenticatedUser", - "text": "AuthenticatedUser" - }, + "AuthenticatedUser", " | null; }" ] }, @@ -1107,13 +1095,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.AuthorizationServiceSetup", - "text": "AuthorizationServiceSetup" - }, + "AuthorizationServiceSetup", ", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">" ] }, @@ -1128,13 +1110,7 @@ "lineNumber": 81 }, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SecurityLicense", - "text": "SecurityLicense" - } + "SecurityLicense" ] }, { @@ -1148,13 +1124,7 @@ "lineNumber": 82 }, "signature": [ - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.AuditServiceSetup", - "text": "AuditServiceSetup" - } + "AuditServiceSetup" ] } ], @@ -1185,13 +1155,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.AuthenticationServiceStart", - "text": "AuthenticationServiceStart" - }, + "AuthenticationServiceStart", ", \"apiKeys\" | \"getCurrentUser\">" ] }, @@ -1207,13 +1171,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.AuthorizationServiceSetup", - "text": "AuthorizationServiceSetup" - }, + "AuthorizationServiceSetup", ", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">" ] } diff --git a/api_docs/security_oss.json b/api_docs/security_oss.json index 7fdacda7bd30..8734617654b7 100644 --- a/api_docs/security_oss.json +++ b/api_docs/security_oss.json @@ -25,13 +25,7 @@ "lineNumber": 26 }, "signature": [ - { - "pluginId": "securityOss", - "scope": "public", - "docId": "kibSecurityOssPluginApi", - "section": "def-public.InsecureClusterServiceSetup", - "text": "InsecureClusterServiceSetup" - } + "InsecureClusterServiceSetup" ] } ], @@ -60,13 +54,7 @@ "lineNumber": 30 }, "signature": [ - { - "pluginId": "securityOss", - "scope": "public", - "docId": "kibSecurityOssPluginApi", - "section": "def-public.InsecureClusterServiceStart", - "text": "InsecureClusterServiceStart" - } + "InsecureClusterServiceStart" ] }, { @@ -81,13 +69,7 @@ }, "signature": [ "{ getAccessURLParameters: () => Promise | null>; getCapabilities: () => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - }, + "Capabilities", ">; }" ] } @@ -145,13 +127,7 @@ }, "signature": [ "(provider: () => ", - { - "pluginId": "securityOss", - "scope": "server", - "docId": "kibSecurityOssPluginApi", - "section": "def-server.AnonymousAccessService", - "text": "AnonymousAccessService" - }, + "AnonymousAccessService", ") => void" ] } diff --git a/api_docs/security_solution.json b/api_docs/security_solution.json index ae85541ba6bf..aea50fdbfeca 100644 --- a/api_docs/security_solution.json +++ b/api_docs/security_solution.json @@ -9,7 +9,13 @@ "label": "Plugin", "description": [], "signature": [ - "Plugin", + { + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, " implements ", { "pluginId": "core", @@ -19,9 +25,21 @@ "text": "Plugin" }, "<", - "PluginSetup", + { + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.PluginSetup", + "text": "PluginSetup" + }, ", ", - "PluginStart", + { + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.PluginStart", + "text": "PluginStart" + }, ", ", "SetupPlugins" ], @@ -36,6 +54,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -77,41 +96,30 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ", ", { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.PluginStart", + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.PluginStart", "text": "PluginStart" }, ">, plugins: ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SetupPlugins", - "text": "SetupPlugins" - }, + "SetupPlugins", ") => ", { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.PluginSetup", + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.PluginSetup", "text": "PluginSetup" } ], "description": [], "children": [ { + "id": "def-public.Plugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -124,19 +132,13 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ", ", { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.PluginStart", + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.PluginStart", "text": "PluginStart" }, ">" @@ -148,17 +150,12 @@ } }, { + "id": "def-public.Plugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SetupPlugins", - "text": "SetupPlugins" - } + "SetupPlugins" ], "description": [], "source": { @@ -188,18 +185,13 @@ "text": "CoreStart" }, ", plugins: ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ") => {}" ], "description": [], "children": [ { + "id": "def-public.Plugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -219,17 +211,12 @@ } }, { + "id": "def-public.Plugin.start.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - } + "StartPlugins" ], "description": [], "source": { @@ -293,13 +280,7 @@ }, "signature": [ "() => Promise<", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.ResolverPluginSetup", - "text": "ResolverPluginSetup" - }, + "ResolverPluginSetup", ">" ] } @@ -345,6 +326,7 @@ "description": [], "children": [ { + "id": "def-server.AppClient.Unnamed.$1", "type": "string", "label": "spaceId", "isRequired": true, @@ -358,6 +340,7 @@ } }, { + "id": "def-server.AppClient.Unnamed.$2", "type": "Object", "label": "config", "isRequired": true, @@ -408,7 +391,13 @@ "label": "Plugin", "description": [], "signature": [ - "Plugin", + { + "pluginId": "securitySolution", + "scope": "server", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, " implements ", { "pluginId": "core", @@ -418,9 +407,21 @@ "text": "Plugin" }, "<", - "PluginSetup", + { + "pluginId": "securitySolution", + "scope": "server", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-server.PluginSetup", + "text": "PluginSetup" + }, ", ", - "PluginStart", + { + "pluginId": "securitySolution", + "scope": "server", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-server.PluginStart", + "text": "PluginStart" + }, ", ", "SetupPlugins" ], @@ -435,6 +436,7 @@ "description": [], "children": [ { + "id": "def-server.Plugin.Unnamed.$1", "type": "Object", "label": "context", "isRequired": true, @@ -451,7 +453,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 145 + "lineNumber": 147 } } ], @@ -459,7 +461,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 145 + "lineNumber": 147 } }, { @@ -476,34 +478,23 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ", ", { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.PluginStart", + "pluginId": "securitySolution", + "scope": "server", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-server.PluginStart", "text": "PluginStart" }, ">, plugins: ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SetupPlugins", - "text": "SetupPlugins" - }, + "SetupPlugins", ") => {}" ], "description": [], "children": [ { + "id": "def-server.Plugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -516,19 +507,13 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ", ", { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.PluginStart", + "pluginId": "securitySolution", + "scope": "server", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-server.PluginStart", "text": "PluginStart" }, ">" @@ -536,26 +521,21 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 157 + "lineNumber": 159 } }, { + "id": "def-server.Plugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.SetupPlugins", - "text": "SetupPlugins" - } + "SetupPlugins" ], "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 157 + "lineNumber": 159 } } ], @@ -563,7 +543,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 157 + "lineNumber": 159 } }, { @@ -580,18 +560,13 @@ "text": "CoreStart" }, ", plugins: ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - }, + "StartPlugins", ") => {}" ], "description": [], "children": [ { + "id": "def-server.Plugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -607,26 +582,21 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 339 + "lineNumber": 341 } }, { + "id": "def-server.Plugin.start.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.StartPlugins", - "text": "StartPlugins" - } + "StartPlugins" ], "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 339 + "lineNumber": 341 } } ], @@ -634,7 +604,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 339 + "lineNumber": 341 } }, { @@ -650,13 +620,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 405 + "lineNumber": 423 } } ], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 129 + "lineNumber": 131 }, "initialIsOpen": false } @@ -667,6 +637,7 @@ "type": "Function", "children": [ { + "id": "def-server.buildRouteValidation.$1", "type": "Uncategorized", "label": "schema", "isRequired": true, @@ -710,6 +681,7 @@ "type": "Function", "children": [ { + "id": "def-server.buildSiemResponse.$1", "type": "Object", "label": "response", "isRequired": true, @@ -725,13 +697,7 @@ "text": "CustomHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - }, + "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", @@ -741,13 +707,7 @@ "text": "ErrorHttpResponseOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaResponse", - "text": "KibanaResponse" - } + "KibanaResponse" ], "description": [], "source": { @@ -795,6 +755,7 @@ "type": "Function", "children": [ { + "id": "def-server.createBootstrapIndex.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -814,6 +775,7 @@ } }, { + "id": "def-server.createBootstrapIndex.$2", "type": "string", "label": "index", "isRequired": true, @@ -853,6 +815,7 @@ "type": "Function", "children": [ { + "id": "def-server.deleteAllIndex.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -872,6 +835,7 @@ } }, { + "id": "def-server.deleteAllIndex.$2", "type": "string", "label": "pattern", "isRequired": true, @@ -885,6 +849,7 @@ } }, { + "id": "def-server.deleteAllIndex.$3", "type": "number", "label": "maxAttempts", "isRequired": true, @@ -924,6 +889,7 @@ "type": "Function", "children": [ { + "id": "def-server.deletePolicy.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -943,6 +909,7 @@ } }, { + "id": "def-server.deletePolicy.$2", "type": "string", "label": "policy", "isRequired": true, @@ -982,6 +949,7 @@ "type": "Function", "children": [ { + "id": "def-server.deleteTemplate.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1001,6 +969,7 @@ } }, { + "id": "def-server.deleteTemplate.$2", "type": "string", "label": "name", "isRequired": true, @@ -1040,6 +1009,7 @@ "type": "Function", "children": [ { + "id": "def-server.getIndexExists.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1059,6 +1029,7 @@ } }, { + "id": "def-server.getIndexExists.$2", "type": "string", "label": "index", "isRequired": true, @@ -1098,6 +1069,7 @@ "type": "Function", "children": [ { + "id": "def-server.getPolicyExists.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1117,6 +1089,7 @@ } }, { + "id": "def-server.getPolicyExists.$2", "type": "string", "label": "policy", "isRequired": true, @@ -1156,6 +1129,7 @@ "type": "Function", "children": [ { + "id": "def-server.getTemplateExists.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1175,6 +1149,7 @@ } }, { + "id": "def-server.getTemplateExists.$2", "type": "string", "label": "template", "isRequired": true, @@ -1214,17 +1189,12 @@ "type": "Function", "children": [ { + "id": "def-server.readPrivileges.$1", "type": "Function", "label": "callWithRequest", "isRequired": true, "signature": [ - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.CallWithRequest", - "text": "CallWithRequest" - }, + "CallWithRequest", "<{}, unknown>" ], "description": [], @@ -1234,6 +1204,7 @@ } }, { + "id": "def-server.readPrivileges.$2", "type": "string", "label": "index", "isRequired": true, @@ -1267,6 +1238,7 @@ "type": "Function", "children": [ { + "id": "def-server.setPolicy.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1286,6 +1258,7 @@ } }, { + "id": "def-server.setPolicy.$2", "type": "string", "label": "policy", "isRequired": true, @@ -1299,6 +1272,7 @@ } }, { + "id": "def-server.setPolicy.$3", "type": "Object", "label": "body", "isRequired": true, @@ -1338,6 +1312,7 @@ "type": "Function", "children": [ { + "id": "def-server.setTemplate.$1", "type": "CompoundType", "label": "esClient", "isRequired": true, @@ -1357,6 +1332,7 @@ } }, { + "id": "def-server.setTemplate.$2", "type": "string", "label": "name", "isRequired": true, @@ -1370,6 +1346,7 @@ } }, { + "id": "def-server.setTemplate.$3", "type": "Object", "label": "body", "isRequired": true, @@ -1409,6 +1386,7 @@ "type": "Function", "children": [ { + "id": "def-server.transformError.$1", "type": "CompoundType", "label": "err", "isRequired": true, @@ -1462,10 +1440,10 @@ "signature": [ "() => ", { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.AppClient", + "pluginId": "securitySolution", + "scope": "server", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-server.AppClient", "text": "AppClient" } ] @@ -1506,7 +1484,7 @@ "children": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 106 + "lineNumber": 107 }, "lifecycle": "setup", "initialIsOpen": true @@ -1520,7 +1498,7 @@ "children": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 108 + "lineNumber": 110 }, "lifecycle": "start", "initialIsOpen": true @@ -1534,6 +1512,7 @@ "type": "Function", "children": [ { + "id": "def-common.addIdToItem.$1", "type": "Uncategorized", "label": "item", "isRequired": true, @@ -1565,6 +1544,7 @@ "type": "Function", "children": [ { + "id": "def-common.DefaultArray.$1", "type": "Uncategorized", "label": "codec", "isRequired": true, @@ -1606,6 +1586,7 @@ "type": "Function", "children": [ { + "id": "def-common.exactCheck.$1", "type": "Unknown", "label": "original", "isRequired": true, @@ -1619,6 +1600,7 @@ } }, { + "id": "def-common.exactCheck.$2", "type": "CompoundType", "label": "decoded", "isRequired": true, @@ -1682,6 +1664,7 @@ "type": "Function", "children": [ { + "id": "def-common.formatErrors.$1", "type": "Object", "label": "errors", "isRequired": true, @@ -1715,6 +1698,7 @@ "type": "Function", "children": [ { + "id": "def-common.getPaths.$1", "type": "CompoundType", "label": "validation", "isRequired": true, @@ -1755,6 +1739,7 @@ "type": "Function", "children": [ { + "id": "def-common.removeExternalLinkText.$1", "type": "string", "label": "str", "isRequired": true, @@ -1788,6 +1773,7 @@ "type": "Function", "children": [ { + "id": "def-common.removeIdFromItem.$1", "type": "Uncategorized", "label": "item", "isRequired": true, @@ -1821,6 +1807,7 @@ "type": "Function", "children": [ { + "id": "def-common.validate.$1", "type": "Uncategorized", "label": "obj", "isRequired": true, @@ -1834,6 +1821,7 @@ } }, { + "id": "def-common.validate.$2", "type": "Uncategorized", "label": "schema", "isRequired": true, @@ -1869,6 +1857,7 @@ "type": "Function", "children": [ { + "id": "def-common.validateEither.$1", "type": "Uncategorized", "label": "schema", "isRequired": true, @@ -1878,10 +1867,11 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/validate.ts", - "lineNumber": 30 + "lineNumber": 43 } }, { + "id": "def-common.validateEither.$2", "type": "Uncategorized", "label": "obj", "isRequired": true, @@ -1891,7 +1881,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/validate.ts", - "lineNumber": 31 + "lineNumber": 44 } } ], @@ -1906,7 +1896,7 @@ "label": "validateEither", "source": { "path": "x-pack/plugins/security_solution/common/validate.ts", - "lineNumber": 29 + "lineNumber": 42 }, "tags": [], "returnComment": [], diff --git a/api_docs/share.json b/api_docs/share.json index d8cfef694388..f59639d35aba 100644 --- a/api_docs/share.json +++ b/api_docs/share.json @@ -52,6 +52,7 @@ "description": [], "children": [ { + "id": "def-public.KibanaURL.Unnamed.$1", "type": "string", "label": "path", "isRequired": true, @@ -138,17 +139,12 @@ "text": "CoreSetup" }, ") => ", - { - "pluginId": "share", - "scope": "public", - "docId": "kibSharePluginApi", - "section": "def-public.UrlGeneratorsSetup", - "text": "UrlGeneratorsSetup" - } + "UrlGeneratorsSetup" ], "description": [], "children": [ { + "id": "def-public.UrlGeneratorsService.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -190,17 +186,12 @@ "text": "CoreStart" }, ") => ", - { - "pluginId": "share", - "scope": "public", - "docId": "kibSharePluginApi", - "section": "def-public.UrlGeneratorsStart", - "text": "UrlGeneratorsStart" - } + "UrlGeneratorsStart" ], "description": [], "children": [ { + "id": "def-public.UrlGeneratorsService.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -272,6 +263,7 @@ ], "children": [ { + "id": "def-public.downloadFileAs.$1", "type": "string", "label": "filename", "isRequired": true, @@ -287,6 +279,7 @@ } }, { + "id": "def-public.downloadFileAs.$2", "type": "CompoundType", "label": "payload", "isRequired": true, @@ -338,6 +331,7 @@ ], "children": [ { + "id": "def-public.downloadMultipleAs.$1", "type": "Object", "label": "files", "isRequired": true, @@ -471,13 +465,7 @@ }, "signature": [ "((anonymousUserCapabilities: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - }, + "Capabilities", ") => boolean) | undefined" ] } @@ -722,13 +710,7 @@ "lineNumber": 91 }, "signature": [ - { - "pluginId": "share", - "scope": "public", - "docId": "kibSharePluginApi", - "section": "def-public.UrlParamExtension", - "text": "UrlParamExtension" - }, + "UrlParamExtension", "[] | undefined" ] } @@ -788,6 +770,7 @@ "description": [], "children": [ { + "id": "def-public.UrlGeneratorContract.createUrl.$1", "type": "Uncategorized", "label": "state", "isRequired": true, @@ -860,6 +843,7 @@ "description": [], "children": [ { + "id": "def-public.UrlGeneratorContract.migrate.$1", "type": "Uncategorized", "label": "state", "isRequired": true, diff --git a/api_docs/snapshot_restore.json b/api_docs/snapshot_restore.json index af05cb837e26..1b2fb17feaab 100644 --- a/api_docs/snapshot_restore.json +++ b/api_docs/snapshot_restore.json @@ -164,6 +164,7 @@ "type": "Function", "children": [ { + "id": "def-common.PLUGIN.getI18nName.$1", "type": "Any", "label": "i18n", "isRequired": true, @@ -205,7 +206,7 @@ "children": [ { "tags": [], - "id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-s3'", + "id": "def-common.REPOSITORY_PLUGINS_MAP.repositorys3", "type": "string", "label": "'repository-s3'", "description": [], @@ -226,7 +227,7 @@ }, { "tags": [], - "id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-hdfs'", + "id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryhdfs", "type": "string", "label": "'repository-hdfs'", "description": [], @@ -247,7 +248,7 @@ }, { "tags": [], - "id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-azure'", + "id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryazure", "type": "string", "label": "'repository-azure'", "description": [], @@ -268,7 +269,7 @@ }, { "tags": [], - "id": "def-common.REPOSITORY_PLUGINS_MAP.'repository-gcs'", + "id": "def-common.REPOSITORY_PLUGINS_MAP.repositorygcs", "type": "string", "label": "'repository-gcs'", "description": [], diff --git a/api_docs/spaces.json b/api_docs/spaces.json index 8a74132d862b..299bba81678a 100644 --- a/api_docs/spaces.json +++ b/api_docs/spaces.json @@ -23,6 +23,7 @@ ], "children": [ { + "id": "def-public.getSpaceColor.$1", "type": "Object", "label": "space", "isRequired": true, @@ -72,6 +73,7 @@ ], "children": [ { + "id": "def-public.getSpaceImageUrl.$1", "type": "Object", "label": "space", "isRequired": true, @@ -121,6 +123,7 @@ ], "children": [ { + "id": "def-public.getSpaceInitials.$1", "type": "Object", "label": "space", "isRequired": true, @@ -391,6 +394,7 @@ "description": [], "children": [ { + "id": "def-server.addSpaceIdToPath.$1", "type": "string", "label": "basePath", "isRequired": true, @@ -404,6 +408,7 @@ } }, { + "id": "def-server.addSpaceIdToPath.$2", "type": "string", "label": "spaceId", "isRequired": true, @@ -417,6 +422,7 @@ } }, { + "id": "def-server.addSpaceIdToPath.$3", "type": "string", "label": "requestedPath", "isRequired": true, @@ -682,6 +688,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceSetup.getSpaceId.$1", "type": "Object", "label": "request", "isRequired": true, @@ -723,6 +730,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceSetup.spaceIdToNamespace.$1", "type": "string", "label": "spaceId", "isRequired": true, @@ -757,6 +765,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceSetup.namespaceToSpaceId.$1", "type": "string", "label": "namespace", "isRequired": false, @@ -815,13 +824,7 @@ "text": "KibanaRequest" }, ") => Pick<", - { - "pluginId": "spaces", - "scope": "server", - "docId": "kibSpacesPluginApi", - "section": "def-server.SpacesClient", - "text": "SpacesClient" - }, + "SpacesClient", ", \"get\" | \"delete\" | \"create\" | \"update\" | \"getAll\">" ] }, @@ -845,6 +848,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceStart.getSpaceId.$1", "type": "Object", "label": "request", "isRequired": true, @@ -892,6 +896,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceStart.isInDefaultSpace.$1", "type": "Object", "label": "request", "isRequired": true, @@ -947,6 +952,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceStart.getActiveSpace.$1", "type": "Object", "label": "request", "isRequired": true, @@ -986,6 +992,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceStart.spaceIdToNamespace.$1", "type": "string", "label": "spaceId", "isRequired": true, @@ -1018,6 +1025,7 @@ ], "children": [ { + "id": "def-server.SpacesServiceStart.namespaceToSpaceId.$1", "type": "string", "label": "namespace", "isRequired": false, @@ -1119,21 +1127,9 @@ }, "signature": [ "{ setClientRepositoryFactory: (factory: ", - { - "pluginId": "spaces", - "scope": "server", - "docId": "kibSpacesPluginApi", - "section": "def-server.SpacesClientRepositoryFactory", - "text": "SpacesClientRepositoryFactory" - }, + "SpacesClientRepositoryFactory", ") => void; registerClientWrapper: (wrapper: ", - { - "pluginId": "spaces", - "scope": "server", - "docId": "kibSpacesPluginApi", - "section": "def-server.SpacesClientWrapper", - "text": "SpacesClientWrapper" - }, + "SpacesClientWrapper", ") => void; }" ] } @@ -1194,6 +1190,7 @@ "description": [], "children": [ { + "id": "def-common.addSpaceIdToPath.$1", "type": "string", "label": "basePath", "isRequired": true, @@ -1207,6 +1204,7 @@ } }, { + "id": "def-common.addSpaceIdToPath.$2", "type": "string", "label": "spaceId", "isRequired": true, @@ -1220,6 +1218,7 @@ } }, { + "id": "def-common.addSpaceIdToPath.$3", "type": "string", "label": "requestedPath", "isRequired": true, @@ -1251,6 +1250,7 @@ "description": [], "children": [ { + "id": "def-common.getSpaceIdFromPath.$1", "type": "CompoundType", "label": "requestBasePath", "isRequired": false, @@ -1264,6 +1264,7 @@ } }, { + "id": "def-common.getSpaceIdFromPath.$2", "type": "CompoundType", "label": "serverBasePath", "isRequired": false, @@ -1305,6 +1306,7 @@ ], "children": [ { + "id": "def-common.isReservedSpace.$1", "type": "CompoundType", "label": "space", "isRequired": false, diff --git a/api_docs/spaces_oss.json b/api_docs/spaces_oss.json index ab9717a25ab6..a93aeefb3db6 100644 --- a/api_docs/spaces_oss.json +++ b/api_docs/spaces_oss.json @@ -961,6 +961,7 @@ ], "children": [ { + "id": "def-public.SpacesOssPluginSetup.registerSpacesApi.$1", "type": "Object", "label": "provider", "isRequired": true, diff --git a/api_docs/task_manager.json b/api_docs/task_manager.json index f2d228ebd061..0d12bd269a0a 100644 --- a/api_docs/task_manager.json +++ b/api_docs/task_manager.json @@ -61,6 +61,7 @@ "description": [], "children": [ { + "id": "def-server.TaskManagerPlugin.Unnamed.$1", "type": "Object", "label": "initContext", "isRequired": true, @@ -113,6 +114,7 @@ "description": [], "children": [ { + "id": "def-server.TaskManagerPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -165,6 +167,7 @@ "description": [], "children": [ { + "id": "def-server.TaskManagerPlugin.start.$1", "type": "Object", "label": "{ savedObjects, elasticsearch }", "isRequired": true, @@ -212,18 +215,13 @@ "description": [], "children": [ { + "id": "def-server.isUnrecoverableError.$1", "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "Error | ", - { - "pluginId": "taskManager", - "scope": "server", - "docId": "kibTaskManagerPluginApi", - "section": "def-server.DecoratedError", - "text": "DecoratedError" - } + "DecoratedError" ], "description": [], "source": { @@ -250,6 +248,7 @@ "description": [], "children": [ { + "id": "def-server.throwUnrecoverableError.$1", "type": "Object", "label": "error", "isRequired": true, @@ -617,13 +616,7 @@ "lineNumber": 239 }, "signature": [ - { - "pluginId": "taskManager", - "scope": "server", - "docId": "kibTaskManagerPluginApi", - "section": "def-server.IntervalSchedule", - "text": "IntervalSchedule" - }, + "IntervalSchedule", " | undefined" ] }, diff --git a/api_docs/telemetry.json b/api_docs/telemetry.json index 043e126de364..bff65ce9c68d 100644 --- a/api_docs/telemetry.json +++ b/api_docs/telemetry.json @@ -25,13 +25,7 @@ "lineNumber": 38 }, "signature": [ - { - "pluginId": "telemetry", - "scope": "public", - "docId": "kibTelemetryPluginApi", - "section": "def-public.TelemetryService", - "text": "TelemetryService" - } + "TelemetryService" ] }, { @@ -45,13 +39,7 @@ "lineNumber": 39 }, "signature": [ - { - "pluginId": "telemetry", - "scope": "public", - "docId": "kibTelemetryPluginApi", - "section": "def-public.TelemetryNotifications", - "text": "TelemetryNotifications" - } + "TelemetryNotifications" ] }, { @@ -94,13 +82,7 @@ "lineNumber": 34 }, "signature": [ - { - "pluginId": "telemetry", - "scope": "public", - "docId": "kibTelemetryPluginApi", - "section": "def-public.TelemetryService", - "text": "TelemetryService" - } + "TelemetryService" ] } ], @@ -131,6 +113,7 @@ "description": [], "children": [ { + "id": "def-server.FetcherTask.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -142,7 +125,7 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - ">" + ">" ], "description": [], "source": { @@ -172,18 +155,13 @@ "text": "CoreStart" }, ", { telemetryCollectionManager }: ", - { - "pluginId": "telemetry", - "scope": "server", - "docId": "kibTelemetryPluginApi", - "section": "def-server.FetcherTaskDepsStart", - "text": "FetcherTaskDepsStart" - }, + "FetcherTaskDepsStart", ") => void" ], "description": [], "children": [ { + "id": "def-server.FetcherTask.start.$1", "type": "Object", "label": "{ savedObjects, elasticsearch }", "isRequired": true, @@ -203,17 +181,12 @@ } }, { + "id": "def-server.FetcherTask.start.$2", "type": "Object", "label": "{ telemetryCollectionManager }", "isRequired": true, "signature": [ - { - "pluginId": "telemetry", - "scope": "server", - "docId": "kibTelemetryPluginApi", - "section": "def-server.FetcherTaskDepsStart", - "text": "FetcherTaskDepsStart" - } + "FetcherTaskDepsStart" ], "description": [], "source": { @@ -279,6 +252,7 @@ "description": [], "children": [ { + "id": "def-server.buildDataTelemetryPayload.$1", "type": "Array", "label": "indices", "isRequired": true, @@ -312,15 +286,16 @@ "type": "Function", "children": [ { + "id": "def-server.getClusterUuids.$1", "type": "Object", "label": "{ esClient }", "isRequired": true, "signature": [ { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsCollectionConfig", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", "text": "StatsCollectionConfig" } ], @@ -333,7 +308,13 @@ ], "signature": [ "({ esClient }: ", - "StatsCollectionConfig", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", + "text": "StatsCollectionConfig" + }, ") => Promise<{ clusterUuid: string; }[]>" ], "description": [ @@ -353,15 +334,16 @@ "type": "Function", "children": [ { + "id": "def-server.getLocalStats.$1", "type": "Array", "label": "clustersDetails", "isRequired": true, "signature": [ { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.ClusterDetails", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.ClusterDetails", "text": "ClusterDetails" }, "[]" @@ -373,15 +355,16 @@ } }, { + "id": "def-server.getLocalStats.$2", "type": "Object", "label": "config", "isRequired": true, "signature": [ { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsCollectionConfig", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", "text": "StatsCollectionConfig" } ], @@ -392,15 +375,16 @@ } }, { + "id": "def-server.getLocalStats.$3", "type": "Object", "label": "context", "isRequired": true, "signature": [ { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsCollectionContext", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionContext", "text": "StatsCollectionContext" } ], @@ -413,11 +397,29 @@ ], "signature": [ "(clustersDetails: ", - "ClusterDetails", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.ClusterDetails", + "text": "ClusterDetails" + }, "[], config: ", - "StatsCollectionConfig", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", + "text": "StatsCollectionConfig" + }, ", context: ", - "StatsCollectionContext", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionContext", + "text": "StatsCollectionContext" + }, ") => Promise<{ timestamp: string; cluster_uuid: string; cluster_name: string; version: string; cluster_stats: any; collection: string; stack_stats: { data: ", { "pluginId": "telemetry", @@ -453,7 +455,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, uiSettingsClient: ", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, uiSettingsClient: ", { "pluginId": "core", "scope": "server", @@ -466,6 +468,7 @@ "description": [], "children": [ { + "id": "def-server.handleOldSettings.$1", "type": "Object", "label": "savedObjectsClient", "isRequired": true, @@ -478,7 +481,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "description": [], "source": { @@ -487,6 +490,7 @@ } }, { + "id": "def-server.handleOldSettings.$2", "type": "Object", "label": "uiSettingsClient", "isRequired": true, diff --git a/api_docs/telemetry_collection_manager.json b/api_docs/telemetry_collection_manager.json index 30d3bb76a43b..1bd65a82cffd 100644 --- a/api_docs/telemetry_collection_manager.json +++ b/api_docs/telemetry_collection_manager.json @@ -56,13 +56,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorSet", - "text": "CollectorSet" - }, + "CollectorSet", ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\">" ] }, @@ -105,7 +99,7 @@ "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ] }, { @@ -181,7 +175,13 @@ "type": "Interface", "label": "UsageStatsPayload", "signature": [ - "UsageStatsPayload", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.UsageStatsPayload", + "text": "UsageStatsPayload" + }, " extends ", "BasicStatsPayload" ], @@ -221,11 +221,29 @@ }, "signature": [ "(config: ", - "StatsCollectionConfig", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", + "text": "StatsCollectionConfig" + }, ", context: ", - "StatsCollectionContext", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionContext", + "text": "StatsCollectionContext" + }, ") => Promise<", - "ClusterDetails", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.ClusterDetails", + "text": "ClusterDetails" + }, "[]>" ], "initialIsOpen": false @@ -242,11 +260,29 @@ }, "signature": [ "(clustersDetails: ", - "ClusterDetails", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.ClusterDetails", + "text": "ClusterDetails" + }, "[], config: ", - "StatsCollectionConfig", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", + "text": "StatsCollectionConfig" + }, ", context: ", - "StatsCollectionContext", + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionContext", + "text": "StatsCollectionContext" + }, ") => Promise" ], "initialIsOpen": false @@ -289,21 +325,9 @@ }, "signature": [ "(collectionConfig: ", - { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.CollectionStrategyConfig", - "text": "CollectionStrategyConfig" - }, + "CollectionStrategyConfig", ") => void" ] }, @@ -320,10 +344,10 @@ "signature": [ "(optInStatus: boolean, config: ", { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsGetterConfig", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" @@ -342,18 +366,18 @@ "signature": [ "(config: ", { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsGetterConfig", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" @@ -401,10 +425,10 @@ "signature": [ "(optInStatus: boolean, config: ", { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsGetterConfig", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" @@ -423,18 +447,18 @@ "signature": [ "(config: ", { - "pluginId": "telemetry", - "scope": "common", - "docId": "kibTelemetryPluginApi", - "section": "def-common.StatsGetterConfig", + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" diff --git a/api_docs/telemetry_management_section.json b/api_docs/telemetry_management_section.json index 7b3e897689de..a238370bd023 100644 --- a/api_docs/telemetry_management_section.json +++ b/api_docs/telemetry_management_section.json @@ -11,7 +11,13 @@ "\nReact component for displaying the example data associated with the Telemetry opt-in banner." ], "signature": [ - "OptInExampleFlyout", + { + "pluginId": "telemetryManagementSection", + "scope": "public", + "docId": "kibTelemetryManagementSectionPluginApi", + "section": "def-public.OptInExampleFlyout", + "text": "OptInExampleFlyout" + }, " extends React.PureComponent" ], "children": [ @@ -123,6 +129,7 @@ "description": [], "children": [ { + "id": "def-public.OptInExampleFlyout.renderBody.$1", "type": "Object", "label": "{ data, isLoading, hasPrivilegeToRead }", "isRequired": true, diff --git a/api_docs/timelines.json b/api_docs/timelines.json new file mode 100644 index 000000000000..309db2a963f7 --- /dev/null +++ b/api_docs/timelines.json @@ -0,0 +1,119 @@ +{ + "id": "timelines", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.TimelinesPluginSetup", + "type": "Interface", + "label": "TimelinesPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.TimelinesPluginSetup.getTimeline", + "type": "Function", + "label": "getTimeline", + "description": [], + "source": { + "path": "x-pack/plugins/timelines/public/types.ts", + "lineNumber": 4 + }, + "signature": [ + "((props: ", + "TimelineProps", + ") => React.ReactElement<", + "TimelineProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>) | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/timelines/public/types.ts", + "lineNumber": 3 + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-server.TimelinesPluginSetup", + "type": "Interface", + "label": "TimelinesPluginSetup", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/timelines/server/types.ts", + "lineNumber": 2 + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.TimelinesPluginStart", + "type": "Interface", + "label": "TimelinesPluginStart", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/timelines/server/types.ts", + "lineNumber": 4 + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.PLUGIN_ID", + "type": "string", + "label": "PLUGIN_ID", + "description": [], + "source": { + "path": "x-pack/plugins/timelines/common/index.ts", + "lineNumber": 1 + }, + "signature": [ + "\"timelines\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PLUGIN_NAME", + "type": "string", + "label": "PLUGIN_NAME", + "description": [], + "source": { + "path": "x-pack/plugins/timelines/common/index.ts", + "lineNumber": 2 + }, + "signature": [ + "\"timelines\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx new file mode 100644 index 000000000000..cb16e39419a4 --- /dev/null +++ b/api_docs/timelines.mdx @@ -0,0 +1,31 @@ +--- +id: kibTimelinesPluginApi +slug: /kibana-dev-docs/timelinesPluginApi +title: timelines +image: https://source.unsplash.com/400x175/?github +summary: API docs for the timelines plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import timelinesObj from './timelines.json'; + +## Client + +### Setup + + +## Server + +### Setup + + +### Start + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/triggers_actions_ui.json b/api_docs/triggers_actions_ui.json index 245ead8a4d0e..0b52bf674c1d 100644 --- a/api_docs/triggers_actions_ui.json +++ b/api_docs/triggers_actions_ui.json @@ -84,6 +84,7 @@ "description": [], "children": [ { + "id": "def-public.Plugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -104,6 +105,7 @@ } }, { + "id": "def-public.Plugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, @@ -363,6 +365,7 @@ "type": "Function", "children": [ { + "id": "def-public.getFields.$1", "type": "Object", "label": "http", "isRequired": true, @@ -382,6 +385,7 @@ } }, { + "id": "def-public.getFields.$2", "type": "Array", "label": "indexes", "isRequired": true, @@ -421,6 +425,7 @@ "type": "Function", "children": [ { + "id": "def-public.getIndexOptions.$1", "type": "Object", "label": "http", "isRequired": true, @@ -440,6 +445,7 @@ } }, { + "id": "def-public.getIndexOptions.$2", "type": "string", "label": "pattern", "isRequired": true, @@ -453,6 +459,7 @@ } }, { + "id": "def-public.getIndexOptions.$3", "type": "Array", "label": "indexPatternsParam", "isRequired": true, @@ -567,6 +574,7 @@ "type": "Function", "children": [ { + "id": "def-public.getTimeFieldOptions.$1", "type": "Array", "label": "fields", "isRequired": true, @@ -598,6 +606,7 @@ "type": "Function", "children": [ { + "id": "def-public.getTimeOptions.$1", "type": "number", "label": "unitSize", "isRequired": true, @@ -650,6 +659,7 @@ "description": [], "children": [ { + "id": "def-public.getTimeUnitLabel.$1", "type": "Enum", "label": "timeUnit", "isRequired": true, @@ -669,6 +679,7 @@ } }, { + "id": "def-public.getTimeUnitLabel.$2", "type": "string", "label": "timeValue", "isRequired": true, @@ -733,7 +744,7 @@ "description": [], "children": [ { - "id": "def-public.loadActionTypes.{-http }", + "id": "def-public.loadActionTypes.$1.http", "type": "Object", "label": "{ http }", "tags": [], @@ -741,7 +752,7 @@ "children": [ { "tags": [], - "id": "def-public.loadActionTypes.{-http }.http", + "id": "def-public.loadActionTypes.$1.http.http", "type": "Object", "label": "http", "description": [], @@ -1039,13 +1050,7 @@ "lineNumber": 47 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "SavedObjectAttributes" ] } ], @@ -1080,7 +1085,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 222 + "lineNumber": 234 } }, { @@ -1091,7 +1096,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 223 + "lineNumber": 235 } }, { @@ -1102,7 +1107,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 224 + "lineNumber": 236 } }, { @@ -1113,7 +1118,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 225 + "lineNumber": 237 }, "signature": [ "string | ((docLinks: ", @@ -1135,7 +1140,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 226 + "lineNumber": 238 }, "signature": [ "(alertParams: Params) => ", @@ -1156,7 +1161,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 227 + "lineNumber": 239 }, "signature": [ "React.FunctionComponent | React.LazyExoticComponent(property: Key, value: Params[Key] | undefined) => void" @@ -1291,10 +1296,10 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 209 + "lineNumber": 221 }, "signature": [ - "(key: Prop, value: Pick<", + "(key: Prop, value: Pick<", { "pluginId": "alerting", "scope": "common", @@ -1302,7 +1307,7 @@ "section": "def-common.Alert", "text": "Alert" }, - ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void" + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void" ] }, { @@ -1313,7 +1318,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 213 + "lineNumber": 225 }, "signature": [ { @@ -1333,7 +1338,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 214 + "lineNumber": 226 } }, { @@ -1344,7 +1349,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 215 + "lineNumber": 227 }, "signature": [ { @@ -1365,7 +1370,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 216 + "lineNumber": 228 }, "signature": [ "MetaData | undefined" @@ -1379,7 +1384,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 217 + "lineNumber": 229 }, "signature": [ { @@ -1399,7 +1404,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 218 + "lineNumber": 230 }, "signature": [ { @@ -1414,7 +1419,7 @@ ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 199 + "lineNumber": 211 }, "initialIsOpen": false }, @@ -1541,7 +1546,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 235 + "lineNumber": 247 }, "signature": [ "any" @@ -1550,7 +1555,7 @@ ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 234 + "lineNumber": 246 }, "initialIsOpen": false }, @@ -1748,21 +1753,9 @@ }, "signature": [ "Pick<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TypeRegistry", - "text": "TypeRegistry" - }, + "TypeRegistry", "<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ActionTypeModel", - "text": "ActionTypeModel" - }, + "ActionTypeModel", ">, \"get\" | \"register\" | \"list\" | \"has\">" ] }, @@ -1778,13 +1771,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TypeRegistry", - "text": "TypeRegistry" - }, + "TypeRegistry", "<", { "pluginId": "triggersActionsUi", @@ -1874,7 +1861,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 116 + "lineNumber": 128 }, "signature": [ "Record" @@ -1883,7 +1870,7 @@ ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 115 + "lineNumber": 127 }, "initialIsOpen": false } @@ -1909,7 +1896,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 67 + "lineNumber": 79 }, "initialIsOpen": false }, @@ -1947,7 +1934,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 148 + "lineNumber": 160 }, "signature": [ "PreConfiguredActionConnector", @@ -1995,7 +1982,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 52 + "lineNumber": 64 }, "signature": [ "{ get: (id: string) => ActionTypeModel; register: (objectType: ActionTypeModel) => void; list: () => ActionTypeModel[]; has: (id: string) => boolean; }" @@ -2010,7 +1997,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 166 + "lineNumber": 178 }, "signature": [ "AsActionVariables<\"params\" | \"state\"> & Partial>" @@ -2025,10 +2012,10 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 34 + "lineNumber": 40 }, "signature": [ - "{ enabled: boolean; id: string; name: string; params: Record; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: ", + "{ enabled: boolean; id: string; name: string; params: Record; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: ", { "pluginId": "alerting", "scope": "common", @@ -2071,7 +2058,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 56 + "lineNumber": 68 }, "signature": [ "{ get: (id: string) => AlertTypeModel>; register: (objectType: AlertTypeModel>) => void; list: () => AlertTypeModel>[]; has: (id: string) => boolean; }" @@ -2505,13 +2492,13 @@ "tags": [], "children": [ { - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN]", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN].text", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.text", "type": "string", "label": "text", "description": [], @@ -2522,7 +2509,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN].value", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.value", "type": "Enum", "label": "value", "description": [], @@ -2542,7 +2529,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN].requiredValues", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.requiredValues", "type": "number", "label": "requiredValues", "description": [], @@ -2560,13 +2547,13 @@ } }, { - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN_OR_EQUALS]", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN_OR_EQUALS].text", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.text", "type": "string", "label": "text", "description": [], @@ -2577,7 +2564,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN_OR_EQUALS].value", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.value", "type": "Enum", "label": "value", "description": [], @@ -2597,7 +2584,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.GREATER_THAN_OR_EQUALS].requiredValues", + "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.requiredValues", "type": "number", "label": "requiredValues", "description": [], @@ -2615,13 +2602,13 @@ } }, { - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN]", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN].text", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.text", "type": "string", "label": "text", "description": [], @@ -2632,7 +2619,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN].value", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.value", "type": "Enum", "label": "value", "description": [], @@ -2652,7 +2639,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN].requiredValues", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.requiredValues", "type": "number", "label": "requiredValues", "description": [], @@ -2670,13 +2657,13 @@ } }, { - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN_OR_EQUALS]", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN_OR_EQUALS].text", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.text", "type": "string", "label": "text", "description": [], @@ -2687,7 +2674,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN_OR_EQUALS].value", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.value", "type": "Enum", "label": "value", "description": [], @@ -2707,7 +2694,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.LESS_THAN_OR_EQUALS].requiredValues", + "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.requiredValues", "type": "number", "label": "requiredValues", "description": [], @@ -2725,13 +2712,13 @@ } }, { - "id": "def-public.builtInComparators.[COMPARATORS.BETWEEN]", + "id": "def-public.builtInComparators.COMPARATORS.BETWEEN", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.BETWEEN].text", + "id": "def-public.builtInComparators.COMPARATORS.BETWEEN.text", "type": "string", "label": "text", "description": [], @@ -2742,7 +2729,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.BETWEEN].value", + "id": "def-public.builtInComparators.COMPARATORS.BETWEEN.value", "type": "Enum", "label": "value", "description": [], @@ -2762,7 +2749,7 @@ }, { "tags": [], - "id": "def-public.builtInComparators.[COMPARATORS.BETWEEN].requiredValues", + "id": "def-public.builtInComparators.COMPARATORS.BETWEEN.requiredValues", "type": "number", "label": "requiredValues", "description": [], @@ -2983,21 +2970,9 @@ "lineNumber": 42 }, "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TypeRegistry", - "text": "TypeRegistry" - }, + "TypeRegistry", "<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ActionTypeModel", - "text": "ActionTypeModel" - }, + "ActionTypeModel", ">" ] }, @@ -3012,13 +2987,7 @@ "lineNumber": 43 }, "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TypeRegistry", - "text": "TypeRegistry" - }, + "TypeRegistry", "<", { "pluginId": "triggersActionsUi", @@ -3056,21 +3025,9 @@ "lineNumber": 47 }, "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TypeRegistry", - "text": "TypeRegistry" - }, + "TypeRegistry", "<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ActionTypeModel", - "text": "ActionTypeModel" - }, + "ActionTypeModel", ">" ] }, @@ -3085,13 +3042,7 @@ "lineNumber": 48 }, "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TypeRegistry", - "text": "TypeRegistry" - }, + "TypeRegistry", "<", { "pluginId": "triggersActionsUi", @@ -3115,21 +3066,9 @@ }, "signature": [ "(props: Pick<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ConnectorAddFlyoutProps", - "text": "ConnectorAddFlyoutProps" - }, + "ConnectorAddFlyoutProps", ", \"onClose\" | \"consumer\" | \"actionTypes\" | \"onTestConnector\" | \"reloadConnectors\">) => React.ReactElement<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ConnectorAddFlyoutProps", - "text": "ConnectorAddFlyoutProps" - }, + "ConnectorAddFlyoutProps", ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] }, @@ -3145,21 +3084,9 @@ }, "signature": [ "(props: Pick<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ConnectorEditFlyoutProps", - "text": "ConnectorEditFlyoutProps" - }, + "ConnectorEditFlyoutProps", ", \"onClose\" | \"consumer\" | \"reloadConnectors\" | \"initialConnector\" | \"tab\">) => React.ReactElement<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ConnectorEditFlyoutProps", - "text": "ConnectorEditFlyoutProps" - }, + "ConnectorEditFlyoutProps", ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] }, @@ -3175,21 +3102,9 @@ }, "signature": [ "(props: Pick<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AlertAddProps", - "text": "AlertAddProps" - }, + "AlertAddProps", ">, \"onClose\" | \"metadata\" | \"onSave\" | \"alertTypeId\" | \"consumer\" | \"canChangeTrigger\" | \"initialValues\" | \"reloadAlerts\">) => React.ReactElement<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AlertAddProps", - "text": "AlertAddProps" - }, + "AlertAddProps", ">, string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] }, @@ -3205,21 +3120,9 @@ }, "signature": [ "(props: Pick<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AlertEditProps", - "text": "AlertEditProps" - }, + "AlertEditProps", ">, \"onClose\" | \"metadata\" | \"onSave\" | \"reloadAlerts\" | \"initialAlert\">) => React.ReactElement<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AlertEditProps", - "text": "AlertEditProps" - }, + "AlertEditProps", ">, string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] } @@ -3245,6 +3148,7 @@ "description": [], "children": [ { + "id": "def-server.validateCoreQueryBody.$1", "type": "Unknown", "label": "anyParams", "isRequired": true, @@ -3276,6 +3180,7 @@ "description": [], "children": [ { + "id": "def-server.validateTimeWindowUnits.$1", "type": "string", "label": "timeWindowUnit", "isRequired": true, @@ -3565,13 +3470,7 @@ }, "signature": [ "{ timeSeriesQuery: typeof ", - { - "pluginId": "triggersActionsUi", - "scope": "server", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-server.timeSeriesQuery", - "text": "timeSeriesQuery" - }, + "timeSeriesQuery", "; }" ] } diff --git a/api_docs/ui_actions.json b/api_docs/ui_actions.json index ff6ec01cda45..bf6caf81ca07 100644 --- a/api_docs/ui_actions.json +++ b/api_docs/ui_actions.json @@ -71,13 +71,7 @@ "lineNumber": 27 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.UiActionsExecutionService", - "text": "UiActionsExecutionService" - } + "UiActionsExecutionService" ] }, { @@ -91,13 +85,7 @@ "lineNumber": 28 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.TriggerRegistry", - "text": "TriggerRegistry" - } + "TriggerRegistry" ] }, { @@ -111,13 +99,7 @@ "lineNumber": 29 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionRegistry", - "text": "ActionRegistry" - } + "ActionRegistry" ] }, { @@ -131,13 +113,7 @@ "lineNumber": 30 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.TriggerToActionsRegistry", - "text": "TriggerToActionsRegistry" - } + "TriggerToActionsRegistry" ] }, { @@ -150,6 +126,7 @@ "description": [], "children": [ { + "id": "def-public.UiActionsService.Unnamed.$1", "type": "Object", "label": "{\n triggers = new Map(),\n actions = new Map(),\n triggerToActions = new Map(),\n }", "isRequired": true, @@ -181,6 +158,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.registerTrigger.$1", "type": "Object", "label": "trigger", "isRequired": true, @@ -225,6 +203,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.getTrigger.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -240,13 +219,7 @@ ], "signature": [ "(triggerId: string) => ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.TriggerContract", - "text": "TriggerContract" - }, + "TriggerContract", "" ], "description": [], @@ -263,6 +236,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.registerAction.$1", "type": "Uncategorized", "label": "definition", "isRequired": true, @@ -294,13 +268,7 @@ "text": "Action" }, "<", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionContext", - "text": "ActionContext" - }, + "ActionContext", ">" ], "description": [], @@ -317,6 +285,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.unregisterAction.$1", "type": "string", "label": "actionId", "isRequired": true, @@ -347,6 +316,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.hasAction.$1", "type": "string", "label": "actionId", "isRequired": true, @@ -377,6 +347,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.attachAction.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -390,6 +361,7 @@ } }, { + "id": "def-public.UiActionsService.attachAction.$2", "type": "string", "label": "actionId", "isRequired": true, @@ -420,6 +392,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.detachAction.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -433,6 +406,7 @@ } }, { + "id": "def-public.UiActionsService.detachAction.$2", "type": "string", "label": "actionId", "isRequired": true, @@ -463,6 +437,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.addTriggerAction.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -476,6 +451,7 @@ } }, { + "id": "def-public.UiActionsService.addTriggerAction.$2", "type": "Object", "label": "action", "isRequired": true, @@ -523,6 +499,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.getAction.$1", "type": "string", "label": "id", "isRequired": true, @@ -554,13 +531,7 @@ "text": "Action" }, "<", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionContext", - "text": "ActionContext" - }, + "ActionContext", ">" ], "description": [], @@ -577,6 +548,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.getTriggerActions.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -615,6 +587,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.getTriggerCompatibleActions.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -628,6 +601,7 @@ } }, { + "id": "def-public.UiActionsService.getTriggerCompatibleActions.$2", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -666,6 +640,7 @@ "type": "Function", "children": [ { + "id": "def-public.UiActionsService.executeTriggerActions.$1", "type": "string", "label": "triggerId", "isRequired": true, @@ -679,6 +654,7 @@ } }, { + "id": "def-public.UiActionsService.executeTriggerActions.$2", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -774,17 +750,12 @@ ], "children": [ { + "id": "def-public.buildContextMenuForActions.$1", "type": "Object", "label": "{\n actions,\n title = defaultTitle,\n closeMenu = () => {},\n}", "isRequired": true, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.BuildContextMenuParams", - "text": "BuildContextMenuParams" - } + "BuildContextMenuParams" ], "description": [], "source": { @@ -827,6 +798,7 @@ "description": [], "children": [ { + "id": "def-public.createAction.$1", "type": "Object", "label": "action", "isRequired": true, @@ -952,6 +924,7 @@ ], "children": [ { + "id": "def-public.Action.getIconType.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -999,6 +972,7 @@ ], "children": [ { + "id": "def-public.Action.getDisplayName.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -1077,6 +1051,7 @@ ], "children": [ { + "id": "def-public.Action.isCompatible.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -1124,6 +1099,7 @@ ], "children": [ { + "id": "def-public.Action.execute.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -1171,6 +1147,7 @@ ], "children": [ { + "id": "def-public.Action.getHref.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -1218,6 +1195,7 @@ ], "children": [ { + "id": "def-public.Action.shouldAutoExecute.$1", "type": "CompoundType", "label": "context", "isRequired": true, @@ -1316,13 +1294,7 @@ "label": "isCompatible", "signature": [ "((context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", ") => Promise) | undefined" ], "description": [ @@ -1330,17 +1302,12 @@ ], "children": [ { + "id": "def-public.ActionDefinition.isCompatible.$1", "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", "" ], "description": [], @@ -1363,13 +1330,7 @@ "label": "execute", "signature": [ "(context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", ") => Promise" ], "description": [ @@ -1377,17 +1338,12 @@ ], "children": [ { + "id": "def-public.ActionDefinition.execute.$1", "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", "" ], "description": [], @@ -1410,13 +1366,7 @@ "label": "shouldAutoExecute", "signature": [ "((context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", ") => Promise) | undefined" ], "description": [ @@ -1424,17 +1374,12 @@ ], "children": [ { + "id": "def-public.ActionDefinition.shouldAutoExecute.$1", "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", "" ], "description": [], @@ -1457,13 +1402,7 @@ "label": "getHref", "signature": [ "((context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", ") => Promise) | undefined" ], "description": [ @@ -1471,17 +1410,12 @@ ], "children": [ { + "id": "def-public.ActionDefinition.getHref.$1", "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionDefinitionContext", - "text": "ActionDefinitionContext" - }, + "ActionDefinitionContext", "" ], "description": [], @@ -1623,6 +1557,7 @@ ], "children": [ { + "id": "def-public.Presentable.getIconType.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -1655,6 +1590,7 @@ ], "children": [ { + "id": "def-public.Presentable.getDisplayName.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -1687,6 +1623,7 @@ ], "children": [ { + "id": "def-public.Presentable.getDisplayNameTooltip.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -1719,6 +1656,7 @@ ], "children": [ { + "id": "def-public.Presentable.getHref.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -1751,6 +1689,7 @@ ], "children": [ { + "id": "def-public.Presentable.isCompatible.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -1930,13 +1869,7 @@ "lineNumber": 17 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.TriggerRegistry", - "text": "TriggerRegistry" - }, + "TriggerRegistry", " | undefined" ] }, @@ -1951,13 +1884,7 @@ "lineNumber": 18 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionRegistry", - "text": "ActionRegistry" - }, + "ActionRegistry", " | undefined" ] }, @@ -1974,13 +1901,7 @@ "lineNumber": 23 }, "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.TriggerToActionsRegistry", - "text": "TriggerToActionsRegistry" - }, + "TriggerToActionsRegistry", " | undefined" ] } diff --git a/api_docs/ui_actions_enhanced.json b/api_docs/ui_actions_enhanced.json index 0a31b02f0fd9..5f4f76e574b8 100644 --- a/api_docs/ui_actions_enhanced.json +++ b/api_docs/ui_actions_enhanced.json @@ -71,6 +71,7 @@ "description": [], "children": [ { + "id": "def-public.AbstractActionStorage.read.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -109,6 +110,7 @@ "description": [], "children": [ { + "id": "def-public.AbstractActionStorage.create.$1", "type": "Object", "label": "event", "isRequired": true, @@ -153,6 +155,7 @@ "description": [], "children": [ { + "id": "def-public.AbstractActionStorage.update.$1", "type": "Object", "label": "event", "isRequired": true, @@ -189,6 +192,7 @@ "description": [], "children": [ { + "id": "def-public.AbstractActionStorage.remove.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -298,6 +302,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.Unnamed.$1", "type": "Object", "label": "def", "isRequired": true, @@ -318,17 +323,12 @@ } }, { + "id": "def-public.ActionFactory.Unnamed.$2", "type": "Object", "label": "deps", "isRequired": true, "signature": [ - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.ActionFactoryDeps", - "text": "ActionFactoryDeps" - } + "ActionFactoryDeps" ], "description": [], "source": { @@ -549,6 +549,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.getIconType.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -579,6 +580,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.getDisplayName.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -609,6 +611,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.getDisplayNameTooltip.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -639,6 +642,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.isCompatible.$1", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -703,6 +707,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.create.$1", "type": "Object", "label": "serializedAction", "isRequired": true, @@ -765,6 +770,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.telemetry.$1", "type": "Object", "label": "state", "isRequired": true, @@ -784,6 +790,7 @@ } }, { + "id": "def-public.ActionFactory.telemetry.$2", "type": "Object", "label": "telemetryData", "isRequired": true, @@ -826,18 +833,13 @@ "text": "SerializedEvent" }, "; references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]; }" ], "description": [], "children": [ { + "id": "def-public.ActionFactory.extract.$1", "type": "Object", "label": "state", "isRequired": true, @@ -878,13 +880,7 @@ "text": "SerializedEvent" }, ", references: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]) => ", { "pluginId": "uiActionsEnhanced", @@ -897,6 +893,7 @@ "description": [], "children": [ { + "id": "def-public.ActionFactory.inject.$1", "type": "Object", "label": "state", "isRequired": true, @@ -916,17 +913,12 @@ } }, { + "id": "def-public.ActionFactory.inject.$2", "type": "Array", "label": "references", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, + "SavedObjectReference", "[]" ], "description": [], @@ -1005,13 +997,7 @@ "signature": [ "BehaviorSubject", "<", - { - "pluginId": "licensing", - "scope": "common", - "docId": "kibLicensingPluginApi", - "section": "def-common.ILicense", - "text": "ILicense" - }, + "ILicense", " | undefined>" ] }, @@ -1025,6 +1011,7 @@ "description": [], "children": [ { + "id": "def-public.AdvancedUiActionsPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, @@ -1066,13 +1053,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.StartDependencies", - "text": "StartDependencies" - }, + "StartDependencies", ", unknown>, { embeddable, uiActions, licensing }: SetupDependencies) => ", { "pluginId": "uiActionsEnhanced", @@ -1085,6 +1066,7 @@ "description": [], "children": [ { + "id": "def-public.AdvancedUiActionsPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1097,13 +1079,7 @@ "text": "CoreSetup" }, "<", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.StartDependencies", - "text": "StartDependencies" - }, + "StartDependencies", ", unknown>" ], "description": [], @@ -1113,6 +1089,7 @@ } }, { + "id": "def-public.AdvancedUiActionsPublicPlugin.setup.$2", "type": "Object", "label": "{ embeddable, uiActions, licensing }", "isRequired": true, @@ -1147,13 +1124,7 @@ "text": "CoreStart" }, ", { uiActions, licensing }: ", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.StartDependencies", - "text": "StartDependencies" - }, + "StartDependencies", ") => ", { "pluginId": "uiActionsEnhanced", @@ -1166,6 +1137,7 @@ "description": [], "children": [ { + "id": "def-public.AdvancedUiActionsPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, @@ -1185,17 +1157,12 @@ } }, { + "id": "def-public.AdvancedUiActionsPublicPlugin.start.$2", "type": "Object", "label": "{ uiActions, licensing }", "isRequired": true, "signature": [ - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.StartDependencies", - "text": "StartDependencies" - } + "StartDependencies" ], "description": [], "source": { @@ -1273,29 +1240,11 @@ "text": "ReduxLikeStateContainer" }, "<", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.State", - "text": "State" - }, + "State", ", ", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.Transitions", - "text": "Transitions" - }, + "Transitions", ", ", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.Selectors", - "text": "Selectors" - }, + "Selectors", ">" ] }, @@ -1309,6 +1258,7 @@ "description": [], "children": [ { + "id": "def-public.DynamicActionManager.Unnamed.$1", "type": "Object", "label": "params", "isRequired": true, @@ -1352,6 +1302,7 @@ "description": [], "children": [ { + "id": "def-public.DynamicActionManager.getEvent.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -1384,6 +1335,7 @@ ], "children": [ { + "id": "def-public.DynamicActionManager.generateActionId.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -1422,6 +1374,7 @@ "description": [], "children": [ { + "id": "def-public.DynamicActionManager.reviveAction.$1", "type": "Object", "label": "event", "isRequired": true, @@ -1466,6 +1419,7 @@ "description": [], "children": [ { + "id": "def-public.DynamicActionManager.killAction.$1", "type": "Object", "label": "{ eventId, triggers }", "isRequired": true, @@ -1513,13 +1467,7 @@ "text": "StateContainer" }, "<", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.State", - "text": "State" - }, + "State", ", object, {}>" ] }, @@ -1587,6 +1535,7 @@ ], "children": [ { + "id": "def-public.DynamicActionManager.createEvent.$1", "type": "Object", "label": "action", "isRequired": true, @@ -1617,6 +1566,7 @@ } }, { + "id": "def-public.DynamicActionManager.createEvent.$2", "type": "Array", "label": "triggers", "isRequired": true, @@ -1667,6 +1617,7 @@ ], "children": [ { + "id": "def-public.DynamicActionManager.updateEvent.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -1682,6 +1633,7 @@ } }, { + "id": "def-public.DynamicActionManager.updateEvent.$2", "type": "Object", "label": "action", "isRequired": true, @@ -1712,6 +1664,7 @@ } }, { + "id": "def-public.DynamicActionManager.updateEvent.$3", "type": "Array", "label": "triggers", "isRequired": true, @@ -1746,6 +1699,7 @@ ], "children": [ { + "id": "def-public.DynamicActionManager.deleteEvent.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -1780,6 +1734,7 @@ ], "children": [ { + "id": "def-public.DynamicActionManager.deleteEvents.$1", "type": "Array", "label": "eventIds", "isRequired": true, @@ -1845,6 +1800,7 @@ "description": [], "children": [ { + "id": "def-public.MemoryActionStorage.Unnamed.$1", "type": "Object", "label": "events", "isRequired": true, @@ -1923,6 +1879,7 @@ "description": [], "children": [ { + "id": "def-public.MemoryActionStorage.create.$1", "type": "Object", "label": "event", "isRequired": true, @@ -1967,6 +1924,7 @@ "description": [], "children": [ { + "id": "def-public.MemoryActionStorage.update.$1", "type": "Object", "label": "event", "isRequired": true, @@ -2003,6 +1961,7 @@ "description": [], "children": [ { + "id": "def-public.MemoryActionStorage.remove.$1", "type": "string", "label": "eventId", "isRequired": true, @@ -2037,18 +1996,13 @@ "type": "Function", "children": [ { + "id": "def-public.ActionWizard.$1", "type": "CompoundType", "label": "{\n currentActionFactory,\n actionFactories,\n onActionFactoryChange,\n onConfigChange,\n config,\n context,\n onSelectedTriggersChange,\n getTriggerInfo,\n triggers,\n triggerPickerDocsLink,\n}", "isRequired": true, "signature": [ "React.PropsWithChildren<", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.ActionWizardProps", - "text": "ActionWizardProps" - }, + "ActionWizardProps", "<", { "pluginId": "uiActionsEnhanced", @@ -2099,6 +2053,7 @@ "description": [], "children": [ { + "id": "def-public.compile.$1", "type": "string", "label": "urlTemplate", "isRequired": true, @@ -2112,6 +2067,7 @@ } }, { + "id": "def-public.compile.$2", "type": "Uncategorized", "label": "context", "isRequired": true, @@ -2125,6 +2081,7 @@ } }, { + "id": "def-public.compile.$3", "type": "boolean", "label": "doEncode", "isRequired": true, @@ -2163,6 +2120,7 @@ "description": [], "children": [ { + "id": "def-public.globalScopeProvider.$1", "type": "Object", "label": "{\n core,\n}", "isRequired": true, @@ -2189,18 +2147,13 @@ "type": "Function", "children": [ { + "id": "def-public.UrlDrilldownCollectConfig.$1", "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ "React.PropsWithChildren<", - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.UrlDrilldownCollectConfigProps", - "text": "UrlDrilldownCollectConfigProps" - }, + "UrlDrilldownCollectConfigProps", ">" ], "description": [], @@ -2235,6 +2188,7 @@ "description": [], "children": [ { + "id": "def-public.validateUrl.$1", "type": "string", "label": "url", "isRequired": true, @@ -2274,6 +2228,7 @@ "description": [], "children": [ { + "id": "def-public.validateUrlTemplate.$1", "type": "Object", "label": "urlTemplate", "isRequired": true, @@ -2287,6 +2242,7 @@ } }, { + "id": "def-public.validateUrlTemplate.$2", "type": "Object", "label": "scope", "isRequired": true, @@ -2456,6 +2412,7 @@ ], "children": [ { + "id": "def-public.ActionFactoryDefinition.create.$1", "type": "Object", "label": "serializedAction", "isRequired": true, @@ -2764,6 +2721,7 @@ ], "children": [ { + "id": "def-public.DrilldownDefinition.isCompatible.$1", "type": "Uncategorized", "label": "config", "isRequired": true, @@ -2777,6 +2735,7 @@ } }, { + "id": "def-public.DrilldownDefinition.isCompatible.$2", "type": "CompoundType", "label": "context", "isRequired": true, @@ -2825,6 +2784,7 @@ ], "children": [ { + "id": "def-public.DrilldownDefinition.execute.$1", "type": "Uncategorized", "label": "config", "isRequired": true, @@ -2840,6 +2800,7 @@ } }, { + "id": "def-public.DrilldownDefinition.execute.$2", "type": "CompoundType", "label": "context", "isRequired": true, @@ -2890,6 +2851,7 @@ ], "children": [ { + "id": "def-public.DrilldownDefinition.getHref.$1", "type": "Uncategorized", "label": "config", "isRequired": true, @@ -2903,6 +2865,7 @@ } }, { + "id": "def-public.DrilldownDefinition.getHref.$2", "type": "CompoundType", "label": "context", "isRequired": true, @@ -2974,13 +2937,7 @@ "lineNumber": 33 }, "signature": [ - { - "pluginId": "uiActionsEnhanced", - "scope": "public", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-public.ActionStorage", - "text": "ActionStorage" - } + "ActionStorage" ] }, { @@ -3370,13 +3327,7 @@ "lineNumber": 26 }, "signature": [ - { - "pluginId": "uiActionsEnhanced", - "scope": "server", - "docId": "kibUiActionsEnhancedPluginApi", - "section": "def-server.ActionFactoryRegistry", - "text": "ActionFactoryRegistry" - } + "ActionFactoryRegistry" ] }, { @@ -3429,6 +3380,7 @@ "description": [], "children": [ { + "id": "def-server.AdvancedUiActionsServerPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -3449,6 +3401,7 @@ } }, { + "id": "def-server.AdvancedUiActionsServerPlugin.setup.$2", "type": "Object", "label": "{ embeddable }", "isRequired": true, @@ -3506,6 +3459,7 @@ "type": "Function", "children": [ { + "id": "def-server.AdvancedUiActionsServerPlugin.registerActionFactory.$1", "type": "Object", "label": "definition", "isRequired": true, diff --git a/api_docs/uptime.json b/api_docs/uptime.json index f7652de96a49..41ebbb21b337 100644 --- a/api_docs/uptime.json +++ b/api_docs/uptime.json @@ -16,17 +16,12 @@ "type": "Function", "children": [ { + "id": "def-server.initServerWithKibana.$1", "type": "Object", "label": "server", "isRequired": true, "signature": [ - { - "pluginId": "uptime", - "scope": "server", - "docId": "kibUptimePluginApi", - "section": "def-server.UptimeCoreSetup", - "text": "UptimeCoreSetup" - } + "UptimeCoreSetup" ], "description": [], "source": { @@ -35,17 +30,12 @@ } }, { + "id": "def-server.initServerWithKibana.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ - { - "pluginId": "uptime", - "scope": "server", - "docId": "kibUptimePluginApi", - "section": "def-server.UptimeCorePlugins", - "text": "UptimeCorePlugins" - } + "UptimeCorePlugins" ], "description": [], "source": { @@ -103,13 +93,7 @@ }, "signature": [ "(options: ", - { - "pluginId": "uptime", - "scope": "server", - "docId": "kibUptimePluginApi", - "section": "def-server.KibanaRouteOptions", - "text": "KibanaRouteOptions" - }, + "KibanaRouteOptions", ") => void" ] } diff --git a/api_docs/url_forwarding.json b/api_docs/url_forwarding.json index ddf7485c8024..debc212f68ae 100644 --- a/api_docs/url_forwarding.json +++ b/api_docs/url_forwarding.json @@ -35,6 +35,7 @@ "description": [], "children": [ { + "id": "def-public.UrlForwardingPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, @@ -84,13 +85,7 @@ "text": "CoreStart" }, ", { kibanaLegacy }: { kibanaLegacy: { dashboardConfig: ", - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.DashboardConfig", - "text": "DashboardConfig" - }, + "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }; }) => { navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ", { "pluginId": "urlForwarding", @@ -104,6 +99,7 @@ "description": [], "children": [ { + "id": "def-public.UrlForwardingPlugin.start.$1", "type": "Object", "label": "{ application, http: { basePath }, uiSettings }", "isRequired": true, @@ -123,7 +119,7 @@ } }, { - "id": "def-public.UrlForwardingPlugin.start.{-kibanaLegacy }", + "id": "def-public.UrlForwardingPlugin.start.$2.kibanaLegacy", "type": "Object", "label": "{ kibanaLegacy }", "tags": [], @@ -131,7 +127,7 @@ "children": [ { "tags": [], - "id": "def-public.UrlForwardingPlugin.start.{-kibanaLegacy }.kibanaLegacy", + "id": "def-public.UrlForwardingPlugin.start.$2.kibanaLegacy.kibanaLegacy", "type": "Object", "label": "kibanaLegacy", "description": [], @@ -141,13 +137,7 @@ }, "signature": [ "{ dashboardConfig: ", - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.DashboardConfig", - "text": "DashboardConfig" - }, + "DashboardConfig", "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" ] } diff --git a/api_docs/usage_collection.json b/api_docs/usage_collection.json index cd838c470c59..a10e2e73f009 100644 --- a/api_docs/usage_collection.json +++ b/api_docs/usage_collection.json @@ -8,18 +8,13 @@ "type": "Function", "children": [ { + "id": "def-public.TrackApplicationView.$1", "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ "React.PropsWithChildren<", - { - "pluginId": "usageCollection", - "scope": "public", - "docId": "kibUsageCollectionPluginApi", - "section": "def-public.TrackApplicationViewProps", - "text": "TrackApplicationViewProps" - }, + "TrackApplicationViewProps", ">" ], "description": [], @@ -177,13 +172,7 @@ "lineNumber": 144 }, "signature": [ - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorOptionsFetchExtendedContext", - "text": "CollectorOptionsFetchExtendedContext" - }, + "CollectorOptionsFetchExtendedContext", "" ] }, @@ -223,13 +212,7 @@ "lineNumber": 147 }, "signature": [ - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorFetchMethod", - "text": "CollectorFetchMethod" - }, + "CollectorFetchMethod", "" ] }, @@ -257,6 +240,7 @@ "description": [], "children": [ { + "id": "def-server.Collector.Unnamed.$1", "type": "Object", "label": "log", "isRequired": true, @@ -270,6 +254,7 @@ } }, { + "id": "def-server.Collector.Unnamed.$2", "type": "CompoundType", "label": "{\n type,\n init,\n fetch,\n isReady,\n extendFetchContext = {},\n ...options\n }", "isRequired": true, diff --git a/api_docs/vis_type_timeseries.json b/api_docs/vis_type_timeseries.json index 907ced500294..a3c2c605c8de 100644 --- a/api_docs/vis_type_timeseries.json +++ b/api_docs/vis_type_timeseries.json @@ -10,10 +10,97 @@ }, "server": { "classes": [], - "functions": [], + "functions": [ + { + "id": "def-server.isVisSeriesData", + "type": "Function", + "children": [ + { + "id": "def-server.isVisSeriesData.$1", + "type": "CompoundType", + "label": "data", + "isRequired": true, + "signature": [ + "TimeseriesVisData" + ], + "description": [], + "source": { + "path": "src/plugins/vis_type_timeseries/common/types.ts", + "lineNumber": 74 + } + } + ], + "signature": [ + "(data: ", + "TimeseriesVisData", + ") => data is ", + "SeriesData" + ], + "description": [], + "label": "isVisSeriesData", + "source": { + "path": "src/plugins/vis_type_timeseries/common/types.ts", + "lineNumber": 74 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.isVisTableData", + "type": "Function", + "children": [ + { + "id": "def-server.isVisTableData.$1", + "type": "CompoundType", + "label": "data", + "isRequired": true, + "signature": [ + "TimeseriesVisData" + ], + "description": [], + "source": { + "path": "src/plugins/vis_type_timeseries/common/types.ts", + "lineNumber": 71 + } + } + ], + "signature": [ + "(data: ", + "TimeseriesVisData", + ") => data is TableData" + ], + "description": [], + "label": "isVisTableData", + "source": { + "path": "src/plugins/vis_type_timeseries/common/types.ts", + "lineNumber": 71 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "id": "def-server.TimeseriesVisData", + "type": "Type", + "label": "TimeseriesVisData", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/vis_type_timeseries/common/types.ts", + "lineNumber": 36 + }, + "signature": [ + "SeriesData", + " | TableData" + ], + "initialIsOpen": false + } + ], "objects": [], "setup": { "id": "def-server.VisTypeTimeseriesSetup", @@ -30,17 +117,11 @@ "description": [], "source": { "path": "src/plugins/vis_type_timeseries/server/plugin.ts", - "lineNumber": 53 + "lineNumber": 55 }, "signature": [ "(requestContext: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.DataRequestHandlerContext", - "text": "DataRequestHandlerContext" - }, + "DataRequestHandlerContext", ", fakeRequest: ", { "pluginId": "core", @@ -50,20 +131,14 @@ "text": "KibanaRequest" }, ", options: any) => Promise<", - { - "pluginId": "visTypeTimeseries", - "scope": "common", - "docId": "kibVisTypeTimeseriesPluginApi", - "section": "def-common.TimeseriesVisData", - "text": "TimeseriesVisData" - }, + "TimeseriesVisData", ">" ] } ], "source": { "path": "src/plugins/vis_type_timeseries/server/plugin.ts", - "lineNumber": 52 + "lineNumber": 54 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index 156b2700a7f8..041d01196bad 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -16,3 +16,9 @@ import visTypeTimeseriesObj from './vis_type_timeseries.json'; ### Setup +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/visualizations.json b/api_docs/visualizations.json index b85d424a97bd..0635d17107ef 100644 --- a/api_docs/visualizations.json +++ b/api_docs/visualizations.json @@ -30,6 +30,7 @@ "description": [], "children": [ { + "id": "def-public.PersistedState.Unnamed.$1", "type": "Any", "label": "value", "isRequired": true, @@ -43,6 +44,7 @@ } }, { + "id": "def-public.PersistedState.Unnamed.$2", "type": "CompoundType", "label": "path", "isRequired": false, @@ -73,6 +75,7 @@ "description": [], "children": [ { + "id": "def-public.PersistedState.get.$1", "type": "CompoundType", "label": "key", "isRequired": false, @@ -86,6 +89,7 @@ } }, { + "id": "def-public.PersistedState.get.$2", "type": "Any", "label": "defaultValue", "isRequired": true, @@ -116,6 +120,7 @@ "description": [], "children": [ { + "id": "def-public.PersistedState.set.$1", "type": "Any", "label": "key", "isRequired": true, @@ -129,6 +134,7 @@ } }, { + "id": "def-public.PersistedState.set.$2", "type": "Any", "label": "value", "isRequired": true, @@ -159,6 +165,7 @@ "description": [], "children": [ { + "id": "def-public.PersistedState.setSilent.$1", "type": "Any", "label": "key", "isRequired": true, @@ -172,6 +179,7 @@ } }, { + "id": "def-public.PersistedState.setSilent.$2", "type": "Any", "label": "value", "isRequired": true, @@ -218,6 +226,7 @@ "description": [], "children": [ { + "id": "def-public.PersistedState.reset.$1", "type": "CompoundType", "label": "path", "isRequired": true, @@ -296,6 +305,7 @@ "description": [], "children": [ { + "id": "def-public.PersistedState.fromString.$1", "type": "string", "label": "input", "isRequired": true, @@ -351,13 +361,7 @@ "lineNumber": 74 }, "signature": [ - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.BaseVisType", - "text": "BaseVisType" - }, + "BaseVisType", "" ] }, @@ -453,6 +457,7 @@ "description": [], "children": [ { + "id": "def-public.Vis.Unnamed.$1", "type": "string", "label": "visType", "isRequired": true, @@ -466,6 +471,7 @@ } }, { + "id": "def-public.Vis.Unnamed.$2", "type": "Object", "label": "visState", "isRequired": true, @@ -535,6 +541,7 @@ "description": [], "children": [ { + "id": "def-public.Vis.setState.$1", "type": "Object", "label": "state", "isRequired": true, @@ -673,6 +680,7 @@ "type": "Function", "children": [ { + "id": "def-public.getVisSchemas.$1", "type": "Object", "label": "vis", "isRequired": true, @@ -693,6 +701,7 @@ } }, { + "id": "def-public.getVisSchemas.$2", "type": "Object", "label": "{ timeRange, timefilter }", "isRequired": true, @@ -768,6 +777,7 @@ "description": [], "children": [ { + "id": "def-public.updateOldState.$1", "type": "Unknown", "label": "oldState", "isRequired": true, @@ -794,6 +804,7 @@ "type": "Function", "children": [ { + "id": "def-public.VisualizationContainer.$1", "type": "Object", "label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n}", "isRequired": true, @@ -967,7 +978,7 @@ "children": [ { "tags": [], - "id": "def-public.ISchemas.[AggGroupNames.Buckets]", + "id": "def-public.ISchemas.AggGroupNames.Buckets", "type": "Array", "label": "[AggGroupNames.Buckets]", "description": [], @@ -988,7 +999,7 @@ }, { "tags": [], - "id": "def-public.ISchemas.[AggGroupNames.Metrics]", + "id": "def-public.ISchemas.AggGroupNames.Metrics", "type": "Array", "label": "[AggGroupNames.Metrics]", "description": [], @@ -1100,13 +1111,7 @@ }, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", @@ -1562,13 +1567,7 @@ }, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", @@ -1867,6 +1866,7 @@ "description": [], "children": [ { + "id": "def-public.VisEditorOptionsProps.setValue.$1", "type": "Uncategorized", "label": "paramName", "isRequired": true, @@ -1880,6 +1880,7 @@ } }, { + "id": "def-public.VisEditorOptionsProps.setValue.$2", "type": "Uncategorized", "label": "value", "isRequired": true, @@ -1910,6 +1911,7 @@ "description": [], "children": [ { + "id": "def-public.VisEditorOptionsProps.setValidity.$1", "type": "boolean", "label": "isValid", "isRequired": true, @@ -1940,6 +1942,7 @@ "description": [], "children": [ { + "id": "def-public.VisEditorOptionsProps.setTouched.$1", "type": "boolean", "label": "isTouched", "isRequired": true, @@ -2052,13 +2055,7 @@ }, "signature": [ "Pick<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.Timefilter", - "text": "Timefilter" - }, + "Timefilter", ", \"isTimeRangeSelectorEnabled\" | \"isAutoRefreshSelectorEnabled\" | \"isTimeTouched\" | \"getEnabledUpdated$\" | \"getTimeUpdate$\" | \"getRefreshIntervalUpdate$\" | \"getAutoRefreshFetch$\" | \"getFetch$\" | \"getTime\" | \"getAbsoluteTime\" | \"setTime\" | \"getRefreshInterval\" | \"setRefreshInterval\" | \"createFilter\" | \"getBounds\" | \"calculateBounds\" | \"getActiveBounds\" | \"enableTimeRangeSelector\" | \"disableTimeRangeSelector\" | \"enableAutoRefreshSelector\" | \"disableAutoRefreshSelector\" | \"getTimeDefaults\" | \"getRefreshIntervalDefaults\">" ] }, @@ -2244,13 +2241,7 @@ }, "signature": [ "{ [appName: string]: unknown; visualizations: ", - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.VisualizationsAppExtension", - "text": "VisualizationsAppExtension" - }, + "VisualizationsAppExtension", "; } | undefined" ] } @@ -2669,13 +2660,7 @@ }, "signature": [ "Partial<", - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.VisTypeOptions", - "text": "VisTypeOptions" - }, + "VisTypeOptions", "> | undefined" ] }, @@ -3434,13 +3419,7 @@ "text": "SavedObjectLoader" }, " & { findListItems: (search: string, sizeOrOptions?: number | ", - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.FindListItemsOptions", - "text": "FindListItemsOptions" - }, + "FindListItemsOptions", " | undefined) => any; }" ] }, @@ -3577,13 +3556,7 @@ }, "signature": [ "typeof ", - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.showNewVisModal", - "text": "showNewVisModal" - } + "showNewVisModal" ] }, { @@ -3630,13 +3603,7 @@ "text": "SavedObjectLoader" }, " & { findListItems: (search: string, sizeOrOptions?: number | ", - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.FindListItemsOptions", - "text": "FindListItemsOptions" - } + "FindListItemsOptions" ] } ], @@ -3725,13 +3692,7 @@ }, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", diff --git a/docs/developer/contributing/interpreting-ci-failures.asciidoc b/docs/developer/contributing/interpreting-ci-failures.asciidoc index 38609b2be5c8..1401c9699981 100644 --- a/docs/developer/contributing/interpreting-ci-failures.asciidoc +++ b/docs/developer/contributing/interpreting-ci-failures.asciidoc @@ -17,7 +17,7 @@ Clicking the link next to the check in the conversation tab of a pull request wi To view the results of a job execution in Jenkins, either click the link in the comment left by `@elasticmachine` or search for the `kibana-ci` check in the list at the bottom of the PR. This link will take you to the top-level page for the specific job execution that failed. -image::images/job_view.png[] +image::images/job_view.png[Jenkins job view showing a test failure] 1. *Git Changes:* the list of commits that were in this build which weren't in the previous build. For Pull Requests this list is calculated by comparing against the most recent Pull Request which was tested, it is not limited to build for this specific Pull Request, so it's not very useful. 2. *Test Results:* A link to the test results screen, and shortcuts to the failed tests. Functional tests capture and store the log output from each specific test, and make it visible at these links. For other test runners only the error message is visible and log output must be tracked down in the *Pipeline Steps*. @@ -29,6 +29,72 @@ image::images/job_view.png[] To view the logs for a failed specific ciGroup, jest, type checkers, linters, etc., click on the *Pipeline Steps* link in from the Job page. -image::images/pipeline_steps_view.png[] +image::images/pipeline_steps_view.png[Jenkins pipeline steps screenshot] -Scroll down the page until you find a failed step *(1)*, and then look up a few lines for the `Branch:` step to see which specific job this is. If this is the job you're looking for click the little terminal icon next to the failed step *(1)* to view the logs for that specific step in the Pipeline. \ No newline at end of file +Scroll down the page until you find a failed step *(1)*, and then look up a few lines for the `Branch:` step to see which specific job this is. If this is the job you're looking for click the little terminal icon next to the failed step *(1)* to view the logs for that specific step in the Pipeline. + +[discrete] +=== Debugging Functional UI Test Failures + +The logs in Pipeline Steps contain `Info` level logging. To debug Functional UI tests it's usually helpful to see the debug logging. You can go to the list of all tests including failures (1), or directly to the failures (2). + +image::images/test_results.png[Jenkisn build screenshot] + +Looking at the failure, we first look at the Error and stack trace. In the example below, this test failed to find an element within the timeout; + `Error: retry.try timeout: TimeoutError: Waiting for element to be located By(css selector, [data-test-subj="createSpace"])` + +We know the test file from the stack trace was on line 50 of `test/accessibility/apps/spaces.ts` (this test and the stack trace context is kibana/x-pack/ so the file is https://github.com/elastic/kibana/blob/master/x-pack/test/accessibility/apps/spaces.ts#L50). +The function to click on the element was called from a page object method in `test/functional/page_objects/space_selector_page.ts` https://github.com/elastic/kibana/blob/master/x-pack/test/functional/page_objects/space_selector_page.ts#L58 + + + [00:03:36] │ debg --- retry.try error: Waiting for element to be located By(css selector, [data-test-subj="createSpace"]) + [00:03:36] │ Wait timed out after 10020ms + [00:03:36] │ info Taking screenshot "/dev/shm/workspace/parallel/24/kibana/x-pack/test/functional/screenshots/failure/Kibana spaces page meets a11y validations a11y test for click on create space page.png" + [00:03:37] │ info Current URL is: http://localhost:61241/app/home#/ + [00:03:37] │ info Saving page source to: /dev/shm/workspace/parallel/24/kibana/x-pack/test/functional/failure_debug/html/Kibana spaces page meets a11y validations a11y test for click on create space page.html + [00:03:37] └- ✖ fail: Kibana spaces page meets a11y validations a11y test for click on create space page + [00:03:37] │ Error: retry.try timeout: TimeoutError: Waiting for element to be located By(css selector, [data-test-subj="createSpace"]) + [00:03:37] │ Wait timed out after 10020ms + [00:03:37] │ at /dev/shm/workspace/parallel/24/kibana/node_modules/selenium-webdriver/lib/webdriver.js:842:17 + [00:03:37] │ at runMicrotasks () + [00:03:37] │ at processTicksAndRejections (internal/process/task_queues.js:93:5) + [00:03:37] │ at onFailure (/dev/shm/workspace/parallel/24/kibana/test/common/services/retry/retry_for_success.ts:17:9) + [00:03:37] │ at retryForSuccess (/dev/shm/workspace/parallel/24/kibana/test/common/services/retry/retry_for_success.ts:57:13) + [00:03:37] │ at Retry.try (/dev/shm/workspace/parallel/24/kibana/test/common/services/retry/retry.ts:32:14) + [00:03:37] │ at Proxy.clickByCssSelector (/dev/shm/workspace/parallel/24/kibana/test/functional/services/common/find.ts:420:7) + [00:03:37] │ at TestSubjects.click (/dev/shm/workspace/parallel/24/kibana/test/functional/services/common/test_subjects.ts:109:7) + [00:03:37] │ at SpaceSelectorPage.clickCreateSpace (test/functional/page_objects/space_selector_page.ts:59:7) + [00:03:37] │ at Context. (test/accessibility/apps/spaces.ts:50:7) + [00:03:37] │ at Object.apply (/dev/shm/workspace/parallel/24/kibana/node_modules/@kbn/test/src/functional_test_runner/lib/mocha/wrap_function.js:73:16) + + +But we don't know _why_ the test didn't find the element. It could be that its not on the right page, or that the element has changed. + +Just above the `✖ fail:` line, there is a line `info Taking screenshot ...` which tells us the name of the screenshot to look for in the *Google Cloud Storage (GCS) Upload Report:* + +Clicking the `[Download]` link for that png shows this image: + +image::images/a11y_screenshot.png[Kibana spaces page meets a11y validations a11y test for click on create space page.png] + +If we use a running Kibana instance and inspect elements, we find that the `createSpace` data-test-subj attribute is on this button in the Spaces page in Stack Management: + +image::images/inspect_element.png[Kibana screenshot of Spaces page with developer tools open] + +We know the test was not on the correct page to find the element to click. We see in the debug log the repeated attempts to find the element. If we scroll to the start of those repeated attempts, we see that the first thing the test did was this attempt to click on the `createSpace` element. + + + [00:01:30] └-> a11y test for manage spaces menu from top nav on Kibana home + [00:01:30] └-> a11y test for manage spaces page + [00:01:30] └-> a11y test for click on create space page + [00:01:30] └-> "before each" hook: global before each for "a11y test for click on create space page" + [00:01:30] │ debg TestSubjects.click(createSpace) + + +And we can confirm that looking at the test code. + +So we need to backtrack further to find where the test opens the Spaces page. It turns out that the test before this one would have navigated to the proper page, but the test is skipped (marked `it.skip` in a PR). + + it.skip('a11y test for manage spaces page', async () => { + await PageObjects.spaceSelector.clickManageSpaces(); + +Perhaps someone skipped the previous tests not realizing that the tests were not independent. A best practice would be for every test to be atomic and not depend on the results of any other test(s). But in UI testing, the setup takes time and we generally need to optimize for groups of tests within a describe block. \ No newline at end of file diff --git a/docs/developer/getting-started/monorepo-packages.asciidoc b/docs/developer/getting-started/monorepo-packages.asciidoc index 655a491f8b3c..bc47e46f6763 100644 --- a/docs/developer/getting-started/monorepo-packages.asciidoc +++ b/docs/developer/getting-started/monorepo-packages.asciidoc @@ -63,5 +63,7 @@ yarn kbn watch-bazel - @elastic/datemath - @kbn/apm-utils - +- @kbn/config-schema +- @kbn/tinymath +- @kbn/utility-types diff --git a/docs/developer/images/a11y_screenshot.png b/docs/developer/images/a11y_screenshot.png new file mode 100644 index 000000000000..cbb835890a07 Binary files /dev/null and b/docs/developer/images/a11y_screenshot.png differ diff --git a/docs/developer/images/inspect_element.png b/docs/developer/images/inspect_element.png new file mode 100644 index 000000000000..0c02597858a8 Binary files /dev/null and b/docs/developer/images/inspect_element.png differ diff --git a/docs/developer/images/test_results.png b/docs/developer/images/test_results.png new file mode 100644 index 000000000000..b685bf7e3023 Binary files /dev/null and b/docs/developer/images/test_results.png differ diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 0c40c2a8c4db..353a77527d1d 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -216,14 +216,27 @@ which also contains the timelion APIs and backend, look at the vis_type_timelion |<> -|An API for: - -- creating custom functionality (`actions`) -- creating custom user interaction events (`triggers`) -- attaching and detaching `actions` to `triggers`. -- emitting `trigger` events -- executing `actions` attached to a given `trigger`. -- exposing a context menu for the user to choose the appropriate action when there are multiple actions attached to a single trigger. +|UI Actions plugins provides API to manage *triggers* and *actions*. + +*Trigger* is an abstract description of user's intent to perform an action +(like user clicking on a value inside chart). It allows us to do runtime +binding between code from different plugins. For, example one such +trigger is when somebody applies filters on dashboard; another one is when +somebody opens a Dashboard panel context menu. + +*Actions* are pieces of code that execute in response to a trigger. For example, +to the dashboard filtering trigger multiple actions can be attached. Once a user +filters on the dashboard all possible actions are displayed to the user in a +popup menu and the user has to chose one. + +In general this plugin provides: + +- Creating custom functionality (actions). +- Creating custom user interaction events (triggers). +- Attaching and detaching actions to triggers. +- Emitting trigger events. +- Executing actions attached to a given trigger. +- Exposing a context menu for the user to choose the appropriate action when there are multiple actions attached to a single trigger. |{kib-repo}blob/{branch}/src/plugins/url_forwarding/README.md[urlForwarding] diff --git a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md index 01079bdf03d0..535bd8f11236 100644 --- a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md +++ b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md @@ -108,6 +108,7 @@ readonly links: { }; readonly addData: string; readonly kibana: string; + readonly upgradeAssistant: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; diff --git a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md index 11814e7ca8b7..b8d0d2288993 100644 --- a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md +++ b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md @@ -17,5 +17,5 @@ export interface DocLinksStart | --- | --- | --- | | [DOC\_LINK\_VERSION](./kibana-plugin-core-public.doclinksstart.doc_link_version.md) | string | | | [ELASTIC\_WEBSITE\_URL](./kibana-plugin-core-public.doclinksstart.elastic_website_url.md) | string | | -| [links](./kibana-plugin-core-public.doclinksstart.links.md) | {
readonly dashboard: {
readonly guide: string;
readonly drilldowns: string;
readonly drilldownsTriggerPicker: string;
readonly urlDrilldownTemplateSyntax: string;
readonly urlDrilldownVariables: string;
};
readonly discover: Record<string, string>;
readonly filebeat: {
readonly base: string;
readonly installation: string;
readonly configuration: string;
readonly elasticsearchOutput: string;
readonly elasticsearchModule: string;
readonly startup: string;
readonly exportedFields: string;
};
readonly auditbeat: {
readonly base: string;
};
readonly metricbeat: {
readonly base: string;
readonly configure: string;
readonly httpEndpoint: string;
readonly install: string;
readonly start: string;
};
readonly enterpriseSearch: {
readonly base: string;
readonly appSearchBase: string;
readonly workplaceSearchBase: string;
};
readonly heartbeat: {
readonly base: string;
};
readonly logstash: {
readonly base: string;
};
readonly functionbeat: {
readonly base: string;
};
readonly winlogbeat: {
readonly base: string;
};
readonly aggs: {
readonly composite: string;
readonly composite_missing_bucket: string;
readonly date_histogram: string;
readonly date_range: string;
readonly date_format_pattern: string;
readonly filter: string;
readonly filters: string;
readonly geohash_grid: string;
readonly histogram: string;
readonly ip_range: string;
readonly range: string;
readonly significant_terms: string;
readonly terms: string;
readonly avg: string;
readonly avg_bucket: string;
readonly max_bucket: string;
readonly min_bucket: string;
readonly sum_bucket: string;
readonly cardinality: string;
readonly count: string;
readonly cumulative_sum: string;
readonly derivative: string;
readonly geo_bounds: string;
readonly geo_centroid: string;
readonly max: string;
readonly median: string;
readonly min: string;
readonly moving_avg: string;
readonly percentile_ranks: string;
readonly serial_diff: string;
readonly std_dev: string;
readonly sum: string;
readonly top_hits: string;
};
readonly runtimeFields: {
readonly overview: string;
readonly mapping: string;
};
readonly scriptedFields: {
readonly scriptFields: string;
readonly scriptAggs: string;
readonly painless: string;
readonly painlessApi: string;
readonly painlessLangSpec: string;
readonly painlessSyntax: string;
readonly painlessWalkthrough: string;
readonly luceneExpressions: string;
};
readonly indexPatterns: {
readonly introduction: string;
readonly fieldFormattersNumber: string;
readonly fieldFormattersString: string;
};
readonly addData: string;
readonly kibana: string;
readonly elasticsearch: Record<string, string>;
readonly siem: {
readonly guide: string;
readonly gettingStarted: string;
};
readonly query: {
readonly eql: string;
readonly kueryQuerySyntax: string;
readonly luceneQuerySyntax: string;
readonly percolate: string;
readonly queryDsl: string;
};
readonly date: {
readonly dateMath: string;
readonly dateMathIndexNames: string;
};
readonly management: Record<string, string>;
readonly ml: Record<string, string>;
readonly transforms: Record<string, string>;
readonly visualize: Record<string, string>;
readonly apis: Readonly<{
bulkIndexAlias: string;
createIndex: string;
createSnapshotLifecyclePolicy: string;
createRoleMapping: string;
createRoleMappingTemplates: string;
createApiKey: string;
createPipeline: string;
createTransformRequest: string;
cronExpressions: string;
executeWatchActionModes: string;
indexExists: string;
openIndex: string;
putComponentTemplate: string;
painlessExecute: string;
painlessExecuteAPIContexts: string;
putComponentTemplateMetadata: string;
putSnapshotLifecyclePolicy: string;
putIndexTemplateV1: string;
putWatch: string;
simulatePipeline: string;
updateTransform: string;
}>;
readonly observability: Record<string, string>;
readonly alerting: Record<string, string>;
readonly maps: Record<string, string>;
readonly monitoring: Record<string, string>;
readonly security: Readonly<{
apiKeyServiceSettings: string;
clusterPrivileges: string;
elasticsearchSettings: string;
elasticsearchEnableSecurity: string;
indicesPrivileges: string;
kibanaTLS: string;
kibanaPrivileges: string;
mappingRoles: string;
mappingRolesFieldRules: string;
runAsPrivilege: string;
}>;
readonly watcher: Record<string, string>;
readonly ccs: Record<string, string>;
readonly plugins: Record<string, string>;
readonly snapshotRestore: Record<string, string>;
readonly ingest: Record<string, string>;
} | | +| [links](./kibana-plugin-core-public.doclinksstart.links.md) | {
readonly dashboard: {
readonly guide: string;
readonly drilldowns: string;
readonly drilldownsTriggerPicker: string;
readonly urlDrilldownTemplateSyntax: string;
readonly urlDrilldownVariables: string;
};
readonly discover: Record<string, string>;
readonly filebeat: {
readonly base: string;
readonly installation: string;
readonly configuration: string;
readonly elasticsearchOutput: string;
readonly elasticsearchModule: string;
readonly startup: string;
readonly exportedFields: string;
};
readonly auditbeat: {
readonly base: string;
};
readonly metricbeat: {
readonly base: string;
readonly configure: string;
readonly httpEndpoint: string;
readonly install: string;
readonly start: string;
};
readonly enterpriseSearch: {
readonly base: string;
readonly appSearchBase: string;
readonly workplaceSearchBase: string;
};
readonly heartbeat: {
readonly base: string;
};
readonly logstash: {
readonly base: string;
};
readonly functionbeat: {
readonly base: string;
};
readonly winlogbeat: {
readonly base: string;
};
readonly aggs: {
readonly composite: string;
readonly composite_missing_bucket: string;
readonly date_histogram: string;
readonly date_range: string;
readonly date_format_pattern: string;
readonly filter: string;
readonly filters: string;
readonly geohash_grid: string;
readonly histogram: string;
readonly ip_range: string;
readonly range: string;
readonly significant_terms: string;
readonly terms: string;
readonly avg: string;
readonly avg_bucket: string;
readonly max_bucket: string;
readonly min_bucket: string;
readonly sum_bucket: string;
readonly cardinality: string;
readonly count: string;
readonly cumulative_sum: string;
readonly derivative: string;
readonly geo_bounds: string;
readonly geo_centroid: string;
readonly max: string;
readonly median: string;
readonly min: string;
readonly moving_avg: string;
readonly percentile_ranks: string;
readonly serial_diff: string;
readonly std_dev: string;
readonly sum: string;
readonly top_hits: string;
};
readonly runtimeFields: {
readonly overview: string;
readonly mapping: string;
};
readonly scriptedFields: {
readonly scriptFields: string;
readonly scriptAggs: string;
readonly painless: string;
readonly painlessApi: string;
readonly painlessLangSpec: string;
readonly painlessSyntax: string;
readonly painlessWalkthrough: string;
readonly luceneExpressions: string;
};
readonly indexPatterns: {
readonly introduction: string;
readonly fieldFormattersNumber: string;
readonly fieldFormattersString: string;
};
readonly addData: string;
readonly kibana: string;
readonly upgradeAssistant: string;
readonly elasticsearch: Record<string, string>;
readonly siem: {
readonly guide: string;
readonly gettingStarted: string;
};
readonly query: {
readonly eql: string;
readonly kueryQuerySyntax: string;
readonly luceneQuerySyntax: string;
readonly percolate: string;
readonly queryDsl: string;
};
readonly date: {
readonly dateMath: string;
readonly dateMathIndexNames: string;
};
readonly management: Record<string, string>;
readonly ml: Record<string, string>;
readonly transforms: Record<string, string>;
readonly visualize: Record<string, string>;
readonly apis: Readonly<{
bulkIndexAlias: string;
createIndex: string;
createSnapshotLifecyclePolicy: string;
createRoleMapping: string;
createRoleMappingTemplates: string;
createApiKey: string;
createPipeline: string;
createTransformRequest: string;
cronExpressions: string;
executeWatchActionModes: string;
indexExists: string;
openIndex: string;
putComponentTemplate: string;
painlessExecute: string;
painlessExecuteAPIContexts: string;
putComponentTemplateMetadata: string;
putSnapshotLifecyclePolicy: string;
putIndexTemplateV1: string;
putWatch: string;
simulatePipeline: string;
updateTransform: string;
}>;
readonly observability: Record<string, string>;
readonly alerting: Record<string, string>;
readonly maps: Record<string, string>;
readonly monitoring: Record<string, string>;
readonly security: Readonly<{
apiKeyServiceSettings: string;
clusterPrivileges: string;
elasticsearchSettings: string;
elasticsearchEnableSecurity: string;
indicesPrivileges: string;
kibanaTLS: string;
kibanaPrivileges: string;
mappingRoles: string;
mappingRolesFieldRules: string;
runAsPrivilege: string;
}>;
readonly watcher: Record<string, string>;
readonly ccs: Record<string, string>;
readonly plugins: Record<string, string>;
readonly snapshotRestore: Record<string, string>;
readonly ingest: Record<string, string>;
} | | diff --git a/docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.domainid.md b/docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.domainid.md new file mode 100644 index 000000000000..b6d1f9386be8 --- /dev/null +++ b/docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.domainid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DomainDeprecationDetails](./kibana-plugin-core-public.domaindeprecationdetails.md) > [domainId](./kibana-plugin-core-public.domaindeprecationdetails.domainid.md) + +## DomainDeprecationDetails.domainId property + +Signature: + +```typescript +domainId: string; +``` diff --git a/docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.md b/docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.md new file mode 100644 index 000000000000..93d715a11c50 --- /dev/null +++ b/docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DomainDeprecationDetails](./kibana-plugin-core-public.domaindeprecationdetails.md) + +## DomainDeprecationDetails interface + +Signature: + +```typescript +export interface DomainDeprecationDetails extends DeprecationsDetails +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [domainId](./kibana-plugin-core-public.domaindeprecationdetails.domainid.md) | string | | + diff --git a/docs/development/core/public/kibana-plugin-core-public.md b/docs/development/core/public/kibana-plugin-core-public.md index 32f17d5488f6..39e554f5492a 100644 --- a/docs/development/core/public/kibana-plugin-core-public.md +++ b/docs/development/core/public/kibana-plugin-core-public.md @@ -61,6 +61,7 @@ The plugin integrates with the core system via lifecycle events: `setup` | [CoreStart](./kibana-plugin-core-public.corestart.md) | Core services exposed to the Plugin start lifecycle | | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | DeprecationsService provides methods to fetch domain deprecation details from the Kibana server. | | [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) | | +| [DomainDeprecationDetails](./kibana-plugin-core-public.domaindeprecationdetails.md) | | | [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. | | [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) | Represents the message and stack of a fatal Error | | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. | diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md index b7c01fae4314..79b59a19508e 100644 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md +++ b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md @@ -16,6 +16,7 @@ export interface NavigateToAppOptions | Property | Type | Description | | --- | --- | --- | +| [openInNewTab](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md) | boolean | if true, will open the app in new tab, will share session information via window.open if base | | [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) | string | optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md)\` as default. | | [replace](./kibana-plugin-core-public.navigatetoappoptions.replace.md) | boolean | if true, will not create a new history entry when navigating (using replace instead of push) | | [state](./kibana-plugin-core-public.navigatetoappoptions.state.md) | unknown | optional state to forward to the application | diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsserviceprovider.start.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsserviceprovider.start.md index 88079bb2fa3c..118b0104fbee 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsserviceprovider.start.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsserviceprovider.start.md @@ -8,7 +8,7 @@ ```typescript start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps): { - indexPatternsServiceFactory: (savedObjectsClient: Pick, elasticsearchClient: ElasticsearchClient) => Promise; + indexPatternsServiceFactory: (savedObjectsClient: Pick, elasticsearchClient: ElasticsearchClient) => Promise; }; ``` @@ -22,6 +22,6 @@ start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps): Returns: `{ - indexPatternsServiceFactory: (savedObjectsClient: Pick, elasticsearchClient: ElasticsearchClient) => Promise; + indexPatternsServiceFactory: (savedObjectsClient: Pick, elasticsearchClient: ElasticsearchClient) => Promise; }` diff --git a/docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.embeddablestatetransfer.navigatetoeditor.md b/docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.embeddablestatetransfer.navigatetoeditor.md index 4bd5f44084a3..fe7eac091541 100644 --- a/docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.embeddablestatetransfer.navigatetoeditor.md +++ b/docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.embeddablestatetransfer.navigatetoeditor.md @@ -11,6 +11,7 @@ A wrapper around the method which navigates to the specified appId with [embedd ```typescript navigateToEditor(appId: string, options?: { path?: string; + openInNewTab?: boolean; state: EmbeddableEditorState; }): Promise; ``` @@ -20,7 +21,7 @@ navigateToEditor(appId: string, options?: { | Parameter | Type | Description | | --- | --- | --- | | appId | string | | -| options | {
path?: string;
state: EmbeddableEditorState;
} | | +| options | {
path?: string;
openInNewTab?: boolean;
state: EmbeddableEditorState;
} | | Returns: diff --git a/package.json b/package.json index c1f2a3b3cf13..cc2532704114 100644 --- a/package.json +++ b/package.json @@ -102,7 +102,7 @@ "@elastic/datemath": "link:bazel-bin/packages/elastic-datemath/npm_module", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@^8.0.0-canary.4", "@elastic/ems-client": "7.12.0", - "@elastic/eui": "31.10.0", + "@elastic/eui": "32.0.4", "@elastic/filesaver": "1.1.2", "@elastic/good": "^9.0.1-kibana3", "@elastic/maki": "6.3.0", @@ -127,7 +127,7 @@ "@kbn/apm-config-loader": "link:packages/kbn-apm-config-loader", "@kbn/apm-utils": "link:bazel-bin/packages/kbn-apm-utils/npm_module", "@kbn/config": "link:packages/kbn-config", - "@kbn/config-schema": "link:packages/kbn-config-schema", + "@kbn/config-schema": "link:bazel-bin/packages/kbn-config-schema/npm_module", "@kbn/crypto": "link:packages/kbn-crypto", "@kbn/i18n": "link:packages/kbn-i18n", "@kbn/interpreter": "link:packages/kbn-interpreter", @@ -138,10 +138,10 @@ "@kbn/server-http-tools": "link:packages/kbn-server-http-tools", "@kbn/server-route-repository": "link:packages/kbn-server-route-repository", "@kbn/std": "link:packages/kbn-std", - "@kbn/tinymath": "link:packages/kbn-tinymath", + "@kbn/tinymath": "link:bazel-bin/packages/kbn-tinymath/npm_module", "@kbn/ui-framework": "link:packages/kbn-ui-framework", "@kbn/ui-shared-deps": "link:packages/kbn-ui-shared-deps", - "@kbn/utility-types": "link:packages/kbn-utility-types", + "@kbn/utility-types": "link:bazel-bin/packages/kbn-utility-types/npm_module", "@kbn/utils": "link:packages/kbn-utils", "@loaders.gl/core": "^2.3.1", "@loaders.gl/json": "^2.3.1", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index 3944c2356bad..fe0e8efe0d44 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -4,6 +4,9 @@ filegroup( name = "build", srcs = [ "//packages/elastic-datemath:build", - "//packages/kbn-apm-utils:build" + "//packages/kbn-apm-utils:build", + "//packages/kbn-config-schema:build", + "//packages/kbn-tinymath:build", + "//packages/kbn-utility-types:build", ], ) diff --git a/packages/kbn-cli-dev-mode/package.json b/packages/kbn-cli-dev-mode/package.json index 2ee9831e9608..1ea319ef3601 100644 --- a/packages/kbn-cli-dev-mode/package.json +++ b/packages/kbn-cli-dev-mode/package.json @@ -15,7 +15,6 @@ }, "dependencies": { "@kbn/config": "link:../kbn-config", - "@kbn/config-schema": "link:../kbn-config-schema", "@kbn/logging": "link:../kbn-logging", "@kbn/server-http-tools": "link:../kbn-server-http-tools", "@kbn/optimizer": "link:../kbn-optimizer", diff --git a/packages/kbn-config-schema/BUILD.bazel b/packages/kbn-config-schema/BUILD.bazel new file mode 100644 index 000000000000..5dcbd9e5a802 --- /dev/null +++ b/packages/kbn-config-schema/BUILD.bazel @@ -0,0 +1,86 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config", "ts_project") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library", "pkg_npm") + +PKG_BASE_NAME = "kbn-config-schema" +PKG_REQUIRE_NAME = "@kbn/config-schema" + +SOURCE_FILES = glob([ + "src/**/*.ts", + "types/joi.d.ts" +]) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", + "README.md", +] + +SRC_DEPS = [ + "@npm//joi", + "@npm//lodash", + "@npm//moment", + "@npm//tsd", + "@npm//type-detect", +] + +TYPES_DEPS = [ + "@npm//@types/jest", + "@npm//@types/joi", + "@npm//@types/lodash", + "@npm//@types/node", + "@npm//@types/type-detect", +] + +DEPS = SRC_DEPS + TYPES_DEPS + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + ], +) + +ts_project( + name = "tsc", + args = ['--pretty'], + srcs = SRCS, + deps = DEPS, + declaration = True, + declaration_map = True, + incremental = True, + out_dir = "target", + source_map = True, + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_BASE_NAME, + srcs = [], + deps = [":tsc"] + DEPS, + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + srcs = NPM_MODULE_EXTRA_FILES, + deps = [ + ":%s" % PKG_BASE_NAME, + ] +) + +filegroup( + name = "build", + srcs = [ + ":npm_module", + ], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-config-schema/package.json b/packages/kbn-config-schema/package.json index a47dee88db58..85b52f5d7553 100644 --- a/packages/kbn-config-schema/package.json +++ b/packages/kbn-config-schema/package.json @@ -1,12 +1,8 @@ { "name": "@kbn/config-schema", - "main": "./target/out/index.js", - "types": "./target/types/index.d.ts", + "main": "./target/index.js", + "types": "./target/index.d.ts", "version": "1.0.0", "license": "SSPL-1.0 OR Elastic License 2.0", - "private": true, - "scripts": { - "build": "../../node_modules/.bin/tsc", - "kbn:bootstrap": "yarn build" - } + "private": true } \ No newline at end of file diff --git a/packages/kbn-config-schema/tsconfig.json b/packages/kbn-config-schema/tsconfig.json index d33683acded1..5490f37a943f 100644 --- a/packages/kbn-config-schema/tsconfig.json +++ b/packages/kbn-config-schema/tsconfig.json @@ -1,14 +1,14 @@ { "extends": "../../tsconfig.base.json", "compilerOptions": { - "incremental": false, - "outDir": "./target/out", - "declarationDir": "./target/types", - "stripInternal": true, "declaration": true, "declarationMap": true, + "incremental": true, + "outDir": "target", + "rootDir": "src", "sourceMap": true, "sourceRoot": "../../../../../packages/kbn-config-schema/src", + "stripInternal": true, "types": [ "jest", "node" diff --git a/packages/kbn-config/package.json b/packages/kbn-config/package.json index e71175034787..8093b6ac0d21 100644 --- a/packages/kbn-config/package.json +++ b/packages/kbn-config/package.json @@ -11,7 +11,6 @@ }, "dependencies": { "@elastic/safer-lodash-set": "link:../elastic-safer-lodash-set", - "@kbn/config-schema": "link:../kbn-config-schema", "@kbn/logging": "link:../kbn-logging", "@kbn/std": "link:../kbn-std" }, diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts index 287757dd1911..341462fdbaff 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts @@ -56,7 +56,5 @@ export function buildFunctionDec( returnComment: getJSDocReturnTagComment(node), source: getSourceForNode(node), }; - - log.warning(`fn ${label} has tags: ${fn.tags.join(', ')}`); return fn; } diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_parameter_decs.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_parameter_decs.ts index e420f76357f7..d1eaad68961e 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_parameter_decs.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_parameter_decs.ts @@ -14,6 +14,7 @@ import { buildApiDeclaration } from './build_api_declaration'; import { getJSDocParamComment } from './js_doc_utils'; import { getSourceForNode } from './utils'; import { getTypeKind } from './get_type_kind'; +import { getApiSectionId } from '../utils'; /** * A helper function to capture function parameters, whether it comes from an arrow function, a regular function or @@ -28,13 +29,24 @@ import { getTypeKind } from './get_type_kind'; export function buildApiDecsForParameters( params: ParameterDeclaration[], plugins: KibanaPlatformPlugin[], - anchorLink: AnchorLink, + parentAnchorLink: AnchorLink, log: ToolingLog, jsDocs?: JSDoc[] ): ApiDeclaration[] { + let paramIndex = 0; return params.reduce((acc, param) => { - const label = param.getName(); - log.debug(`Getting parameter doc def for ${label} of kind ${param.getKindName()}`); + paramIndex++; + const apiName = param.getName(); + // Destructured parameters can make these ids look ugly. Instead of parameter name, use an index for the position. + const apiId = parentAnchorLink.apiName + ? parentAnchorLink.apiName + `.$${paramIndex}` + : `$${paramIndex}`; + const anchorLink: AnchorLink = { + scope: parentAnchorLink.scope, + pluginName: parentAnchorLink.pluginName, + apiName: apiId, + }; + log.debug(`Getting parameter doc def for ${apiName} of kind ${param.getKindName()}`); // Literal types are non primitives that aren't references to other types. We add them as a more // defined node, with children. // If we don't want the docs to be too deeply nested we could avoid this special handling. @@ -47,16 +59,17 @@ export function buildApiDecsForParameters( anchorLink.pluginName, anchorLink.scope, anchorLink.apiName, - label + apiName ) ); } else { acc.push({ + id: getApiSectionId(anchorLink), type: getTypeKind(param), - label, + label: apiName, isRequired: param.getType().isNullable() === false, signature: extractImportReferences(param.getType().getText(), plugins, log), - description: jsDocs ? getJSDocParamComment(jsDocs, label) : [], + description: jsDocs ? getJSDocParamComment(jsDocs, apiName) : [], source: getSourceForNode(param), }); } diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/extract_import_refs.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/extract_import_refs.ts index 92f191197472..7b0fe165f5f0 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/extract_import_refs.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/extract_import_refs.ts @@ -9,7 +9,7 @@ import { KibanaPlatformPlugin, ToolingLog } from '@kbn/dev-utils'; import { getApiSectionId, getPluginApiDocId, getPluginForPath } from '../utils'; import { ApiScope, TextWithLinks } from '../types'; -import { getRelativePath } from './utils'; +import { getRelativePath, pathsOutsideScopes } from './utils'; /** * @@ -115,7 +115,7 @@ function getScopeFromPath(path: string, plugin: KibanaPlatformPlugin, log: Tooli } else if (path.startsWith(`${plugin.directory}/common/`)) { return ApiScope.COMMON; } else { - log.warning(`Unexpected path encountered ${path}`); + pathsOutsideScopes[path] = plugin.directory; return ApiScope.COMMON; } } diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts index ab8ec7dc3461..500c87afecd9 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts @@ -10,6 +10,12 @@ import { REPO_ROOT } from '@kbn/utils'; import { ParameterDeclaration, ClassMemberTypes, Node } from 'ts-morph'; import { SourceLink } from '../types'; +// Collect any paths encountered that are not in the correct scope folder. +// APIs inside these folders will cause issues with the API docs system. The +// path will map to the plugin directory. It _should_ be the prefix of the path, +// but sometimes it is not! +export const pathsOutsideScopes: { [key: string]: string } = {}; + export function isPrivate(node: ParameterDeclaration | ClassMemberTypes): boolean { return node.getModifiers().find((mod) => mod.getText() === 'private') !== undefined; } diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts b/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts index ac6d6088c25c..7c83a0345386 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts @@ -9,37 +9,59 @@ import Fs from 'fs'; import Path from 'path'; -import { REPO_ROOT, run } from '@kbn/dev-utils'; +import { REPO_ROOT, run, CiStatsReporter, createFlagError } from '@kbn/dev-utils'; import { Project } from 'ts-morph'; -import { getPluginApi } from './get_plugin_api'; import { writePluginDocs } from './mdx/write_plugin_mdx_docs'; -import { ApiDeclaration, PluginApi } from './types'; +import { ApiDeclaration, PluginApi, TypeKind } from './types'; import { findPlugins } from './find_plugins'; -import { removeBrokenLinks } from './utils'; +import { pathsOutsideScopes } from './build_api_declarations/utils'; +import { getPluginApiMap } from './get_plugin_api_map'; export interface PluginInfo { apiCount: number; apiCountMissingComments: number; id: string; missingApiItems: string[]; + percentApiMissingComments: number; +} + +function isStringArray(arr: unknown | string[]): arr is string[] { + return Array.isArray(arr) && arr.every((p) => typeof p === 'string'); } export function runBuildApiDocsCli() { run( - async ({ log }) => { + async ({ log, flags }) => { + const stats = flags.stats && typeof flags.stats === 'string' ? [flags.stats] : flags.stats; + const pluginFilter = + flags.plugin && typeof flags.plugin === 'string' ? [flags.plugin] : flags.plugin; + + if (pluginFilter && !isStringArray(pluginFilter)) { + throw createFlagError('expected --plugin must only contain strings'); + } + + if ( + (stats && + isStringArray(stats) && + stats.find((s) => s !== 'any' && s !== 'comments' && s !== 'exports')) || + (stats && !isStringArray(stats)) + ) { + throw createFlagError( + 'expected --stats must only contain `any`, `comments` and/or `exports`' + ); + } + const project = getTsProject(REPO_ROOT); const plugins = findPlugins(); - const pluginInfos: { - [key: string]: PluginInfo; - } = {}; - const outputFolder = Path.resolve(REPO_ROOT, 'api_docs'); if (!Fs.existsSync(outputFolder)) { Fs.mkdirSync(outputFolder); - } else { + + // Don't delete all the files if a plugin filter is being used. + } else if (!pluginFilter) { // Delete all files except the README that warns about the auto-generated nature of // the folder. const files = Fs.readdirSync(outputFolder); @@ -50,41 +72,115 @@ export function runBuildApiDocsCli() { }); } - const pluginApiMap: { [key: string]: PluginApi } = {}; - plugins.map((plugin) => { - pluginApiMap[plugin.manifest.id] = getPluginApi(project, plugin, plugins, log); - }); - - const missingApiItems: { [key: string]: string[] } = {}; + const { pluginApiMap, missingApiItems } = getPluginApiMap(project, plugins, log); + const reporter = CiStatsReporter.fromEnv(log); plugins.forEach((plugin) => { - const id = plugin.manifest.id; - const pluginApi = pluginApiMap[id]; - removeBrokenLinks(pluginApi, missingApiItems, pluginApiMap); - }); + // Note that the filtering is done here, and not above because the entire public plugin API has to + // be parsed in order to correctly determine reference links, and ensure that `removeBrokenLinks` + // doesn't remove more links than necessary. + if (pluginFilter && !pluginFilter.includes(plugin.manifest.id)) { + return; + } - plugins.forEach((plugin) => { const id = plugin.manifest.id; const pluginApi = pluginApiMap[id]; - const info = { - id, - apiCount: countApiForPlugin(pluginApi), - apiCountMissingComments: countMissingCommentsApiForPlugin(pluginApi), - missingApiItems: missingApiItems[id], - }; - - if (info.apiCount > 0) { + const apiCount = countApiForPlugin(pluginApi); + const pluginStats = collectApiStatsForPlugin(pluginApi); + + reporter.metrics([ + { + id, + group: 'API count', + value: apiCount, + }, + { + id, + group: 'API count missing comments', + value: pluginStats.missingComments.length, + }, + { + id, + group: 'API count with any type', + value: pluginStats.isAnyType.length, + }, + { + id, + group: 'Non-exported public API item count', + value: missingApiItems[id] ? Object.keys(missingApiItems[id]).length : 0, + }, + ]); + + if (stats) { + const passesAllChecks = + pluginStats.isAnyType.length === 0 && + pluginStats.missingComments.length === 0 && + (!missingApiItems[id] || Object.keys(missingApiItems[id]).length === 0); + + log.info(`--- Plugin '${id}' ${passesAllChecks ? ` passes all checks ----` : '----`'}`); + + if (!passesAllChecks) { + log.info(`${pluginStats.isAnyType.length} API items with ANY`); + + const getLink = (d: ApiDeclaration) => + `https://github.com/elastic/kibana/tree/master/${d.source.path}#L${d.source.lineNumber}`; + if (stats.includes('any')) { + // eslint-disable-next-line no-console + console.table( + pluginStats.isAnyType.map((d) => ({ + id: d.id, + link: getLink(d), + })) + ); + } + + log.info(`${pluginStats.missingComments.length} API items missing comments`); + if (stats.includes('comments')) { + // eslint-disable-next-line no-console + console.table( + pluginStats.missingComments.map((d) => ({ + id: d.id, + link: getLink(d), + })) + ); + } + + if (missingApiItems[id]) { + log.info( + `${Object.keys(missingApiItems[id]).length} referenced API items not exported` + ); + if (stats.includes('exports')) { + // eslint-disable-next-line no-console + console.table( + Object.keys(missingApiItems[id]).map((key) => ({ + 'Not exported source': key, + references: missingApiItems[id][key].join(', '), + })) + ); + } + } + } + } + + if (apiCount > 0) { writePluginDocs(outputFolder, pluginApi, log); - pluginInfos[id] = info; } }); - - // eslint-disable-next-line no-console - console.table(pluginInfos); + if (Object.values(pathsOutsideScopes).length > 0) { + log.warning(`Found paths outside of normal scope folders:`); + log.warning(pathsOutsideScopes); + } }, { log: { - defaultLevel: 'debug', + defaultLevel: 'info', + }, + flags: { + string: ['plugin', 'stats'], + help: ` + --plugin Optionally, run for only a specific plugin + --stats Optionally print API stats. Must be one or more of: any, comments or exports. + `, }, } ); @@ -100,30 +196,38 @@ function getTsProject(repoPath: string) { return project; } -function countMissingCommentsApiForPlugin(doc: PluginApi) { - return ( - doc.client.reduce((sum, def) => { - return sum + countMissingCommentsForApi(def); - }, 0) + - doc.server.reduce((sum, def) => { - return sum + countMissingCommentsForApi(def); - }, 0) + - doc.common.reduce((sum, def) => { - return sum + countMissingCommentsForApi(def); - }, 0) - ); +interface ApiStats { + missingComments: ApiDeclaration[]; + isAnyType: ApiDeclaration[]; } -function countMissingCommentsForApi(doc: ApiDeclaration): number { - const missingCnt = doc.description && doc.description.length > 0 ? 0 : 1; - if (!doc.children) return missingCnt; - else - return ( - missingCnt + - doc.children.reduce((sum, child) => { - return sum + countMissingCommentsForApi(child); - }, 0) - ); +function collectApiStatsForPlugin(doc: PluginApi): ApiStats { + const stats: ApiStats = { missingComments: [], isAnyType: [] }; + Object.values(doc.client).forEach((def) => { + collectStatsForApi(def, stats); + }); + Object.values(doc.server).forEach((def) => { + collectStatsForApi(def, stats); + }); + Object.values(doc.common).forEach((def) => { + collectStatsForApi(def, stats); + }); + return stats; +} + +function collectStatsForApi(doc: ApiDeclaration, stats: ApiStats): void { + const missingComment = doc.description === undefined || doc.description.length === 0; + if (missingComment) { + stats.missingComments.push(doc); + } + if (doc.type === TypeKind.AnyKind) { + stats.isAnyType.push(doc); + } + if (doc.children) { + doc.children.forEach((child) => { + collectStatsForApi(child, stats); + }); + } } function countApiForPlugin(doc: PluginApi) { diff --git a/packages/kbn-docs-utils/src/api_docs/get_declaration_nodes_for_plugin.ts b/packages/kbn-docs-utils/src/api_docs/get_declaration_nodes_for_plugin.ts index 6676c5e753c9..ee1fdc7f8803 100644 --- a/packages/kbn-docs-utils/src/api_docs/get_declaration_nodes_for_plugin.ts +++ b/packages/kbn-docs-utils/src/api_docs/get_declaration_nodes_for_plugin.ts @@ -63,7 +63,7 @@ function getExportedFileDeclarations(source: SourceFile, log: ToolingLog): Node[ if (name && name !== '') { nodes.push(ed); } else { - log.warning(`API with missing name encountered.`); + log.warning(`API with missing name encountered, text is ` + ed.getText().substring(0, 50)); } }); }); diff --git a/packages/kbn-docs-utils/src/api_docs/get_plugin_api_map.ts b/packages/kbn-docs-utils/src/api_docs/get_plugin_api_map.ts new file mode 100644 index 000000000000..74334f5e7b25 --- /dev/null +++ b/packages/kbn-docs-utils/src/api_docs/get_plugin_api_map.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { KibanaPlatformPlugin, ToolingLog } from '@kbn/dev-utils'; +import { Project } from 'ts-morph'; +import { getPluginApi } from './get_plugin_api'; +import { MissingApiItemMap, PluginApi } from './types'; +import { removeBrokenLinks } from './utils'; + +export function getPluginApiMap( + project: Project, + plugins: KibanaPlatformPlugin[], + log: ToolingLog +): { + pluginApiMap: { [key: string]: PluginApi }; + missingApiItems: MissingApiItemMap; +} { + const pluginApiMap: { [key: string]: PluginApi } = {}; + plugins.map((plugin) => { + pluginApiMap[plugin.manifest.id] = getPluginApi(project, plugin, plugins, log); + }); + + // Mapping of plugin id to the missing source API id to all the plugin API items that referenced this item. + const missingApiItems: { [key: string]: { [key: string]: string[] } } = {}; + + plugins.forEach((plugin) => { + const id = plugin.manifest.id; + const pluginApi = pluginApiMap[id]; + removeBrokenLinks(pluginApi, missingApiItems, pluginApiMap, log); + }); + return { pluginApiMap, missingApiItems }; +} diff --git a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts index 5190f8e0c6fb..356da0afbd8f 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts +++ b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts @@ -7,6 +7,7 @@ */ import { TypeWithGeneric, ImAType } from './types'; +import { ImNotExportedFromIndex } from './foo'; /** * This is a non arrow function. @@ -69,11 +70,7 @@ export const crazyFunction = ( { str }: { str: string } ) => () => () => fn({ param: str }); -interface ImNotExported { - foo: string; -} - -export const fnWithNonExportedRef = (a: ImNotExported) => 'shi'; +export const fnWithNonExportedRef = (a: ImNotExportedFromIndex) => a; export type NotAnArrowFnType = typeof notAnArrowFn; diff --git a/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts b/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts index 158eb68b4e5b..cf20eea76d30 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts +++ b/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts @@ -15,8 +15,8 @@ import { ToolingLog, KibanaPlatformPlugin } from '@kbn/dev-utils'; import { writePluginDocs } from '../mdx/write_plugin_mdx_docs'; import { ApiDeclaration, PluginApi, Reference, TextWithLinks, TypeKind } from '../types'; import { getKibanaPlatformPlugin } from './kibana_platform_plugin_mock'; -import { getPluginApi } from '../get_plugin_api'; import { groupPluginApi } from '../utils'; +import { getPluginApiMap } from '../get_plugin_api_map'; const log = new ToolingLog({ level: 'debug', @@ -87,8 +87,9 @@ beforeAll(() => { pluginA.manifest.serviceFolders = ['foo']; const plugins: KibanaPlatformPlugin[] = [pluginA]; - doc = getPluginApi(project, plugins[0], plugins, log); + const { pluginApiMap } = getPluginApiMap(project, plugins, log); + doc = pluginApiMap.pluginA; mdxOutputFolder = Path.resolve(__dirname, 'snapshots'); writePluginDocs(mdxOutputFolder, doc, log); }); @@ -137,7 +138,12 @@ describe('functions', () => { it('function referencing missing type has link removed', () => { const fn = doc.client.find((c) => c.label === 'fnWithNonExportedRef'); expect(linkCount(fn?.signature!)).toBe(0); + expect(fn?.children).toBeDefined(); + expect(fn?.children!.length).toBe(1); + expect(fn?.children![0].signature).toBeDefined(); + expect(linkCount(fn?.children![0].signature!)).toBe(0); }); + it('arrow function is exported correctly', () => { const fn = doc.client.find((c) => c.label === 'arrowFn'); // Using the same data as the not an arrow function so this is refactored. @@ -217,6 +223,13 @@ describe('objects', () => { }); describe('Misc types', () => { + it('Type referencing not exported type has the link removed', () => { + const api = doc.client.find((c) => c.label === 'IRefANotExportedType'); + expect(api).toBeDefined(); + expect(api?.signature).toBeDefined(); + expect(linkCount(api?.signature!)).toBe(0); + }); + it('Explicitly typed array is returned with the correct type', () => { const aStrArray = doc.client.find((c) => c.label === 'aStrArray'); expect(aStrArray).toBeDefined(); diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json index e9b87aa0f972..8f8533abef0d 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json @@ -90,6 +90,7 @@ "description": [], "children": [ { + "id": "def-public.ExampleClass.Unnamed.$1", "type": "Uncategorized", "label": "t", "isRequired": true, @@ -115,6 +116,7 @@ "type": "Function", "children": [ { + "id": "def-public.ExampleClass.arrowFn.$1", "type": "CompoundType", "label": "a", "isRequired": true, @@ -183,6 +185,7 @@ ], "children": [ { + "id": "def-public.ExampleClass.getVar.$1", "type": "CompoundType", "label": "a", "isRequired": true, @@ -225,6 +228,7 @@ "type": "Function", "children": [ { + "id": "def-public.arrowFn.$1", "type": "string", "label": "a", "isRequired": true, @@ -234,10 +238,11 @@ "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 42 + "lineNumber": 43 } }, { + "id": "def-public.arrowFn.$2", "type": "number", "label": "b", "isRequired": false, @@ -247,10 +252,11 @@ "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 43 + "lineNumber": 44 } }, { + "id": "def-public.arrowFn.$3", "type": "Array", "label": "c", "isRequired": true, @@ -267,10 +273,11 @@ "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 44 + "lineNumber": 45 } }, { + "id": "def-public.arrowFn.$4", "type": "CompoundType", "label": "d", "isRequired": true, @@ -286,10 +293,11 @@ "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 45 + "lineNumber": 46 } }, { + "id": "def-public.arrowFn.$5", "type": "string", "label": "e", "isRequired": false, @@ -299,7 +307,7 @@ "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 46 + "lineNumber": 47 } } ], @@ -336,7 +344,7 @@ "label": "arrowFn", "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 41 + "lineNumber": 42 }, "tags": [], "returnComment": [ @@ -349,7 +357,7 @@ "type": "Function", "children": [ { - "id": "def-public.crazyFunction.obj", + "id": "def-public.crazyFunction.$1.obj", "type": "Object", "label": "obj", "tags": [], @@ -357,23 +365,23 @@ "children": [ { "tags": [], - "id": "def-public.crazyFunction.obj.hi", + "id": "def-public.crazyFunction.$1.obj.hi", "type": "string", "label": "hi", "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 67 + "lineNumber": 68 } } ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 67 + "lineNumber": 68 } }, { - "id": "def-public.crazyFunction.{-fn }", + "id": "def-public.crazyFunction.$2.fn", "type": "Object", "label": "{ fn }", "tags": [], @@ -381,13 +389,13 @@ "children": [ { "tags": [], - "id": "def-public.crazyFunction.{-fn }.fn", + "id": "def-public.crazyFunction.$2.fn.fn", "type": "Function", "label": "fn", "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 68 + "lineNumber": 69 }, "signature": [ "(foo: { param: string; }) => number" @@ -396,11 +404,11 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 68 + "lineNumber": 69 } }, { - "id": "def-public.crazyFunction.{-str }", + "id": "def-public.crazyFunction.$3.str", "type": "Object", "label": "{ str }", "tags": [], @@ -408,19 +416,19 @@ "children": [ { "tags": [], - "id": "def-public.crazyFunction.{-str }.str", + "id": "def-public.crazyFunction.$3.str.str", "type": "string", "label": "str", "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 69 + "lineNumber": 70 } } ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 69 + "lineNumber": 70 } } ], @@ -433,7 +441,7 @@ "label": "crazyFunction", "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 66 + "lineNumber": 67 }, "tags": [], "returnComment": [ @@ -446,27 +454,31 @@ "type": "Function", "children": [ { - "type": "Object", + "id": "def-public.fnWithNonExportedRef.$1", + "type": "Function", "label": "a", "isRequired": true, "signature": [ - "ImNotExported" + "ImNotExportedFromIndex" ], "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 76 + "lineNumber": 73 } } ], "signature": [ - "(a: ImNotExported) => string" + "(a: ", + "ImNotExportedFromIndex", + ") => ", + "ImNotExportedFromIndex" ], "description": [], "label": "fnWithNonExportedRef", "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 76 + "lineNumber": 73 }, "tags": [], "returnComment": [], @@ -508,6 +520,7 @@ ], "children": [ { + "id": "def-public.notAnArrowFn.$1", "type": "string", "label": "a", "isRequired": true, @@ -519,10 +532,11 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 22 + "lineNumber": 23 } }, { + "id": "def-public.notAnArrowFn.$2", "type": "number", "label": "b", "isRequired": false, @@ -534,10 +548,11 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 23 + "lineNumber": 24 } }, { + "id": "def-public.notAnArrowFn.$3", "type": "Array", "label": "c", "isRequired": true, @@ -556,10 +571,11 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 24 + "lineNumber": 25 } }, { + "id": "def-public.notAnArrowFn.$4", "type": "CompoundType", "label": "d", "isRequired": true, @@ -577,10 +593,11 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 25 + "lineNumber": 26 } }, { + "id": "def-public.notAnArrowFn.$5", "type": "string", "label": "e", "isRequired": false, @@ -592,7 +609,7 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 26 + "lineNumber": 27 } } ], @@ -602,7 +619,7 @@ ], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 21 + "lineNumber": 22 }, "initialIsOpen": false } @@ -1088,13 +1105,7 @@ "lineNumber": 42 }, "signature": [ - { - "pluginId": "pluginA", - "scope": "public", - "docId": "kibPluginAFooPluginApi", - "section": "def-public.ImNotExportedFromIndex", - "text": "ImNotExportedFromIndex" - }, + "ImNotExportedFromIndex", " | { zed: \"hi\"; }" ], "initialIsOpen": false @@ -1141,7 +1152,7 @@ "description": [], "source": { "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "lineNumber": 78 + "lineNumber": 75 }, "signature": [ "(a: string, b: number | undefined, c: ", @@ -1262,6 +1273,7 @@ "type": "Function", "children": [ { + "id": "def-public.aPretendNamespaceObj.aPropertyInlineFn.$1", "type": "CompoundType", "label": "a", "isRequired": true, @@ -1488,13 +1500,7 @@ }, "signature": [ "() => ", - { - "pluginId": "pluginA", - "scope": "public", - "docId": "kibPluginAPluginApi", - "section": "def-public.SearchLanguage", - "text": "SearchLanguage" - } + "SearchLanguage" ] } ], diff --git a/packages/kbn-docs-utils/src/api_docs/types.ts b/packages/kbn-docs-utils/src/api_docs/types.ts index 3e3537e1eba1..676459293902 100644 --- a/packages/kbn-docs-utils/src/api_docs/types.ts +++ b/packages/kbn-docs-utils/src/api_docs/types.ts @@ -111,7 +111,7 @@ export interface ApiDeclaration { * Used for an anchor link to this Api. Can't use label as there can be two labels with the same * text within the Client section and the Server section. */ - id?: string; + id: string; /** * The name of the api. @@ -197,3 +197,8 @@ export enum Lifecycle { START = 'start', SETUP = 'setup', } + +// Mapping of plugin id to the missing source API id to all the plugin API items that referenced this item. +export interface MissingApiItemMap { + [key: string]: { [key: string]: string[] }; +} diff --git a/packages/kbn-docs-utils/src/api_docs/utils.test.ts b/packages/kbn-docs-utils/src/api_docs/utils.test.ts index a506405616a4..33aa120dd2b6 100644 --- a/packages/kbn-docs-utils/src/api_docs/utils.test.ts +++ b/packages/kbn-docs-utils/src/api_docs/utils.test.ts @@ -72,12 +72,14 @@ it('test removeBrokenLinks', () => { pluginApiMap[plugin.manifest.id] = getPluginApi(project, plugin, plugins, log); }); - const missingApiItems: { [key: string]: string[] } = {}; + const missingApiItems: { [key: string]: { [key: string]: string[] } } = {}; plugins.forEach((plugin) => { const id = plugin.manifest.id; const pluginApi = pluginApiMap[id]; - removeBrokenLinks(pluginApi, missingApiItems, pluginApiMap); + removeBrokenLinks(pluginApi, missingApiItems, pluginApiMap, log); }); - expect(missingApiItems.pluginA.indexOf('public.ImNotExportedFromIndex')).toBeGreaterThan(-1); + expect(missingApiItems.pluginA['pluginA-public-ImNotExportedFromIndex'].length).toBeGreaterThan( + 0 + ); }); diff --git a/packages/kbn-docs-utils/src/api_docs/utils.ts b/packages/kbn-docs-utils/src/api_docs/utils.ts index 10ca184a72ec..c3a7e61ec9f8 100644 --- a/packages/kbn-docs-utils/src/api_docs/utils.ts +++ b/packages/kbn-docs-utils/src/api_docs/utils.ts @@ -5,7 +5,7 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - +import path from 'path'; import { KibanaPlatformPlugin, ToolingLog } from '@kbn/dev-utils'; import { AnchorLink, @@ -28,14 +28,14 @@ export const snakeToCamel = (str: string): string => /** * Returns the plugin that the file belongs to. - * @param path An absolute file path that can point to a file nested inside a plugin + * @param filePath An absolute file path that can point to a file nested inside a plugin * @param plugins A list of plugins to search through. */ export function getPluginForPath( - path: string, + filePath: string, plugins: KibanaPlatformPlugin[] ): KibanaPlatformPlugin | undefined { - return plugins.find((plugin) => path.startsWith(plugin.directory)); + return plugins.find((plugin) => filePath.startsWith(plugin.directory + path.sep)); } /** @@ -68,13 +68,13 @@ function escapeRegExp(regexp: string) { * name of the first nested folder in the plugin. For example a path of * 'src/plugins/data/public/search_services/file.ts' would return 'search_service' while * 'src/plugin/data/server/file.ts' would return undefined. - * @param path + * @param filePath */ -export function getServiceForPath(path: string, pluginDirectory: string): string | undefined { +export function getServiceForPath(filePath: string, pluginDirectory: string): string | undefined { const dir = escapeRegExp(pluginDirectory); - const publicMatchGroups = path.match(`${dir}\/public\/([^\/]*)\/`); - const serverMatchGroups = path.match(`${dir}\/server\/([^\/]*)\/`); - const commonMatchGroups = path.match(`${dir}\/common\/([^\/]*)\/`); + const publicMatchGroups = filePath.match(`${dir}\/public\/([^\/]*)\/`); + const serverMatchGroups = filePath.match(`${dir}\/server\/([^\/]*)\/`); + const commonMatchGroups = filePath.match(`${dir}\/common\/([^\/]*)\/`); if (publicMatchGroups && publicMatchGroups.length > 1) { return publicMatchGroups[1]; @@ -109,7 +109,9 @@ export function getPluginApiDocId( } export function getApiSectionId(link: AnchorLink) { - const id = `def-${link.scope}.${link.apiName}`.replace(' ', '-'); + // Clean up the name. Things like destructured function parameters can have really long names with brackets and commas. + const cleanName = link.apiName.replace(/[^A-Za-z_.$0-9]+/g, ''); + const id = `def-${link.scope}.${cleanName}`; return id; } @@ -169,29 +171,70 @@ export function addApiDeclarationToScope(declaration: ApiDeclaration, scope: Sco } } +/** + * Loops through the signatures of every API declarations for the given pluginApi. If any are external references that + * don't actually exist inside `pluginApiMap`, it will remove the link and replace the signature with just the text. This way we avoid + * broken links in the docs system. + * @param pluginApi - The plugin API that will have all missing reference links removed. + * @param missingApiItems - Collects all the missing API items encountered so this information can be displayed as stats. + * @param pluginApiMap - Used to look up the referenced API items from other plugins. + * @param log + */ export function removeBrokenLinks( pluginApi: PluginApi, - missingApiItems: { [key: string]: string[] }, - pluginApiMap: { [key: string]: PluginApi } + missingApiItems: { [key: string]: { [key: string]: string[] } }, + pluginApiMap: { [key: string]: PluginApi }, + log: ToolingLog ) { + let missingCnt = 0; (['client', 'common', 'server'] as Array<'client' | 'server' | 'common'>).forEach((scope) => { pluginApi[scope].forEach((api) => { - if (api.signature) { - api.signature = api.signature.map((sig) => { - if (typeof sig !== 'string') { - if (apiItemExists(sig.text, sig.scope, pluginApiMap[sig.pluginId]) === false) { - if (missingApiItems[sig.pluginId] === undefined) { - missingApiItems[sig.pluginId] = []; - } - missingApiItems[sig.pluginId].push(`${sig.scope}.${sig.text}`); - return sig.text; - } + missingCnt += removeBrokenLinksFromApi(pluginApi.id, api, missingApiItems, pluginApiMap); + }); + }); + + if (missingCnt > 0) { + log.info( + `${pluginApi.id} had ${missingCnt} API item references removed to avoid broken links use the flag '--stats exports' to get a list of every missing export ` + ); + } +} + +function removeBrokenLinksFromApi( + pluginId: string, + api: ApiDeclaration, + missingApiItems: { [key: string]: { [key: string]: string[] } }, + pluginApiMap: { [key: string]: PluginApi } +): number { + let missingCnt = 0; + if (api.signature) { + api.signature = api.signature.map((sig) => { + if (typeof sig !== 'string') { + if (!apiItemExists(sig.text, sig.scope, pluginApiMap[sig.pluginId])) { + if (missingApiItems[sig.pluginId] === undefined) { + missingApiItems[sig.pluginId] = {}; + } + const sourceId = `${sig.pluginId}-${sig.scope}-${sig.text}`; + if (missingApiItems[sig.pluginId][sourceId] === undefined) { + missingApiItems[sig.pluginId][sourceId] = []; } - return sig; - }); + + missingApiItems[sig.pluginId][sourceId].push(`${pluginId}-${api.id}`); + + missingCnt++; + return sig.text; + } + return sig; } + return sig; }); - }); + } + if (api.children) { + api.children.forEach((child) => { + missingCnt += removeBrokenLinksFromApi(pluginId, child, missingApiItems, pluginApiMap); + }); + } + return missingCnt; } function apiItemExists(name: string, scope: ApiScope, pluginApi: PluginApi): boolean { diff --git a/packages/kbn-legacy-logging/package.json b/packages/kbn-legacy-logging/package.json index 96edeccad665..9450fd39607e 100644 --- a/packages/kbn-legacy-logging/package.json +++ b/packages/kbn-legacy-logging/package.json @@ -11,7 +11,6 @@ "kbn:watch": "yarn build --watch" }, "dependencies": { - "@kbn/utils": "link:../kbn-utils", - "@kbn/config-schema": "link:../kbn-config-schema" + "@kbn/utils": "link:../kbn-utils" } } diff --git a/packages/kbn-pm/dist/index.js b/packages/kbn-pm/dist/index.js index af199fbbc27c..e6cdd5268665 100644 --- a/packages/kbn-pm/dist/index.js +++ b/packages/kbn-pm/dist/index.js @@ -29754,15 +29754,14 @@ var gitHosts = __webpack_require__(284) var GitHost = module.exports = __webpack_require__(285) var protocolToRepresentationMap = { - 'git+ssh': 'sshurl', - 'git+https': 'https', - 'ssh': 'sshurl', - 'git': 'git' + 'git+ssh:': 'sshurl', + 'git+https:': 'https', + 'ssh:': 'sshurl', + 'git:': 'git' } function protocolToRepresentation (protocol) { - if (protocol.substr(-1) === ':') protocol = protocol.slice(0, -1) - return protocolToRepresentationMap[protocol] || protocol + return protocolToRepresentationMap[protocol] || protocol.slice(0, -1) } var authProtocols = { @@ -29776,6 +29775,7 @@ var authProtocols = { var cache = {} module.exports.fromUrl = function (giturl, opts) { + if (typeof giturl !== 'string') return var key = giturl + JSON.stringify(opts || {}) if (!(key in cache)) { @@ -29791,13 +29791,13 @@ function fromUrl (giturl, opts) { isGitHubShorthand(giturl) ? 'github:' + giturl : giturl ) var parsed = parseGitUrl(url) - var shortcutMatch = url.match(new RegExp('^([^:]+):(?:(?:[^@:]+(?:[^@]+)?@)?([^/]*))[/](.+?)(?:[.]git)?($|#)')) + var shortcutMatch = url.match(/^([^:]+):(?:[^@]+@)?(?:([^/]*)\/)?([^#]+)/) var matches = Object.keys(gitHosts).map(function (gitHostName) { try { var gitHostInfo = gitHosts[gitHostName] var auth = null if (parsed.auth && authProtocols[parsed.protocol]) { - auth = decodeURIComponent(parsed.auth) + auth = parsed.auth } var committish = parsed.hash ? decodeURIComponent(parsed.hash.substr(1)) : null var user = null @@ -29805,22 +29805,27 @@ function fromUrl (giturl, opts) { var defaultRepresentation = null if (shortcutMatch && shortcutMatch[1] === gitHostName) { user = shortcutMatch[2] && decodeURIComponent(shortcutMatch[2]) - project = decodeURIComponent(shortcutMatch[3]) + project = decodeURIComponent(shortcutMatch[3].replace(/\.git$/, '')) defaultRepresentation = 'shortcut' } else { - if (parsed.host !== gitHostInfo.domain) return + if (parsed.host && parsed.host !== gitHostInfo.domain && parsed.host.replace(/^www[.]/, '') !== gitHostInfo.domain) return if (!gitHostInfo.protocols_re.test(parsed.protocol)) return if (!parsed.path) return var pathmatch = gitHostInfo.pathmatch var matched = parsed.path.match(pathmatch) if (!matched) return - if (matched[1] != null) user = decodeURIComponent(matched[1].replace(/^:/, '')) - if (matched[2] != null) project = decodeURIComponent(matched[2]) + /* istanbul ignore else */ + if (matched[1] !== null && matched[1] !== undefined) { + user = decodeURIComponent(matched[1].replace(/^:/, '')) + } + project = decodeURIComponent(matched[2]) defaultRepresentation = protocolToRepresentation(parsed.protocol) } return new GitHost(gitHostName, user, auth, project, committish, defaultRepresentation, opts) } catch (ex) { - if (!(ex instanceof URIError)) throw ex + /* istanbul ignore else */ + if (ex instanceof URIError) { + } else throw ex } }).filter(function (gitHostInfo) { return gitHostInfo }) if (matches.length !== 1) return @@ -29850,9 +29855,31 @@ function fixupUnqualifiedGist (giturl) { } function parseGitUrl (giturl) { - if (typeof giturl !== 'string') giturl = '' + giturl var matched = giturl.match(/^([^@]+)@([^:/]+):[/]?((?:[^/]+[/])?[^/]+?)(?:[.]git)?(#.*)?$/) - if (!matched) return url.parse(giturl) + if (!matched) { + var legacy = url.parse(giturl) + // If we don't have url.URL, then sorry, this is just not fixable. + // This affects Node <= 6.12. + if (legacy.auth && typeof url.URL === 'function') { + // git urls can be in the form of scp-style/ssh-connect strings, like + // git+ssh://user@host.com:some/path, which the legacy url parser + // supports, but WhatWG url.URL class does not. However, the legacy + // parser de-urlencodes the username and password, so something like + // https://user%3An%40me:p%40ss%3Aword@x.com/ becomes + // https://user:n@me:p@ss:word@x.com/ which is all kinds of wrong. + // Pull off just the auth and host, so we dont' get the confusing + // scp-style URL, then pass that to the WhatWG parser to get the + // auth properly escaped. + var authmatch = giturl.match(/[^@]+@[^:/]+/) + /* istanbul ignore else - this should be impossible */ + if (authmatch) { + var whatwg = new url.URL(authmatch[0]) + legacy.auth = whatwg.username || '' + if (whatwg.password) legacy.auth += ':' + whatwg.password + } + } + return legacy + } return { protocol: 'git+ssh:', slashes: true, @@ -29894,7 +29921,7 @@ var gitHosts = module.exports = { 'filetemplate': 'https://{auth@}raw.githubusercontent.com/{user}/{project}/{committish}/{path}', 'bugstemplate': 'https://{domain}/{user}/{project}/issues', 'gittemplate': 'git://{auth@}{domain}/{user}/{project}.git{#committish}', - 'tarballtemplate': 'https://{domain}/{user}/{project}/archive/{committish}.tar.gz' + 'tarballtemplate': 'https://codeload.{domain}/{user}/{project}/tar.gz/{committish}' }, bitbucket: { 'protocols': [ 'git+ssh', 'git+https', 'ssh', 'https' ], @@ -29906,25 +29933,30 @@ var gitHosts = module.exports = { 'protocols': [ 'git+ssh', 'git+https', 'ssh', 'https' ], 'domain': 'gitlab.com', 'treepath': 'tree', - 'docstemplate': 'https://{domain}/{user}/{project}{/tree/committish}#README', 'bugstemplate': 'https://{domain}/{user}/{project}/issues', - 'tarballtemplate': 'https://{domain}/{user}/{project}/repository/archive.tar.gz?ref={committish}' + 'httpstemplate': 'git+https://{auth@}{domain}/{user}/{projectPath}.git{#committish}', + 'tarballtemplate': 'https://{domain}/{user}/{project}/repository/archive.tar.gz?ref={committish}', + 'pathmatch': /^[/]([^/]+)[/]((?!.*(\/-\/|\/repository\/archive\.tar\.gz\?=.*|\/repository\/[^/]+\/archive.tar.gz$)).*?)(?:[.]git|[/])?$/ }, gist: { 'protocols': [ 'git', 'git+ssh', 'git+https', 'ssh', 'https' ], 'domain': 'gist.github.com', - 'pathmatch': /^[/](?:([^/]+)[/])?([a-z0-9]+)(?:[.]git)?$/, + 'pathmatch': /^[/](?:([^/]+)[/])?([a-z0-9]{32,})(?:[.]git)?$/, 'filetemplate': 'https://gist.githubusercontent.com/{user}/{project}/raw{/committish}/{path}', 'bugstemplate': 'https://{domain}/{project}', 'gittemplate': 'git://{domain}/{project}.git{#committish}', 'sshtemplate': 'git@{domain}:/{project}.git{#committish}', 'sshurltemplate': 'git+ssh://git@{domain}/{project}.git{#committish}', 'browsetemplate': 'https://{domain}/{project}{/committish}', + 'browsefiletemplate': 'https://{domain}/{project}{/committish}{#path}', 'docstemplate': 'https://{domain}/{project}{/committish}', 'httpstemplate': 'git+https://{domain}/{project}.git{#committish}', 'shortcuttemplate': '{type}:{project}{#committish}', 'pathtemplate': '{project}{#committish}', - 'tarballtemplate': 'https://{domain}/{user}/{project}/archive/{committish}.tar.gz' + 'tarballtemplate': 'https://codeload.github.com/gist/{project}/tar.gz/{committish}', + 'hashformat': function (fragment) { + return 'file-' + formatHashFragment(fragment) + } } } @@ -29932,12 +29964,14 @@ var gitHostDefaults = { 'sshtemplate': 'git@{domain}:{user}/{project}.git{#committish}', 'sshurltemplate': 'git+ssh://git@{domain}/{user}/{project}.git{#committish}', 'browsetemplate': 'https://{domain}/{user}/{project}{/tree/committish}', + 'browsefiletemplate': 'https://{domain}/{user}/{project}/{treepath}/{committish}/{path}{#fragment}', 'docstemplate': 'https://{domain}/{user}/{project}{/tree/committish}#readme', 'httpstemplate': 'git+https://{auth@}{domain}/{user}/{project}.git{#committish}', 'filetemplate': 'https://{domain}/{user}/{project}/raw/{committish}/{path}', 'shortcuttemplate': '{type}:{user}/{project}{#committish}', 'pathtemplate': '{user}/{project}{#committish}', - 'pathmatch': /^[/]([^/]+)[/]([^/]+?)(?:[.]git|[/])?$/ + 'pathmatch': /^[/]([^/]+)[/]([^/]+?)(?:[.]git|[/])?$/, + 'hashformat': formatHashFragment } Object.keys(gitHosts).forEach(function (name) { @@ -29951,6 +29985,10 @@ Object.keys(gitHosts).forEach(function (name) { }).join('|') + '):$') }) +function formatHashFragment (fragment) { + return fragment.toLowerCase().replace(/^\W+|\/|\W+$/g, '').replace(/\W+/g, '-') +} + /***/ }), /* 285 */ @@ -29959,9 +29997,25 @@ Object.keys(gitHosts).forEach(function (name) { "use strict"; var gitHosts = __webpack_require__(284) -var extend = Object.assign || __webpack_require__(112)._extend +/* eslint-disable node/no-deprecated-api */ + +// copy-pasta util._extend from node's source, to avoid pulling +// the whole util module into peoples' webpack bundles. +/* istanbul ignore next */ +var extend = Object.assign || function _extend (target, source) { + // Don't do anything if source isn't an object + if (source === null || typeof source !== 'object') return target + + var keys = Object.keys(source) + var i = keys.length + while (i--) { + target[keys[i]] = source[keys[i]] + } + return target +} -var GitHost = module.exports = function (type, user, auth, project, committish, defaultRepresentation, opts) { +module.exports = GitHost +function GitHost (type, user, auth, project, committish, defaultRepresentation, opts) { var gitHostInfo = this gitHostInfo.type = type Object.keys(gitHosts[type]).forEach(function (key) { @@ -29974,7 +30028,6 @@ var GitHost = module.exports = function (type, user, auth, project, committish, gitHostInfo.default = defaultRepresentation gitHostInfo.opts = opts || {} } -GitHost.prototype = {} GitHost.prototype.hash = function () { return this.committish ? '#' + this.committish : '' @@ -29983,27 +30036,43 @@ GitHost.prototype.hash = function () { GitHost.prototype._fill = function (template, opts) { if (!template) return var vars = extend({}, opts) + vars.path = vars.path ? vars.path.replace(/^[/]+/g, '') : '' opts = extend(extend({}, this.opts), opts) var self = this Object.keys(this).forEach(function (key) { if (self[key] != null && vars[key] == null) vars[key] = self[key] }) var rawAuth = vars.auth - var rawComittish = vars.committish + var rawcommittish = vars.committish + var rawFragment = vars.fragment + var rawPath = vars.path + var rawProject = vars.project Object.keys(vars).forEach(function (key) { - vars[key] = encodeURIComponent(vars[key]) + var value = vars[key] + if ((key === 'path' || key === 'project') && typeof value === 'string') { + vars[key] = value.split('/').map(function (pathComponent) { + return encodeURIComponent(pathComponent) + }).join('/') + } else { + vars[key] = encodeURIComponent(value) + } }) vars['auth@'] = rawAuth ? rawAuth + '@' : '' + vars['#fragment'] = rawFragment ? '#' + this.hashformat(rawFragment) : '' + vars.fragment = vars.fragment ? vars.fragment : '' + vars['#path'] = rawPath ? '#' + this.hashformat(rawPath) : '' + vars['/path'] = vars.path ? '/' + vars.path : '' + vars.projectPath = rawProject.split('/').map(encodeURIComponent).join('/') if (opts.noCommittish) { vars['#committish'] = '' vars['/tree/committish'] = '' - vars['/comittish'] = '' - vars.comittish = '' + vars['/committish'] = '' + vars.committish = '' } else { - vars['#committish'] = rawComittish ? '#' + rawComittish : '' + vars['#committish'] = rawcommittish ? '#' + rawcommittish : '' vars['/tree/committish'] = vars.committish - ? '/' + vars.treepath + '/' + vars.committish - : '' + ? '/' + vars.treepath + '/' + vars.committish + : '' vars['/committish'] = vars.committish ? '/' + vars.committish : '' vars.committish = vars.committish || 'master' } @@ -30026,8 +30095,19 @@ GitHost.prototype.sshurl = function (opts) { return this._fill(this.sshurltemplate, opts) } -GitHost.prototype.browse = function (opts) { - return this._fill(this.browsetemplate, opts) +GitHost.prototype.browse = function (P, F, opts) { + if (typeof P === 'string') { + if (typeof F !== 'string') { + opts = F + F = null + } + return this._fill(this.browsefiletemplate, extend({ + fragment: F, + path: P + }, opts)) + } else { + return this._fill(this.browsetemplate, P) + } } GitHost.prototype.docs = function (opts) { @@ -30054,14 +30134,13 @@ GitHost.prototype.path = function (opts) { return this._fill(this.pathtemplate, opts) } -GitHost.prototype.tarball = function (opts) { +GitHost.prototype.tarball = function (opts_) { + var opts = extend({}, opts_, { noCommittish: false }) return this._fill(this.tarballtemplate, opts) } GitHost.prototype.file = function (P, opts) { - return this._fill(this.filetemplate, extend({ - path: P.replace(/^[/]+/g, '') - }, opts)) + return this._fill(this.filetemplate, extend({ path: P }, opts)) } GitHost.prototype.getDefaultRepresentation = function () { @@ -30069,7 +30148,8 @@ GitHost.prototype.getDefaultRepresentation = function () { } GitHost.prototype.toString = function (opts) { - return (this[this.default] || this.sshurl).call(this, opts) + if (this.default && typeof this[this.default] === 'function') return this[this.default](opts) + return this.sshurl(opts) } diff --git a/packages/kbn-server-http-tools/package.json b/packages/kbn-server-http-tools/package.json index 6c65a0dd6e47..24f8f8d67dfd 100644 --- a/packages/kbn-server-http-tools/package.json +++ b/packages/kbn-server-http-tools/package.json @@ -11,7 +11,6 @@ "kbn:watch": "yarn build --watch" }, "dependencies": { - "@kbn/config-schema": "link:../kbn-config-schema", "@kbn/crypto": "link:../kbn-crypto", "@kbn/std": "link:../kbn-std" }, diff --git a/packages/kbn-tinymath/BUILD.bazel b/packages/kbn-tinymath/BUILD.bazel new file mode 100644 index 000000000000..9d521776fb49 --- /dev/null +++ b/packages/kbn-tinymath/BUILD.bazel @@ -0,0 +1,71 @@ +load("@build_bazel_rules_nodejs//:index.bzl", "js_library", "pkg_npm") +load("@npm//pegjs:index.bzl", "pegjs") + +PKG_BASE_NAME = "kbn-tinymath" +PKG_REQUIRE_NAME = "@kbn/tinymath" + +SOURCE_FILES = glob( + [ + "src/**/*", + ] +) + +TYPE_FILES = [ + "index.d.ts", +] + +SRCS = SOURCE_FILES + TYPE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", + "README.md", +] + +DEPS = [ + "@npm//lodash", +] + +pegjs( + name = "grammar", + data = [ + ":grammar/grammar.pegjs" + ], + output_dir = True, + args = [ + "-o", + "$(@D)/index.js", + "./%s/grammar/grammar.pegjs" % package_name() + ], +) + +js_library( + name = PKG_BASE_NAME, + srcs = [ + ":srcs", + ":grammar" + ], + deps = DEPS, + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + srcs = NPM_MODULE_EXTRA_FILES, + deps = [ + ":%s" % PKG_BASE_NAME, + ] +) + +filegroup( + name = "build", + srcs = [ + ":npm_module", + ], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-tinymath/src/grammar.pegjs b/packages/kbn-tinymath/grammar/grammar.pegjs similarity index 99% rename from packages/kbn-tinymath/src/grammar.pegjs rename to packages/kbn-tinymath/grammar/grammar.pegjs index 9cb92fa9374a..70f275776e45 100644 --- a/packages/kbn-tinymath/src/grammar.pegjs +++ b/packages/kbn-tinymath/grammar/grammar.pegjs @@ -107,7 +107,7 @@ String / [\'] value:(ValidChar)+ [\'] { return value.join(''); } / value:(ValidChar)+ { return value.join(''); } - + Argument = name:[a-zA-Z_]+ _ '=' _ value:(Number / String) _ { return { diff --git a/packages/kbn-tinymath/tinymath.d.ts b/packages/kbn-tinymath/index.d.ts similarity index 100% rename from packages/kbn-tinymath/tinymath.d.ts rename to packages/kbn-tinymath/index.d.ts diff --git a/packages/kbn-tinymath/package.json b/packages/kbn-tinymath/package.json index cc4fa0a64d9c..915afda7ba2d 100644 --- a/packages/kbn-tinymath/package.json +++ b/packages/kbn-tinymath/package.json @@ -4,10 +4,5 @@ "license": "SSPL-1.0 OR Elastic License 2.0", "private": true, "main": "src/index.js", - "types": "tinymath.d.ts", - "scripts": { - "kbn:bootstrap": "yarn build", - "build": "../../node_modules/.bin/pegjs -o src/grammar.js src/grammar.pegjs" - }, - "dependencies": {} + "types": "index.d.ts" } \ No newline at end of file diff --git a/packages/kbn-tinymath/src/grammar.js b/packages/kbn-tinymath/src/grammar.js deleted file mode 100644 index 5454143530c3..000000000000 --- a/packages/kbn-tinymath/src/grammar.js +++ /dev/null @@ -1,1555 +0,0 @@ -/* - * Generated by PEG.js 0.10.0. - * - * http://pegjs.org/ - */ - -"use strict"; - -function peg$subclass(child, parent) { - function ctor() { this.constructor = child; } - ctor.prototype = parent.prototype; - child.prototype = new ctor(); -} - -function peg$SyntaxError(message, expected, found, location) { - this.message = message; - this.expected = expected; - this.found = found; - this.location = location; - this.name = "SyntaxError"; - - if (typeof Error.captureStackTrace === "function") { - Error.captureStackTrace(this, peg$SyntaxError); - } -} - -peg$subclass(peg$SyntaxError, Error); - -peg$SyntaxError.buildMessage = function(expected, found) { - var DESCRIBE_EXPECTATION_FNS = { - literal: function(expectation) { - return "\"" + literalEscape(expectation.text) + "\""; - }, - - "class": function(expectation) { - var escapedParts = "", - i; - - for (i = 0; i < expectation.parts.length; i++) { - escapedParts += expectation.parts[i] instanceof Array - ? classEscape(expectation.parts[i][0]) + "-" + classEscape(expectation.parts[i][1]) - : classEscape(expectation.parts[i]); - } - - return "[" + (expectation.inverted ? "^" : "") + escapedParts + "]"; - }, - - any: function(expectation) { - return "any character"; - }, - - end: function(expectation) { - return "end of input"; - }, - - other: function(expectation) { - return expectation.description; - } - }; - - function hex(ch) { - return ch.charCodeAt(0).toString(16).toUpperCase(); - } - - function literalEscape(s) { - return s - .replace(/\\/g, '\\\\') - .replace(/"/g, '\\"') - .replace(/\0/g, '\\0') - .replace(/\t/g, '\\t') - .replace(/\n/g, '\\n') - .replace(/\r/g, '\\r') - .replace(/[\x00-\x0F]/g, function(ch) { return '\\x0' + hex(ch); }) - .replace(/[\x10-\x1F\x7F-\x9F]/g, function(ch) { return '\\x' + hex(ch); }); - } - - function classEscape(s) { - return s - .replace(/\\/g, '\\\\') - .replace(/\]/g, '\\]') - .replace(/\^/g, '\\^') - .replace(/-/g, '\\-') - .replace(/\0/g, '\\0') - .replace(/\t/g, '\\t') - .replace(/\n/g, '\\n') - .replace(/\r/g, '\\r') - .replace(/[\x00-\x0F]/g, function(ch) { return '\\x0' + hex(ch); }) - .replace(/[\x10-\x1F\x7F-\x9F]/g, function(ch) { return '\\x' + hex(ch); }); - } - - function describeExpectation(expectation) { - return DESCRIBE_EXPECTATION_FNS[expectation.type](expectation); - } - - function describeExpected(expected) { - var descriptions = new Array(expected.length), - i, j; - - for (i = 0; i < expected.length; i++) { - descriptions[i] = describeExpectation(expected[i]); - } - - descriptions.sort(); - - if (descriptions.length > 0) { - for (i = 1, j = 1; i < descriptions.length; i++) { - if (descriptions[i - 1] !== descriptions[i]) { - descriptions[j] = descriptions[i]; - j++; - } - } - descriptions.length = j; - } - - switch (descriptions.length) { - case 1: - return descriptions[0]; - - case 2: - return descriptions[0] + " or " + descriptions[1]; - - default: - return descriptions.slice(0, -1).join(", ") - + ", or " - + descriptions[descriptions.length - 1]; - } - } - - function describeFound(found) { - return found ? "\"" + literalEscape(found) + "\"" : "end of input"; - } - - return "Expected " + describeExpected(expected) + " but " + describeFound(found) + " found."; -}; - -function peg$parse(input, options) { - options = options !== void 0 ? options : {}; - - var peg$FAILED = {}, - - peg$startRuleFunctions = { start: peg$parsestart }, - peg$startRuleFunction = peg$parsestart, - - peg$c0 = peg$otherExpectation("whitespace"), - peg$c1 = /^[ \t\n\r]/, - peg$c2 = peg$classExpectation([" ", "\t", "\n", "\r"], false, false), - peg$c3 = /^[ ]/, - peg$c4 = peg$classExpectation([" "], false, false), - peg$c5 = /^["']/, - peg$c6 = peg$classExpectation(["\"", "'"], false, false), - peg$c7 = /^[A-Za-z_@.[\]\-]/, - peg$c8 = peg$classExpectation([["A", "Z"], ["a", "z"], "_", "@", ".", "[", "]", "-"], false, false), - peg$c9 = /^[0-9A-Za-z._@[\]\-]/, - peg$c10 = peg$classExpectation([["0", "9"], ["A", "Z"], ["a", "z"], ".", "_", "@", "[", "]", "-"], false, false), - peg$c11 = peg$otherExpectation("literal"), - peg$c12 = function(literal) { - return literal; - }, - peg$c13 = function(chars) { - return { - type: 'variable', - value: chars.join(''), - location: simpleLocation(location()), - text: text() - }; - }, - peg$c14 = function(rest) { - return { - type: 'variable', - value: rest.join(''), - location: simpleLocation(location()), - text: text() - }; - }, - peg$c15 = "+", - peg$c16 = peg$literalExpectation("+", false), - peg$c17 = "-", - peg$c18 = peg$literalExpectation("-", false), - peg$c19 = function(left, rest) { - return rest.reduce((acc, curr) => ({ - type: 'function', - name: curr[0] === '+' ? 'add' : 'subtract', - args: [acc, curr[1]], - location: simpleLocation(location()), - text: text() - }), left) - }, - peg$c20 = "*", - peg$c21 = peg$literalExpectation("*", false), - peg$c22 = "/", - peg$c23 = peg$literalExpectation("/", false), - peg$c24 = function(left, rest) { - return rest.reduce((acc, curr) => ({ - type: 'function', - name: curr[0] === '*' ? 'multiply' : 'divide', - args: [acc, curr[1]], - location: simpleLocation(location()), - text: text() - }), left) - }, - peg$c25 = "(", - peg$c26 = peg$literalExpectation("(", false), - peg$c27 = ")", - peg$c28 = peg$literalExpectation(")", false), - peg$c29 = function(expr) { - return expr - }, - peg$c30 = peg$otherExpectation("arguments"), - peg$c31 = ",", - peg$c32 = peg$literalExpectation(",", false), - peg$c33 = function(first, arg) {return arg}, - peg$c34 = function(first, rest) { - return [first].concat(rest); - }, - peg$c35 = /^["]/, - peg$c36 = peg$classExpectation(["\""], false, false), - peg$c37 = function(value) { return value.join(''); }, - peg$c38 = /^[']/, - peg$c39 = peg$classExpectation(["'"], false, false), - peg$c40 = /^[a-zA-Z_]/, - peg$c41 = peg$classExpectation([["a", "z"], ["A", "Z"], "_"], false, false), - peg$c42 = "=", - peg$c43 = peg$literalExpectation("=", false), - peg$c44 = function(name, value) { - return { - type: 'namedArgument', - name: name.join(''), - value: value, - location: simpleLocation(location()), - text: text() - }; - }, - peg$c45 = peg$otherExpectation("function"), - peg$c46 = /^[a-zA-Z_\-]/, - peg$c47 = peg$classExpectation([["a", "z"], ["A", "Z"], "_", "-"], false, false), - peg$c48 = function(name, args) { - return { - type: 'function', - name: name.join(''), - args: args || [], - location: simpleLocation(location()), - text: text() - }; - }, - peg$c49 = peg$otherExpectation("number"), - peg$c50 = function() { - return parseFloat(text()); - }, - peg$c51 = /^[eE]/, - peg$c52 = peg$classExpectation(["e", "E"], false, false), - peg$c53 = peg$otherExpectation("exponent"), - peg$c54 = ".", - peg$c55 = peg$literalExpectation(".", false), - peg$c56 = "0", - peg$c57 = peg$literalExpectation("0", false), - peg$c58 = /^[1-9]/, - peg$c59 = peg$classExpectation([["1", "9"]], false, false), - peg$c60 = /^[0-9]/, - peg$c61 = peg$classExpectation([["0", "9"]], false, false), - - peg$currPos = 0, - peg$savedPos = 0, - peg$posDetailsCache = [{ line: 1, column: 1 }], - peg$maxFailPos = 0, - peg$maxFailExpected = [], - peg$silentFails = 0, - - peg$result; - - if ("startRule" in options) { - if (!(options.startRule in peg$startRuleFunctions)) { - throw new Error("Can't start parsing from rule \"" + options.startRule + "\"."); - } - - peg$startRuleFunction = peg$startRuleFunctions[options.startRule]; - } - - function text() { - return input.substring(peg$savedPos, peg$currPos); - } - - function location() { - return peg$computeLocation(peg$savedPos, peg$currPos); - } - - function expected(description, location) { - location = location !== void 0 ? location : peg$computeLocation(peg$savedPos, peg$currPos) - - throw peg$buildStructuredError( - [peg$otherExpectation(description)], - input.substring(peg$savedPos, peg$currPos), - location - ); - } - - function error(message, location) { - location = location !== void 0 ? location : peg$computeLocation(peg$savedPos, peg$currPos) - - throw peg$buildSimpleError(message, location); - } - - function peg$literalExpectation(text, ignoreCase) { - return { type: "literal", text: text, ignoreCase: ignoreCase }; - } - - function peg$classExpectation(parts, inverted, ignoreCase) { - return { type: "class", parts: parts, inverted: inverted, ignoreCase: ignoreCase }; - } - - function peg$anyExpectation() { - return { type: "any" }; - } - - function peg$endExpectation() { - return { type: "end" }; - } - - function peg$otherExpectation(description) { - return { type: "other", description: description }; - } - - function peg$computePosDetails(pos) { - var details = peg$posDetailsCache[pos], p; - - if (details) { - return details; - } else { - p = pos - 1; - while (!peg$posDetailsCache[p]) { - p--; - } - - details = peg$posDetailsCache[p]; - details = { - line: details.line, - column: details.column - }; - - while (p < pos) { - if (input.charCodeAt(p) === 10) { - details.line++; - details.column = 1; - } else { - details.column++; - } - - p++; - } - - peg$posDetailsCache[pos] = details; - return details; - } - } - - function peg$computeLocation(startPos, endPos) { - var startPosDetails = peg$computePosDetails(startPos), - endPosDetails = peg$computePosDetails(endPos); - - return { - start: { - offset: startPos, - line: startPosDetails.line, - column: startPosDetails.column - }, - end: { - offset: endPos, - line: endPosDetails.line, - column: endPosDetails.column - } - }; - } - - function peg$fail(expected) { - if (peg$currPos < peg$maxFailPos) { return; } - - if (peg$currPos > peg$maxFailPos) { - peg$maxFailPos = peg$currPos; - peg$maxFailExpected = []; - } - - peg$maxFailExpected.push(expected); - } - - function peg$buildSimpleError(message, location) { - return new peg$SyntaxError(message, null, null, location); - } - - function peg$buildStructuredError(expected, found, location) { - return new peg$SyntaxError( - peg$SyntaxError.buildMessage(expected, found), - expected, - found, - location - ); - } - - function peg$parsestart() { - var s0; - - s0 = peg$parseAddSubtract(); - - return s0; - } - - function peg$parse_() { - var s0, s1; - - peg$silentFails++; - s0 = []; - if (peg$c1.test(input.charAt(peg$currPos))) { - s1 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c2); } - } - while (s1 !== peg$FAILED) { - s0.push(s1); - if (peg$c1.test(input.charAt(peg$currPos))) { - s1 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c2); } - } - } - peg$silentFails--; - if (s0 === peg$FAILED) { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c0); } - } - - return s0; - } - - function peg$parseSpace() { - var s0; - - if (peg$c3.test(input.charAt(peg$currPos))) { - s0 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c4); } - } - - return s0; - } - - function peg$parseQuote() { - var s0; - - if (peg$c5.test(input.charAt(peg$currPos))) { - s0 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c6); } - } - - return s0; - } - - function peg$parseStartChar() { - var s0; - - if (peg$c7.test(input.charAt(peg$currPos))) { - s0 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c8); } - } - - return s0; - } - - function peg$parseValidChar() { - var s0; - - if (peg$c9.test(input.charAt(peg$currPos))) { - s0 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c10); } - } - - return s0; - } - - function peg$parseLiteral() { - var s0, s1, s2, s3; - - peg$silentFails++; - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - s2 = peg$parseNumber(); - if (s2 === peg$FAILED) { - s2 = peg$parseVariable(); - } - if (s2 !== peg$FAILED) { - s3 = peg$parse_(); - if (s3 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c12(s2); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - peg$silentFails--; - if (s0 === peg$FAILED) { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c11); } - } - - return s0; - } - - function peg$parseVariable() { - var s0, s1, s2, s3, s4, s5; - - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - s2 = peg$parseQuote(); - if (s2 !== peg$FAILED) { - s3 = []; - s4 = peg$parseValidChar(); - if (s4 === peg$FAILED) { - s4 = peg$parseSpace(); - } - while (s4 !== peg$FAILED) { - s3.push(s4); - s4 = peg$parseValidChar(); - if (s4 === peg$FAILED) { - s4 = peg$parseSpace(); - } - } - if (s3 !== peg$FAILED) { - s4 = peg$parseQuote(); - if (s4 !== peg$FAILED) { - s5 = peg$parse_(); - if (s5 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c13(s3); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - if (s0 === peg$FAILED) { - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - s2 = []; - s3 = peg$parseValidChar(); - if (s3 !== peg$FAILED) { - while (s3 !== peg$FAILED) { - s2.push(s3); - s3 = peg$parseValidChar(); - } - } else { - s2 = peg$FAILED; - } - if (s2 !== peg$FAILED) { - s3 = peg$parse_(); - if (s3 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c14(s2); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } - - return s0; - } - - function peg$parseAddSubtract() { - var s0, s1, s2, s3, s4, s5, s6; - - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - s2 = peg$parseMultiplyDivide(); - if (s2 !== peg$FAILED) { - s3 = []; - s4 = peg$currPos; - if (input.charCodeAt(peg$currPos) === 43) { - s5 = peg$c15; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c16); } - } - if (s5 === peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 45) { - s5 = peg$c17; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c18); } - } - } - if (s5 !== peg$FAILED) { - s6 = peg$parseMultiplyDivide(); - if (s6 !== peg$FAILED) { - s5 = [s5, s6]; - s4 = s5; - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - while (s4 !== peg$FAILED) { - s3.push(s4); - s4 = peg$currPos; - if (input.charCodeAt(peg$currPos) === 43) { - s5 = peg$c15; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c16); } - } - if (s5 === peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 45) { - s5 = peg$c17; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c18); } - } - } - if (s5 !== peg$FAILED) { - s6 = peg$parseMultiplyDivide(); - if (s6 !== peg$FAILED) { - s5 = [s5, s6]; - s4 = s5; - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - } - if (s3 !== peg$FAILED) { - s4 = peg$parse_(); - if (s4 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c19(s2, s3); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - - return s0; - } - - function peg$parseMultiplyDivide() { - var s0, s1, s2, s3, s4, s5, s6; - - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - s2 = peg$parseFactor(); - if (s2 !== peg$FAILED) { - s3 = []; - s4 = peg$currPos; - if (input.charCodeAt(peg$currPos) === 42) { - s5 = peg$c20; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c21); } - } - if (s5 === peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 47) { - s5 = peg$c22; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c23); } - } - } - if (s5 !== peg$FAILED) { - s6 = peg$parseFactor(); - if (s6 !== peg$FAILED) { - s5 = [s5, s6]; - s4 = s5; - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - while (s4 !== peg$FAILED) { - s3.push(s4); - s4 = peg$currPos; - if (input.charCodeAt(peg$currPos) === 42) { - s5 = peg$c20; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c21); } - } - if (s5 === peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 47) { - s5 = peg$c22; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c23); } - } - } - if (s5 !== peg$FAILED) { - s6 = peg$parseFactor(); - if (s6 !== peg$FAILED) { - s5 = [s5, s6]; - s4 = s5; - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - } else { - peg$currPos = s4; - s4 = peg$FAILED; - } - } - if (s3 !== peg$FAILED) { - s4 = peg$parse_(); - if (s4 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c24(s2, s3); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - - return s0; - } - - function peg$parseFactor() { - var s0; - - s0 = peg$parseGroup(); - if (s0 === peg$FAILED) { - s0 = peg$parseFunction(); - if (s0 === peg$FAILED) { - s0 = peg$parseLiteral(); - } - } - - return s0; - } - - function peg$parseGroup() { - var s0, s1, s2, s3, s4, s5, s6, s7; - - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 40) { - s2 = peg$c25; - peg$currPos++; - } else { - s2 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c26); } - } - if (s2 !== peg$FAILED) { - s3 = peg$parse_(); - if (s3 !== peg$FAILED) { - s4 = peg$parseAddSubtract(); - if (s4 !== peg$FAILED) { - s5 = peg$parse_(); - if (s5 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 41) { - s6 = peg$c27; - peg$currPos++; - } else { - s6 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c28); } - } - if (s6 !== peg$FAILED) { - s7 = peg$parse_(); - if (s7 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c29(s4); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - - return s0; - } - - function peg$parseArgument_List() { - var s0, s1, s2, s3, s4, s5, s6, s7; - - peg$silentFails++; - s0 = peg$currPos; - s1 = peg$parseArgument(); - if (s1 !== peg$FAILED) { - s2 = []; - s3 = peg$currPos; - s4 = peg$parse_(); - if (s4 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 44) { - s5 = peg$c31; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c32); } - } - if (s5 !== peg$FAILED) { - s6 = peg$parse_(); - if (s6 !== peg$FAILED) { - s7 = peg$parseArgument(); - if (s7 !== peg$FAILED) { - peg$savedPos = s3; - s4 = peg$c33(s1, s7); - s3 = s4; - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - while (s3 !== peg$FAILED) { - s2.push(s3); - s3 = peg$currPos; - s4 = peg$parse_(); - if (s4 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 44) { - s5 = peg$c31; - peg$currPos++; - } else { - s5 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c32); } - } - if (s5 !== peg$FAILED) { - s6 = peg$parse_(); - if (s6 !== peg$FAILED) { - s7 = peg$parseArgument(); - if (s7 !== peg$FAILED) { - peg$savedPos = s3; - s4 = peg$c33(s1, s7); - s3 = s4; - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } else { - peg$currPos = s3; - s3 = peg$FAILED; - } - } - if (s2 !== peg$FAILED) { - s3 = peg$parse_(); - if (s3 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 44) { - s4 = peg$c31; - peg$currPos++; - } else { - s4 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c32); } - } - if (s4 === peg$FAILED) { - s4 = null; - } - if (s4 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c34(s1, s2); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - peg$silentFails--; - if (s0 === peg$FAILED) { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c30); } - } - - return s0; - } - - function peg$parseString() { - var s0, s1, s2, s3; - - s0 = peg$currPos; - if (peg$c35.test(input.charAt(peg$currPos))) { - s1 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c36); } - } - if (s1 !== peg$FAILED) { - s2 = []; - s3 = peg$parseValidChar(); - if (s3 !== peg$FAILED) { - while (s3 !== peg$FAILED) { - s2.push(s3); - s3 = peg$parseValidChar(); - } - } else { - s2 = peg$FAILED; - } - if (s2 !== peg$FAILED) { - if (peg$c35.test(input.charAt(peg$currPos))) { - s3 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s3 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c36); } - } - if (s3 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c37(s2); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - if (s0 === peg$FAILED) { - s0 = peg$currPos; - if (peg$c38.test(input.charAt(peg$currPos))) { - s1 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c39); } - } - if (s1 !== peg$FAILED) { - s2 = []; - s3 = peg$parseValidChar(); - if (s3 !== peg$FAILED) { - while (s3 !== peg$FAILED) { - s2.push(s3); - s3 = peg$parseValidChar(); - } - } else { - s2 = peg$FAILED; - } - if (s2 !== peg$FAILED) { - if (peg$c38.test(input.charAt(peg$currPos))) { - s3 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s3 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c39); } - } - if (s3 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c37(s2); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - if (s0 === peg$FAILED) { - s0 = peg$currPos; - s1 = []; - s2 = peg$parseValidChar(); - if (s2 !== peg$FAILED) { - while (s2 !== peg$FAILED) { - s1.push(s2); - s2 = peg$parseValidChar(); - } - } else { - s1 = peg$FAILED; - } - if (s1 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c37(s1); - } - s0 = s1; - } - } - - return s0; - } - - function peg$parseArgument() { - var s0, s1, s2, s3, s4, s5, s6; - - s0 = peg$currPos; - s1 = []; - if (peg$c40.test(input.charAt(peg$currPos))) { - s2 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s2 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c41); } - } - if (s2 !== peg$FAILED) { - while (s2 !== peg$FAILED) { - s1.push(s2); - if (peg$c40.test(input.charAt(peg$currPos))) { - s2 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s2 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c41); } - } - } - } else { - s1 = peg$FAILED; - } - if (s1 !== peg$FAILED) { - s2 = peg$parse_(); - if (s2 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 61) { - s3 = peg$c42; - peg$currPos++; - } else { - s3 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c43); } - } - if (s3 !== peg$FAILED) { - s4 = peg$parse_(); - if (s4 !== peg$FAILED) { - s5 = peg$parseNumber(); - if (s5 === peg$FAILED) { - s5 = peg$parseString(); - } - if (s5 !== peg$FAILED) { - s6 = peg$parse_(); - if (s6 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c44(s1, s5); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - if (s0 === peg$FAILED) { - s0 = peg$parseAddSubtract(); - } - - return s0; - } - - function peg$parseFunction() { - var s0, s1, s2, s3, s4, s5, s6, s7, s8; - - peg$silentFails++; - s0 = peg$currPos; - s1 = peg$parse_(); - if (s1 !== peg$FAILED) { - s2 = []; - if (peg$c46.test(input.charAt(peg$currPos))) { - s3 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s3 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c47); } - } - if (s3 !== peg$FAILED) { - while (s3 !== peg$FAILED) { - s2.push(s3); - if (peg$c46.test(input.charAt(peg$currPos))) { - s3 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s3 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c47); } - } - } - } else { - s2 = peg$FAILED; - } - if (s2 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 40) { - s3 = peg$c25; - peg$currPos++; - } else { - s3 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c26); } - } - if (s3 !== peg$FAILED) { - s4 = peg$parse_(); - if (s4 !== peg$FAILED) { - s5 = peg$parseArgument_List(); - if (s5 === peg$FAILED) { - s5 = null; - } - if (s5 !== peg$FAILED) { - s6 = peg$parse_(); - if (s6 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 41) { - s7 = peg$c27; - peg$currPos++; - } else { - s7 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c28); } - } - if (s7 !== peg$FAILED) { - s8 = peg$parse_(); - if (s8 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c48(s2, s5); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - peg$silentFails--; - if (s0 === peg$FAILED) { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c45); } - } - - return s0; - } - - function peg$parseNumber() { - var s0, s1, s2, s3, s4; - - peg$silentFails++; - s0 = peg$currPos; - if (input.charCodeAt(peg$currPos) === 45) { - s1 = peg$c17; - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c18); } - } - if (s1 === peg$FAILED) { - s1 = null; - } - if (s1 !== peg$FAILED) { - s2 = peg$parseInteger(); - if (s2 !== peg$FAILED) { - s3 = peg$parseFraction(); - if (s3 === peg$FAILED) { - s3 = null; - } - if (s3 !== peg$FAILED) { - s4 = peg$parseExp(); - if (s4 === peg$FAILED) { - s4 = null; - } - if (s4 !== peg$FAILED) { - peg$savedPos = s0; - s1 = peg$c50(); - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - peg$silentFails--; - if (s0 === peg$FAILED) { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c49); } - } - - return s0; - } - - function peg$parseE() { - var s0; - - if (peg$c51.test(input.charAt(peg$currPos))) { - s0 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c52); } - } - - return s0; - } - - function peg$parseExp() { - var s0, s1, s2, s3, s4; - - peg$silentFails++; - s0 = peg$currPos; - s1 = peg$parseE(); - if (s1 !== peg$FAILED) { - if (input.charCodeAt(peg$currPos) === 45) { - s2 = peg$c17; - peg$currPos++; - } else { - s2 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c18); } - } - if (s2 === peg$FAILED) { - s2 = null; - } - if (s2 !== peg$FAILED) { - s3 = []; - s4 = peg$parseDigit(); - if (s4 !== peg$FAILED) { - while (s4 !== peg$FAILED) { - s3.push(s4); - s4 = peg$parseDigit(); - } - } else { - s3 = peg$FAILED; - } - if (s3 !== peg$FAILED) { - s1 = [s1, s2, s3]; - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - peg$silentFails--; - if (s0 === peg$FAILED) { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c53); } - } - - return s0; - } - - function peg$parseFraction() { - var s0, s1, s2, s3; - - s0 = peg$currPos; - if (input.charCodeAt(peg$currPos) === 46) { - s1 = peg$c54; - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c55); } - } - if (s1 !== peg$FAILED) { - s2 = []; - s3 = peg$parseDigit(); - if (s3 !== peg$FAILED) { - while (s3 !== peg$FAILED) { - s2.push(s3); - s3 = peg$parseDigit(); - } - } else { - s2 = peg$FAILED; - } - if (s2 !== peg$FAILED) { - s1 = [s1, s2]; - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - - return s0; - } - - function peg$parseInteger() { - var s0, s1, s2, s3; - - if (input.charCodeAt(peg$currPos) === 48) { - s0 = peg$c56; - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c57); } - } - if (s0 === peg$FAILED) { - s0 = peg$currPos; - if (peg$c58.test(input.charAt(peg$currPos))) { - s1 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s1 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c59); } - } - if (s1 !== peg$FAILED) { - s2 = []; - s3 = peg$parseDigit(); - while (s3 !== peg$FAILED) { - s2.push(s3); - s3 = peg$parseDigit(); - } - if (s2 !== peg$FAILED) { - s1 = [s1, s2]; - s0 = s1; - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } else { - peg$currPos = s0; - s0 = peg$FAILED; - } - } - - return s0; - } - - function peg$parseDigit() { - var s0; - - if (peg$c60.test(input.charAt(peg$currPos))) { - s0 = input.charAt(peg$currPos); - peg$currPos++; - } else { - s0 = peg$FAILED; - if (peg$silentFails === 0) { peg$fail(peg$c61); } - } - - return s0; - } - - - function simpleLocation (location) { - // Returns an object representing the position of the function within the expression, - // demarcated by the position of its first character and last character. We calculate these values - // using the offset because the expression could span multiple lines, and we don't want to deal - // with column and line values. - return { - min: location.start.offset, - max: location.end.offset - } - } - - - peg$result = peg$startRuleFunction(); - - if (peg$result !== peg$FAILED && peg$currPos === input.length) { - return peg$result; - } else { - if (peg$result !== peg$FAILED && peg$currPos < input.length) { - peg$fail(peg$endExpectation()); - } - - throw peg$buildStructuredError( - peg$maxFailExpected, - peg$maxFailPos < input.length ? input.charAt(peg$maxFailPos) : null, - peg$maxFailPos < input.length - ? peg$computeLocation(peg$maxFailPos, peg$maxFailPos + 1) - : peg$computeLocation(peg$maxFailPos, peg$maxFailPos) - ); - } -} - -module.exports = { - SyntaxError: peg$SyntaxError, - parse: peg$parse -}; diff --git a/packages/kbn-tinymath/src/index.js b/packages/kbn-tinymath/src/index.js index 4db7df9c5731..9f1bb7b85146 100644 --- a/packages/kbn-tinymath/src/index.js +++ b/packages/kbn-tinymath/src/index.js @@ -7,7 +7,8 @@ */ const { get } = require('lodash'); -const { parse: parseFn } = require('./grammar'); +// eslint-disable-next-line import/no-unresolved +const { parse: parseFn } = require('../grammar'); const { functions: includedFunctions } = require('./functions'); module.exports = { parse, evaluate, interpret }; diff --git a/packages/kbn-tinymath/test/library.test.js b/packages/kbn-tinymath/test/library.test.js index d11822625b98..5ddf1b049b8d 100644 --- a/packages/kbn-tinymath/test/library.test.js +++ b/packages/kbn-tinymath/test/library.test.js @@ -11,7 +11,7 @@ Need tests for spacing, etc */ -import { evaluate, parse } from '..'; +import { evaluate, parse } from '@kbn/tinymath'; function variableEqual(value) { return expect.objectContaining({ type: 'variable', value }); diff --git a/packages/kbn-tinymath/tsconfig.json b/packages/kbn-tinymath/tsconfig.json index 62a7376efdfa..73133b7318a0 100644 --- a/packages/kbn-tinymath/tsconfig.json +++ b/packages/kbn-tinymath/tsconfig.json @@ -1,7 +1,4 @@ { "extends": "../../tsconfig.base.json", - "compilerOptions": { - "tsBuildInfoFile": "../../build/tsbuildinfo/packages/kbn-tinymath" - }, - "include": ["tinymath.d.ts"] + "include": ["index.d.ts"] } diff --git a/packages/kbn-utility-types/BUILD.bazel b/packages/kbn-utility-types/BUILD.bazel new file mode 100644 index 000000000000..e22ba38b24a4 --- /dev/null +++ b/packages/kbn-utility-types/BUILD.bazel @@ -0,0 +1,80 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config", "ts_project") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library", "pkg_npm") + +PKG_BASE_NAME = "kbn-utility-types" +PKG_REQUIRE_NAME = "@kbn/utility-types" + +SOURCE_FILES = glob([ + "jest/index.ts", + "index.ts" +]) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "jest/package.json", + "package.json", + "README.md", +] + +SRC_DEPS = [ + "@npm//utility-types", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +DEPS = SRC_DEPS + TYPES_DEPS + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + ], +) + +ts_project( + name = "tsc", + args = ['--pretty'], + srcs = SRCS, + deps = DEPS, + declaration = True, + declaration_map = True, + incremental = True, + out_dir = "target", + source_map = True, + root_dir = ".", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_BASE_NAME, + srcs = [], + deps = [":tsc"] + DEPS, + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + srcs = NPM_MODULE_EXTRA_FILES, + deps = [ + ":%s" % PKG_BASE_NAME, + ] +) + +filegroup( + name = "build", + srcs = [ + ":npm_module", + ], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-utility-types/package.json b/packages/kbn-utility-types/package.json index ad7dcc6b906c..95fbd5d00f39 100644 --- a/packages/kbn-utility-types/package.json +++ b/packages/kbn-utility-types/package.json @@ -9,10 +9,6 @@ "devOnly": false }, "scripts": { - "build": "../../node_modules/.bin/tsc", - "kbn:bootstrap": "../../node_modules/.bin/tsc", - "kbn:watch": "../../node_modules/.bin/tsc --watch", - "test": "../../node_modules/.bin/tsd", - "clean": "../../node_modules/.bin/del target" + "test": "../../node_modules/.bin/tsd tsd_tests" } } \ No newline at end of file diff --git a/packages/kbn-utility-types/tsconfig.json b/packages/kbn-utility-types/tsconfig.json index cfa782e5d38d..50fa71155bee 100644 --- a/packages/kbn-utility-types/tsconfig.json +++ b/packages/kbn-utility-types/tsconfig.json @@ -1,12 +1,12 @@ { "extends": "../../tsconfig.base.json", "compilerOptions": { - "incremental": false, + "incremental": true, "outDir": "./target", - "declarationDir": "./target", "stripInternal": true, "declaration": true, "declarationMap": true, + "rootDir": "./", "sourceMap": true, "sourceRoot": "../../../../packages/kbn-utility-types", "types": [ @@ -17,6 +17,6 @@ "include": [ "index.ts", "jest/**/*", - "test-d/**/*" + "tsd_tests/**/*" ] } diff --git a/packages/kbn-utility-types/tsd_tests/empty.d.ts b/packages/kbn-utility-types/tsd_tests/empty.d.ts new file mode 100644 index 000000000000..c5184fc78704 --- /dev/null +++ b/packages/kbn-utility-types/tsd_tests/empty.d.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +// This is just an empty mock file to provide a workaround to run tsd correctly isolated diff --git a/packages/kbn-utility-types/tsd_tests/package.json b/packages/kbn-utility-types/tsd_tests/package.json new file mode 100644 index 000000000000..fb549abca319 --- /dev/null +++ b/packages/kbn-utility-types/tsd_tests/package.json @@ -0,0 +1,9 @@ +{ + "types": "empty.d.ts", + "tsd": { + "directory": "test_d", + "compilerOptions": { + "rootDir": "../" + } + } +} \ No newline at end of file diff --git a/packages/kbn-utility-types/test-d/method_keys_of.ts b/packages/kbn-utility-types/tsd_tests/test_d/method_keys_of.ts similarity index 84% rename from packages/kbn-utility-types/test-d/method_keys_of.ts rename to packages/kbn-utility-types/tsd_tests/test_d/method_keys_of.ts index 03ef517c76b6..6169f2d92f81 100644 --- a/packages/kbn-utility-types/test-d/method_keys_of.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/method_keys_of.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectType } from 'tsd'; -import { MethodKeysOf } from '../index'; +import { MethodKeysOf } from '../../index'; class Test { public name: string = ''; diff --git a/packages/kbn-utility-types/test-d/public_contract.ts b/packages/kbn-utility-types/tsd_tests/test_d/public_contract.ts similarity index 83% rename from packages/kbn-utility-types/test-d/public_contract.ts rename to packages/kbn-utility-types/tsd_tests/test_d/public_contract.ts index 53e657084fec..ef488f42805e 100644 --- a/packages/kbn-utility-types/test-d/public_contract.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/public_contract.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectType } from 'tsd'; -import { PublicContract } from '../index'; +import { PublicContract } from '../../index'; class Test { public str: string = ''; diff --git a/packages/kbn-utility-types/test-d/public_keys.ts b/packages/kbn-utility-types/tsd_tests/test_d/public_keys.ts similarity index 83% rename from packages/kbn-utility-types/test-d/public_keys.ts rename to packages/kbn-utility-types/tsd_tests/test_d/public_keys.ts index d9377579f001..1674520daffb 100644 --- a/packages/kbn-utility-types/test-d/public_keys.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/public_keys.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectType } from 'tsd'; -import { PublicKeys } from '../index'; +import { PublicKeys } from '../../index'; class Test { public str: string = ''; diff --git a/packages/kbn-utility-types/test-d/public_methods_of.ts b/packages/kbn-utility-types/tsd_tests/test_d/public_methods_of.ts similarity index 88% rename from packages/kbn-utility-types/test-d/public_methods_of.ts rename to packages/kbn-utility-types/tsd_tests/test_d/public_methods_of.ts index 66754f847384..5db1117bf47f 100644 --- a/packages/kbn-utility-types/test-d/public_methods_of.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/public_methods_of.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectAssignable, expectNotAssignable } from 'tsd'; -import { PublicMethodsOf } from '../index'; +import { PublicMethodsOf } from '../../index'; class Test { public name: string = ''; diff --git a/packages/kbn-utility-types/test-d/shallow_promise.ts b/packages/kbn-utility-types/tsd_tests/test_d/shallow_promise.ts similarity index 87% rename from packages/kbn-utility-types/test-d/shallow_promise.ts rename to packages/kbn-utility-types/tsd_tests/test_d/shallow_promise.ts index 4b806a286062..712189f43bfe 100644 --- a/packages/kbn-utility-types/test-d/shallow_promise.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/shallow_promise.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectType } from 'tsd'; -import { ShallowPromise } from '../index'; +import { ShallowPromise } from '../../index'; type P1 = ShallowPromise; type P2 = ShallowPromise>; diff --git a/packages/kbn-utility-types/test-d/union_to_intersection.ts b/packages/kbn-utility-types/tsd_tests/test_d/union_to_intersection.ts similarity index 82% rename from packages/kbn-utility-types/test-d/union_to_intersection.ts rename to packages/kbn-utility-types/tsd_tests/test_d/union_to_intersection.ts index 07c8cfb4cfd3..a37cdc5160ed 100644 --- a/packages/kbn-utility-types/test-d/union_to_intersection.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/union_to_intersection.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectAssignable } from 'tsd'; -import { UnionToIntersection } from '../index'; +import { UnionToIntersection } from '../../index'; type INTERSECTED = UnionToIntersection<{ foo: 'bar' } | { baz: 'qux' }>; diff --git a/packages/kbn-utility-types/test-d/unwrap_observable.ts b/packages/kbn-utility-types/tsd_tests/test_d/unwrap_observable.ts similarity index 79% rename from packages/kbn-utility-types/test-d/unwrap_observable.ts rename to packages/kbn-utility-types/tsd_tests/test_d/unwrap_observable.ts index 667ae22984d9..beaf69234161 100644 --- a/packages/kbn-utility-types/test-d/unwrap_observable.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/unwrap_observable.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectAssignable } from 'tsd'; -import { UnwrapObservable, ObservableLike } from '../index'; +import { UnwrapObservable, ObservableLike } from '../../index'; type STRING = UnwrapObservable>; diff --git a/packages/kbn-utility-types/test-d/unwrap_promise.ts b/packages/kbn-utility-types/tsd_tests/test_d/unwrap_promise.ts similarity index 84% rename from packages/kbn-utility-types/test-d/unwrap_promise.ts rename to packages/kbn-utility-types/tsd_tests/test_d/unwrap_promise.ts index 9384f58f7fde..6491555b883b 100644 --- a/packages/kbn-utility-types/test-d/unwrap_promise.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/unwrap_promise.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectAssignable } from 'tsd'; -import { UnwrapPromise } from '../index'; +import { UnwrapPromise } from '../../index'; type STRING = UnwrapPromise>; type TUPLE = UnwrapPromise>; diff --git a/packages/kbn-utility-types/test-d/values.ts b/packages/kbn-utility-types/tsd_tests/test_d/values.ts similarity index 89% rename from packages/kbn-utility-types/test-d/values.ts rename to packages/kbn-utility-types/tsd_tests/test_d/values.ts index 099e94c6b549..aeb867b78e13 100644 --- a/packages/kbn-utility-types/test-d/values.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/values.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectAssignable } from 'tsd'; -import { Values } from '../index'; +import { Values } from '../../index'; // Arrays type STRING = Values; diff --git a/packages/kbn-utility-types/test-d/writable.ts b/packages/kbn-utility-types/tsd_tests/test_d/writable.ts similarity index 85% rename from packages/kbn-utility-types/test-d/writable.ts rename to packages/kbn-utility-types/tsd_tests/test_d/writable.ts index a9fbf4a1def8..cfaba555a798 100644 --- a/packages/kbn-utility-types/test-d/writable.ts +++ b/packages/kbn-utility-types/tsd_tests/test_d/writable.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +// eslint-disable-next-line import/no-extraneous-dependencies import { expectAssignable } from 'tsd'; -import { Writable } from '../index'; +import { Writable } from '../../index'; type WritableArray = Writable; expectAssignable(['1']); diff --git a/packages/kbn-utils/package.json b/packages/kbn-utils/package.json index b6bb7759c40e..2c3c0c11b65a 100644 --- a/packages/kbn-utils/package.json +++ b/packages/kbn-utils/package.json @@ -9,8 +9,5 @@ "build": "rm -rf target && ../../node_modules/.bin/tsc", "kbn:bootstrap": "yarn build", "kbn:watch": "yarn build --watch" - }, - "dependencies": { - "@kbn/config-schema": "link:../kbn-config-schema" } } \ No newline at end of file diff --git a/rfcs/text/0009_screenshot_mode_service.md b/rfcs/text/0009_screenshot_mode_service.md new file mode 100644 index 000000000000..11ceae29b5f1 --- /dev/null +++ b/rfcs/text/0009_screenshot_mode_service.md @@ -0,0 +1,151 @@ +- Start Date: 2020-03-02 +- RFC PR: (leave this empty) +- Kibana Issue: (leave this empty) + +# Summary + +Currently, the applications that support screenshot reports are: + - Dashboard + - Visualize Editor + - Canvas + +Kibana UI code should be aware when the page is rendering for the purpose of +capturing a screenshot. There should be a service to interact with low-level +code for providing that awareness. Reporting would interact with this service +to improve the quality of the Kibana Reporting feature for a few reasons: + + - Fewer objects in the headless browser memory since interactive code doesn't run + - Fewer API requests made by the headless browser for features that don't apply in a non-interactive context + +**Screenshot mode service** + +The Reporting-enabled applications should use the recommended practice of +having a customized URL for Reporting. The customized URL renders without UI +features like navigation, auto-complete, and anything else that wouldn't make +sense for non-interactive pages. + +However, applications are one piece of the UI code in a browser, and they have +dependencies on other UI plugins. Apps can't control plugins and other things +that Kibana loads in the browser. + +This RFC proposes a Screenshot Mode Service as a low-level plugin that allows +other plugins (UI code) to make choices when the page is rendering for a screenshot. + +More background on how Reporting currently works, including the lifecycle of +creating a PNG report, is here: https://github.com/elastic/kibana/issues/59396 + +# Motivation + +The Reporting team wants all applications to support a customized URLs, such as +Canvas does with its `#/export/workpad/pdf/{workpadId}` UI route. The +customized URL is where an app can solve any rendering issue in a PDF or PNG, +without needing extra CSS to be injected into the page. + +However, many low-level plugins have been added to the UI over time. These run +on every page and an application can not turn them off. Reporting performance +is negatively affected by this type of code. When the Reporting team analyzes +customer logs to figure out why a job timed out, we sometimes see requests for +the newsfeed API and telemetry API: services that aren't needed during a +reporting job. + +In 7.12.0, using the customized `/export/workpad/pdf` in Canvas, the Sample +Data Flights workpad loads 163 requests. Most of thees requests don't come from +the app itself but from the application container code that Canvas can't turn +off. + +# Detailed design + +The Screenshot Mode Service is an entirely new plugin that has an API method +that returns a Boolean. The return value tells the plugin whether or not it +should render itself to optimize for non-interactivity. + +The plugin is low-level as it has no dependencies of its own, so other +low-level plugins can depend on it. + +## Interface +A plugin would depend on `screenshotMode` in kibana.json. That provides +`screenshotMode` as a plugin object. The plugin's purpose is to know when the +page is rendered for screenshot capture, and to interact with plugins through +an API. It allows plugins to decides what to do with the screenshot mode +information. + +``` +interface IScreenshotModeServiceSetup { + isScreenshotMode: () => boolean; +} +``` + +The plugin knows the screenshot mode from request headers: this interface is +constructed from a class that refers to information sent via a custom +proprietary header: + +``` +interface HeaderData { + 'X-Screenshot-Mode': true +} + +class ScreenshotModeServiceSetup implements IScreenshotModeServiceSetup { + constructor(rawData: HeaderData) {} + public isScreenshotMode (): boolean {} +} +``` + +The Reporting headless browser that opens the page can inject custom headers +into the request. Teams should be able to test how their app renders when +loaded with this header. They could use a web debugging proxy, or perhaps the +new service should support a URL parameter which triggers screenshot mode to be +enabled, for easier testing. + +# Basic example + +When Kibana loads initially, there is a Newsfeed plugin in the UI that +checks internally cached records to see if it must fetch the Elastic News +Service for newer items. When the Screenshot Mode Service is implemented, the +Newsfeed component has a source of information to check on whether or not it +should load in the Kibana UI. If it can avoid loading, it avoids an unnecessary +HTTP round trip, which weigh heavily on performance. + +# Alternatives + +- Print media query CSS + If applications UIs supported printability using `@media print`, and Kibana + Reporting uses `page.print()` to capture the PDF, it would be easy for application + developers to test, and prevent bugs showing up in the report. + + However, this proposal only provides high-level customization over visual rendering, which the + application already has if it uses a customized URL for rendering the layout for screenshots. It + has a performance downside, as well: the headless browser still has to render the entire + page as a "normal" render before we can call `page.print()`. No one sees the + results of that initial render, so it is the same amount of wasted rendering cycles + during report generation that we have today. + +# Adoption strategy + +Using this service doesn't mean that anything needs to be replaced or thrown away. It's an add on +that any plugin or even application can use to add conditionals that previously weren't possible. +The Reporting Services team should create an example in a developer example plugin on how to build +a UI that is aware of Screenshot Mode Service. From there, the team would work on updating +whichever code that would benefit from this the most, which we know from analyzing debugging logs +of a report job. The team would work across teams to get it accepted by the owners. + +# How we teach this + +The Reporting Services team will continue to analyze debug logs of reporting jobs to find if there +is UI code running during a report job that could be optimized by this service. The team would +reach out to the code owners and determine if it makes sense to use this service to improve +screenshot performance of their code. + +# Further examples + +- Applications can also use screenshot context to customize the way they load. + An example is Toast Notifications: by default they auto-dismiss themselves + after 30 seconds or so. That makes sense when there is a human there to + notice the message, read it and remember it. But if the page is loaded for + capturing a screenshot, the toast notifications should never disappear. The + message in the toast needs to be part of the screenshot for its message to + mean anything, so it should not force the screenshot capture tool to race + against the toast timeout window. +- Avoid collection and sending of telemetry from the browser when page is + loaded for screenshot capture. +- Turn off autocomplete features and auto-refresh features that weigh on + performance for screenshot capture. diff --git a/src/cli_plugin/list/list.js b/src/cli_plugin/list/list.js index a30334aaf554..6e59258ab0f1 100644 --- a/src/cli_plugin/list/list.js +++ b/src/cli_plugin/list/list.js @@ -10,19 +10,22 @@ import { statSync, readdirSync, readFileSync } from 'fs'; import { join } from 'path'; export function list(pluginDir, logger) { - readdirSync(pluginDir).forEach((name) => { - const stat = statSync(join(pluginDir, name)); + const plugins = readdirSync(pluginDir) + .map((name) => [name, statSync(join(pluginDir, name))]) + .filter(([name, stat]) => stat.isDirectory() && name[0] !== '.'); - if (stat.isDirectory() && name[0] !== '.') { - try { - const packagePath = join(pluginDir, name, 'kibana.json'); - const pkg = JSON.parse(readFileSync(packagePath, 'utf8')); - logger.log(pkg.id + '@' + pkg.version); - } catch (e) { - throw new Error('Unable to read kibana.json file for plugin ' + name); - } + if (plugins.length === 0) { + logger.log('No plugins installed.'); + return; + } + + plugins.forEach(([name]) => { + try { + const packagePath = join(pluginDir, name, 'kibana.json'); + const pkg = JSON.parse(readFileSync(packagePath, 'utf8')); + logger.log(pkg.id + '@' + pkg.version); + } catch (e) { + throw new Error('Unable to read kibana.json file for plugin ' + name); } }); - - logger.log(''); //intentional blank line for aesthetics } diff --git a/src/cli_plugin/list/list.test.js b/src/cli_plugin/list/list.test.js index 51633f339e73..281f55f50fc6 100644 --- a/src/cli_plugin/list/list.test.js +++ b/src/cli_plugin/list/list.test.js @@ -64,7 +64,6 @@ describe('kibana cli', function () { "log: plugin1@5.0.0-alpha2", "log: plugin2@3.2.1", "log: plugin3@1.2.3", - "log: ", ] `); }); @@ -92,5 +91,14 @@ describe('kibana cli', function () { `"Unable to read kibana.json file for plugin invalid-plugin"` ); }); + + it('show message if no plugins are installed', function () { + list(pluginDir, logger); + expect(logger.messages).toMatchInlineSnapshot(` + Array [ + "log: No plugins installed.", + ] + `); + }); }); }); diff --git a/src/core/public/application/application_service.tsx b/src/core/public/application/application_service.tsx index 5e999ff94b9c..4a93c98205b8 100644 --- a/src/core/public/application/application_service.tsx +++ b/src/core/public/application/application_service.tsx @@ -92,6 +92,7 @@ export class ApplicationService { private registrationClosed = false; private history?: History; private navigate?: (url: string, state: unknown, replace: boolean) => void; + private openInNewTab?: (url: string) => void; private redirectTo?: (url: string) => void; private overlayStart$ = new Subject(); @@ -117,6 +118,11 @@ export class ApplicationService { return replace ? this.history!.replace(url, state) : this.history!.push(url, state); }; + this.openInNewTab = (url) => { + // window.open shares session information if base url is same + return window.open(appendAppPath(basename, url), '_blank'); + }; + this.redirectTo = redirectTo; const registerStatusUpdater = (application: string, updater$: Observable) => { @@ -218,7 +224,7 @@ export class ApplicationService { const navigateToApp: InternalApplicationStart['navigateToApp'] = async ( appId, - { path, state, replace = false }: NavigateToAppOptions = {} + { path, state, replace = false, openInNewTab = false }: NavigateToAppOptions = {} ) => { const currentAppId = this.currentAppId$.value; const navigatingToSameApp = currentAppId === appId; @@ -233,7 +239,12 @@ export class ApplicationService { if (!navigatingToSameApp) { this.appInternalStates.delete(this.currentAppId$.value!); } - this.navigate!(getAppUrl(availableMounters, appId, path), state, replace); + if (openInNewTab) { + this.openInNewTab!(getAppUrl(availableMounters, appId, path)); + } else { + this.navigate!(getAppUrl(availableMounters, appId, path), state, replace); + } + this.currentAppId$.next(appId); } }; diff --git a/src/core/public/application/types.ts b/src/core/public/application/types.ts index 3e5a255f9ecd..24f46752f28e 100644 --- a/src/core/public/application/types.ts +++ b/src/core/public/application/types.ts @@ -685,6 +685,11 @@ export interface NavigateToAppOptions { * if true, will not create a new history entry when navigating (using `replace` instead of `push`) */ replace?: boolean; + + /** + * if true, will open the app in new tab, will share session information via window.open if base + */ + openInNewTab?: boolean; } /** @public */ diff --git a/src/core/public/chrome/ui/header/__snapshots__/header.test.tsx.snap b/src/core/public/chrome/ui/header/__snapshots__/header.test.tsx.snap index 00cc827a1e83..29407c54e283 100644 --- a/src/core/public/chrome/ui/header/__snapshots__/header.test.tsx.snap +++ b/src/core/public/chrome/ui/header/__snapshots__/header.test.tsx.snap @@ -4072,8 +4072,34 @@ exports[`Header renders 1`] = ` aria-expanded={false} aria-haspopup="true" aria-label="Help menu" - buttonRef={null} - className="euiHeaderSectionItem__button" + buttonRef={ + Object { + "current": , + } + } + className="euiHeaderSectionItemButton" color="text" onClick={[Function]} > @@ -4081,7 +4107,7 @@ exports[`Header renders 1`] = ` aria-expanded={false} aria-haspopup="true" aria-label="Help menu" - className="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItem__button" + className="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItemButton" disabled={false} onClick={[Function]} type="button" @@ -4101,15 +4127,19 @@ exports[`Header renders 1`] = ` - - - + type="help" + > + + + @@ -4226,7 +4256,7 @@ exports[`Header renders 1`] = ` aria-expanded="false" aria-label="Toggle primary navigation" aria-pressed="false" - class="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItem__button" + class="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItemButton" data-test-subj="toggleNavButton" type="button" > @@ -4237,14 +4267,18 @@ exports[`Header renders 1`] = ` class="euiButtonEmpty__text" > + class="euiHeaderSectionItemButton__content" + > + + , } } - className="euiHeaderSectionItem__button" + className="euiHeaderSectionItemButton" color="text" data-test-subj="toggleNavButton" onClick={[Function]} @@ -4254,7 +4288,7 @@ exports[`Header renders 1`] = ` aria-expanded={false} aria-label="Toggle primary navigation" aria-pressed={false} - className="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItem__button" + className="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItemButton" data-test-subj="toggleNavButton" disabled={false} onClick={[Function]} @@ -4275,15 +4309,19 @@ exports[`Header renders 1`] = ` - - - + type="menu" + > + + + diff --git a/src/core/public/chrome/ui/header/header.tsx b/src/core/public/chrome/ui/header/header.tsx index 16c89fdca380..67cdd24aae84 100644 --- a/src/core/public/chrome/ui/header/header.tsx +++ b/src/core/public/chrome/ui/header/header.tsx @@ -98,7 +98,7 @@ export function Header({ ); } - const toggleCollapsibleNavRef = createRef(); + const toggleCollapsibleNavRef = createRef void }>(); const navId = htmlIdGenerator()(); const className = classnames('hide-for-sharing', 'headerGlobalNav'); diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts index 1bff91f15a15..4220d3e490f6 100644 --- a/src/core/public/doc_links/doc_links_service.ts +++ b/src/core/public/doc_links/doc_links_service.ts @@ -130,6 +130,7 @@ export class DocLinksService { }, addData: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`, kibana: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index.html`, + upgradeAssistant: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/upgrade-assistant.html`, elasticsearch: { docsBase: `${ELASTICSEARCH_DOCS}`, asyncSearch: `${ELASTICSEARCH_DOCS}async-search-intro.html`, @@ -181,6 +182,7 @@ export class DocLinksService { scriptParameters: `${ELASTICSEARCH_DOCS}modules-scripting-using.html#prefer-params`, transportSettings: `${ELASTICSEARCH_DOCS}modules-transport.html`, typesRemoval: `${ELASTICSEARCH_DOCS}removal-of-types.html`, + deprecationLogging: `${ELASTICSEARCH_DOCS}logging.html#deprecation-logging`, }, siem: { guide: `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/index.html`, @@ -495,6 +497,7 @@ export interface DocLinksStart { }; readonly addData: string; readonly kibana: string; + readonly upgradeAssistant: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; diff --git a/src/core/public/index.ts b/src/core/public/index.ts index 750f2e27dc95..ca432d6b8269 100644 --- a/src/core/public/index.ts +++ b/src/core/public/index.ts @@ -67,7 +67,12 @@ import { DocLinksStart } from './doc_links'; import { SavedObjectsStart } from './saved_objects'; import { DeprecationsServiceStart } from './deprecations'; -export type { PackageInfo, EnvironmentMode, IExternalUrlPolicy } from '../server/types'; +export type { + PackageInfo, + EnvironmentMode, + IExternalUrlPolicy, + DomainDeprecationDetails, +} from '../server/types'; export type { CoreContext, CoreSystem } from './core_system'; export { DEFAULT_APP_CATEGORIES } from '../utils'; export type { diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md index 3f4de7fccac7..8c1753c2caba 100644 --- a/src/core/public/public.api.md +++ b/src/core/public/public.api.md @@ -476,7 +476,6 @@ export const DEFAULT_APP_CATEGORIES: Record; // @public export interface DeprecationsServiceStart { - // Warning: (ae-forgotten-export) The symbol "DomainDeprecationDetails" needs to be exported by the entry point index.d.ts getAllDeprecations: () => Promise; getDeprecations: (domainId: string) => Promise; isDeprecationResolvable: (details: DomainDeprecationDetails) => boolean; @@ -591,6 +590,7 @@ export interface DocLinksStart { }; readonly addData: string; readonly kibana: string; + readonly upgradeAssistant: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; @@ -658,6 +658,15 @@ export interface DocLinksStart { }; } +// Warning: (ae-forgotten-export) The symbol "DeprecationsDetails" needs to be exported by the entry point index.d.ts +// Warning: (ae-missing-release-tag) "DomainDeprecationDetails" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface DomainDeprecationDetails extends DeprecationsDetails { + // (undocumented) + domainId: string; +} + export { EnvironmentMode } // @public @@ -923,6 +932,7 @@ export type MountPoint = (element: T) => Un // // @public export interface NavigateToAppOptions { + openInNewTab?: boolean; path?: string; replace?: boolean; state?: unknown; diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 53b2eb861041..05af684053f3 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -363,7 +363,7 @@ export const config: { healthCheck: import("@kbn/config-schema").ObjectType<{ delay: Type; }>; - ignoreVersionMismatch: import("@kbn/config-schema/target/types/types").ConditionalType; + ignoreVersionMismatch: import("@kbn/config-schema/target/types").ConditionalType; }>; }; logging: { diff --git a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker index 1ad155928899..c65a3569448a 100755 --- a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker +++ b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker @@ -200,6 +200,8 @@ kibana_vars=( xpack.fleet.agents.elasticsearch.host xpack.fleet.agents.kibana.host xpack.fleet.agents.tlsCheckDisabled + xpack.fleet.agentPolicies + xpack.fleet.packages xpack.fleet.registryUrl xpack.graph.canEditDrillDownUrls xpack.graph.enabled diff --git a/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap b/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap index 9e3018fb512c..4cd3eb13f360 100644 --- a/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap +++ b/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap @@ -617,9 +617,11 @@ exports[`DashboardEmptyScreen renders correctly with readonly mode 1`] = `
), diff --git a/x-pack/plugins/infra/public/pages/link_to/link_to_logs.test.tsx b/x-pack/plugins/infra/public/pages/link_to/link_to_logs.test.tsx index 7fb205648fbc..0d57f8dad1e7 100644 --- a/x-pack/plugins/infra/public/pages/link_to/link_to_logs.test.tsx +++ b/x-pack/plugins/infra/public/pages/link_to/link_to_logs.test.tsx @@ -25,6 +25,9 @@ const renderRoutes = (routes: React.ReactElement) => { const history = createMemoryHistory(); const services = { http: httpServiceMock.createStartContract(), + data: { + indexPatterns: {}, + }, }; const renderResult = render( diff --git a/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx b/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx index 047903ea1f77..741fad5a5310 100644 --- a/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx +++ b/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx @@ -12,8 +12,6 @@ import flowRight from 'lodash/flowRight'; import React from 'react'; import { Redirect, RouteComponentProps } from 'react-router-dom'; import useMount from 'react-use/lib/useMount'; -import { HttpStart } from 'src/core/public'; -import { useKibana } from '../../../../../../src/plugins/kibana_react/public'; import { findInventoryFields } from '../../../common/inventory_models'; import { InventoryItemType } from '../../../common/inventory_models/types'; import { LoadingPage } from '../../components/loading_page'; @@ -23,6 +21,7 @@ import { useLogSource } from '../../containers/logs/log_source'; import { replaceSourceIdInQueryString } from '../../containers/source_id'; import { LinkDescriptor } from '../../hooks/use_link_props'; import { getFilterFromLocation, getTimeFromLocation } from './query_params'; +import { useKibanaContextForPlugin } from '../../hooks/use_kibana'; type RedirectToNodeLogsType = RouteComponentProps<{ nodeId: string; @@ -36,10 +35,11 @@ export const RedirectToNodeLogs = ({ }, location, }: RedirectToNodeLogsType) => { - const { services } = useKibana<{ http: HttpStart }>(); + const { services } = useKibanaContextForPlugin(); const { isLoading, loadSourceConfiguration, sourceConfiguration } = useLogSource({ fetch: services.http.fetch, sourceId, + indexPatternsService: services.data.indexPatterns, }); const fields = sourceConfiguration?.configuration.fields; diff --git a/x-pack/plugins/infra/public/pages/logs/log_entry_categories/page_providers.tsx b/x-pack/plugins/infra/public/pages/logs/log_entry_categories/page_providers.tsx index fd7cb9efa77e..68b5a133550b 100644 --- a/x-pack/plugins/infra/public/pages/logs/log_entry_categories/page_providers.tsx +++ b/x-pack/plugins/infra/public/pages/logs/log_entry_categories/page_providers.tsx @@ -12,22 +12,22 @@ import { useLogSourceContext } from '../../../containers/logs/log_source'; import { useActiveKibanaSpace } from '../../../hooks/use_kibana_space'; export const LogEntryCategoriesPageProviders: React.FunctionComponent = ({ children }) => { - const { sourceConfiguration, sourceId } = useLogSourceContext(); + const { sourceId, resolvedSourceConfiguration } = useLogSourceContext(); const { space } = useActiveKibanaSpace(); // This is a rather crude way of guarding the dependent providers against // arguments that are only made available asynchronously. Ideally, we'd use // React concurrent mode and Suspense in order to handle that more gracefully. - if (sourceConfiguration?.configuration.logAlias == null || space == null) { + if (!resolvedSourceConfiguration || space == null) { return null; } return ( {children} diff --git a/x-pack/plugins/infra/public/pages/logs/log_entry_rate/page_providers.tsx b/x-pack/plugins/infra/public/pages/logs/log_entry_rate/page_providers.tsx index c131b16894dc..cb52dfd71357 100644 --- a/x-pack/plugins/infra/public/pages/logs/log_entry_rate/page_providers.tsx +++ b/x-pack/plugins/infra/public/pages/logs/log_entry_rate/page_providers.tsx @@ -14,29 +14,29 @@ import { useActiveKibanaSpace } from '../../../hooks/use_kibana_space'; import { LogFlyout } from '../../../containers/logs/log_flyout'; export const LogEntryRatePageProviders: React.FunctionComponent = ({ children }) => { - const { sourceId, sourceConfiguration } = useLogSourceContext(); + const { sourceId, resolvedSourceConfiguration } = useLogSourceContext(); const { space } = useActiveKibanaSpace(); // This is a rather crude way of guarding the dependent providers against // arguments that are only made available asynchronously. Ideally, we'd use // React concurrent mode and Suspense in order to handle that more gracefully. - if (sourceConfiguration?.configuration.logAlias == null || space == null) { + if (!resolvedSourceConfiguration || space == null) { return null; } return ( {children} diff --git a/x-pack/plugins/infra/public/pages/logs/page_providers.tsx b/x-pack/plugins/infra/public/pages/logs/page_providers.tsx index b30d6d08ba97..34ff237a9bd0 100644 --- a/x-pack/plugins/infra/public/pages/logs/page_providers.tsx +++ b/x-pack/plugins/infra/public/pages/logs/page_providers.tsx @@ -6,17 +6,20 @@ */ import React from 'react'; -import { HttpStart } from 'src/core/public'; -import { useKibana } from '../../../../../../src/plugins/kibana_react/public'; +import { useKibanaContextForPlugin } from '../../hooks/use_kibana'; import { LogAnalysisCapabilitiesProvider } from '../../containers/logs/log_analysis'; import { LogSourceProvider } from '../../containers/logs/log_source'; import { useSourceId } from '../../containers/source_id'; export const LogsPageProviders: React.FunctionComponent = ({ children }) => { const [sourceId] = useSourceId(); - const { services } = useKibana<{ http: HttpStart }>(); + const { services } = useKibanaContextForPlugin(); return ( - + {children} ); diff --git a/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_form_state.tsx b/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_form_state.tsx index d0017a4123e6..95c55b556ab8 100644 --- a/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_form_state.tsx +++ b/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_form_state.tsx @@ -6,12 +6,12 @@ */ import { useCallback, useMemo } from 'react'; -import { LogSourceConfigurationProperties } from '../../../containers/logs/log_source'; +import { ResolvedLogSourceConfiguration } from '../../../../common/log_sources'; import { useLogIndicesConfigurationFormState } from './indices_configuration_form_state'; import { useLogColumnsConfigurationFormState } from './log_columns_configuration_form_state'; export const useLogSourceConfigurationFormState = ( - configuration?: LogSourceConfigurationProperties + configuration?: ResolvedLogSourceConfiguration ) => { const indicesConfigurationFormState = useLogIndicesConfigurationFormState({ initialFormState: useMemo( @@ -20,9 +20,9 @@ export const useLogSourceConfigurationFormState = ( ? { name: configuration.name, description: configuration.description, - logAlias: configuration.logAlias, - tiebreakerField: configuration.fields.tiebreaker, - timestampField: configuration.fields.timestamp, + logAlias: configuration.indices, + tiebreakerField: configuration.tiebreakerField, + timestampField: configuration.timestampField, } : undefined, [configuration] @@ -34,7 +34,7 @@ export const useLogSourceConfigurationFormState = ( () => configuration ? { - logColumns: configuration.logColumns, + logColumns: configuration.columns, } : undefined, [configuration] diff --git a/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_settings.tsx b/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_settings.tsx index 754a29de47c5..2eaf4f61409a 100644 --- a/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_settings.tsx +++ b/x-pack/plugins/infra/public/pages/logs/settings/source_configuration_settings.tsx @@ -28,6 +28,7 @@ import { useLogSourceConfigurationFormState } from './source_configuration_form_ import { useLogSourceContext } from '../../../containers/logs/log_source'; import { SourceLoadingPage } from '../../../components/source_loading_page'; import { Prompt } from '../../../utils/navigation_warning_prompt'; +import { LogSourceConfigurationPropertiesPatch } from '../../../../common/http_api/log_sources'; export const LogsSettingsPage = () => { const uiCapabilities = useKibana().services.application?.capabilities; @@ -35,15 +36,15 @@ export const LogsSettingsPage = () => { const { sourceConfiguration: source, - sourceStatus, isLoading, isUninitialized, updateSourceConfiguration, + resolvedSourceConfiguration, } = useLogSourceContext(); const availableFields = useMemo( - () => sourceStatus?.logIndexFields.map((field) => field.name) ?? [], - [sourceStatus] + () => resolvedSourceConfiguration?.fields.map((field) => field.name) ?? [], + [resolvedSourceConfiguration] ); const { @@ -56,10 +57,24 @@ export const LogsSettingsPage = () => { isFormDirty, isFormValid, formStateChanges, - } = useLogSourceConfigurationFormState(source?.configuration); + } = useLogSourceConfigurationFormState(resolvedSourceConfiguration); const persistUpdates = useCallback(async () => { - await updateSourceConfiguration(formStateChanges); + // NOTE / TODO: This is just a temporary workaround until this work is merged with the corresponding UI branch. + // Otherwise we would be duplicating work changing the logAlias etc references twice. + const patchedProperties: LogSourceConfigurationPropertiesPatch & { logAlias?: string } = { + ...formStateChanges, + ...(formStateChanges.logAlias + ? { + logIndices: { + type: 'index_name', + indexName: formStateChanges.logAlias, + }, + } + : {}), + }; + delete patchedProperties.logAlias; + await updateSourceConfiguration(patchedProperties); resetForm(); }, [updateSourceConfiguration, resetForm, formStateChanges]); @@ -68,7 +83,7 @@ export const LogsSettingsPage = () => { source, ]); - if ((isLoading || isUninitialized) && !source) { + if ((isLoading || isUninitialized) && !resolvedSourceConfiguration) { return ; } if (!source?.configuration) { diff --git a/x-pack/plugins/infra/public/pages/logs/stream/page_logs_content.tsx b/x-pack/plugins/infra/public/pages/logs/stream/page_logs_content.tsx index 70279678a387..664cccb55220 100644 --- a/x-pack/plugins/infra/public/pages/logs/stream/page_logs_content.tsx +++ b/x-pack/plugins/infra/public/pages/logs/stream/page_logs_content.tsx @@ -35,7 +35,7 @@ import { datemathToEpochMillis, isValidDatemath } from '../../../utils/datemath' const PAGE_THRESHOLD = 2; export const LogsPageLogsContent: React.FunctionComponent = () => { - const { sourceConfiguration, sourceId } = useLogSourceContext(); + const { resolvedSourceConfiguration, sourceConfiguration, sourceId } = useLogSourceContext(); const { textScale, textWrap } = useContext(LogViewConfiguration.Context); const { surroundingLogsId, @@ -218,7 +218,7 @@ export const LogsPageLogsContent: React.FunctionComponent = () => { { return ( - + -

{title}

+

{title}

 - + {metrics.map((chartMetric) => ( @@ -50,3 +51,13 @@ export const ChartHeader = ({ title, metrics }: Props) => { ); }; + +const HeaderItem = euiStyled(EuiFlexItem).attrs({ grow: 1 })` + overflow: hidden; +`; + +const H4 = euiStyled('h4')` + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +`; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/chart_section.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/chart_section.tsx new file mode 100644 index 000000000000..c8f924042b19 --- /dev/null +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/chart_section.tsx @@ -0,0 +1,103 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { + Axis, + Settings, + Position, + Chart, + PointerUpdateListener, + TickFormatter, + TooltipValue, + ChartSizeArray, +} from '@elastic/charts'; +import React from 'react'; +import moment from 'moment'; +import { MetricsExplorerSeries } from '../../../../../../../../common/http_api'; +import { MetricExplorerSeriesChart } from '../../../../../metrics_explorer/components/series_chart'; +import { + MetricsExplorerChartType, + MetricsExplorerOptionsMetric, +} from '../../../../../metrics_explorer/hooks/use_metrics_explorer_options'; +import { ChartHeader } from './chart_header'; +import { getTimelineChartTheme } from '../../../../../metrics_explorer/components/helpers/get_chart_theme'; +import { useUiSetting } from '../../../../../../../../../../../src/plugins/kibana_react/public'; + +const CHART_SIZE: ChartSizeArray = ['100%', 160]; + +interface Props { + title: string; + style: MetricsExplorerChartType; + chartRef: React.Ref; + series: ChartSectionSeries[]; + tickFormatterForTime: TickFormatter; + tickFormatter: TickFormatter; + onPointerUpdate: PointerUpdateListener; + domain: { max: number; min: number }; + stack?: boolean; +} + +export interface ChartSectionSeries { + metric: MetricsExplorerOptionsMetric; + series: MetricsExplorerSeries; +} + +export const ChartSection = ({ + title, + style, + chartRef, + series, + tickFormatterForTime, + tickFormatter, + onPointerUpdate, + domain, + stack = false, +}: Props) => { + const isDarkMode = useUiSetting('theme:darkMode'); + const metrics = series.map((chartSeries) => chartSeries.metric); + const tooltipProps = { + headerFormatter: (tooltipValue: TooltipValue) => + moment(tooltipValue.value).format('Y-MM-DD HH:mm:ss.SSS'), + }; + + return ( + <> + + + {series.map((chartSeries, index) => ( + + ))} + + + + + + ); +}; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/metrics.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/metrics.tsx index 5ab8eb380a65..b554cb802421 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/metrics.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/metrics/metrics.tsx @@ -8,17 +8,7 @@ import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { first, last } from 'lodash'; import { i18n } from '@kbn/i18n'; -import { - Axis, - Chart, - ChartSizeArray, - niceTimeFormatter, - Position, - Settings, - TooltipValue, - PointerEvent, -} from '@elastic/charts'; -import moment from 'moment'; +import { Chart, niceTimeFormatter, PointerEvent } from '@elastic/charts'; import { EuiLoadingChart, EuiSpacer, EuiFlexGrid, EuiFlexItem } from '@elastic/eui'; import { TabContent, TabProps } from '../shared'; import { useSnapshot } from '../../../../hooks/use_snaphot'; @@ -36,12 +26,10 @@ import { MetricsExplorerAggregation, MetricsExplorerSeries, } from '../../../../../../../../common/http_api'; -import { MetricExplorerSeriesChart } from '../../../../../metrics_explorer/components/series_chart'; import { createInventoryMetricFormatter } from '../../../../lib/create_inventory_metric_formatter'; import { calculateDomain } from '../../../../../metrics_explorer/components/helpers/calculate_domain'; -import { getTimelineChartTheme } from '../../../../../metrics_explorer/components/helpers/get_chart_theme'; -import { useUiSetting } from '../../../../../../../../../../../src/plugins/kibana_react/public'; -import { ChartHeader } from './chart_header'; +import { euiStyled } from '../../../../../../../../../../../src/plugins/kibana_react/common'; +import { ChartSection } from './chart_section'; import { SYSTEM_METRIC_NAME, USER_METRIC_NAME, @@ -53,26 +41,36 @@ import { LOAD_CHART_TITLE, MEMORY_CHART_TITLE, NETWORK_CHART_TITLE, + LOG_RATE_METRIC_NAME, + LOG_RATE_CHART_TITLE, } from './translations'; import { TimeDropdown } from './time_dropdown'; +import { getCustomMetricLabel } from '../../../../../../../../common/formatters/get_custom_metric_label'; +import { createFormatterForMetric } from '../../../../../metrics_explorer/components/helpers/create_formatter_for_metric'; const ONE_HOUR = 60 * 60 * 1000; -const CHART_SIZE: ChartSizeArray = ['100%', 160]; const TabComponent = (props: TabProps) => { const cpuChartRef = useRef(null); const networkChartRef = useRef(null); const memoryChartRef = useRef(null); const loadChartRef = useRef(null); + const logRateChartRef = useRef(null); + const customMetricRefs = useRef>({}); const [time, setTime] = useState(ONE_HOUR); - const chartRefs = useMemo(() => [cpuChartRef, networkChartRef, memoryChartRef, loadChartRef], [ + const chartRefs = useMemo(() => { + const refs = [cpuChartRef, networkChartRef, memoryChartRef, loadChartRef, logRateChartRef]; + return [...refs, customMetricRefs]; + }, [ cpuChartRef, networkChartRef, memoryChartRef, loadChartRef, + logRateChartRef, + customMetricRefs, ]); const { sourceId, createDerivedIndexPattern } = useSourceContext(); - const { nodeType, accountId, region } = useWaffleOptionsContext(); + const { nodeType, accountId, region, customMetrics } = useWaffleOptionsContext(); const { currentTime, options, node } = props; const derivedIndexPattern = useMemo(() => createDerivedIndexPattern('metrics'), [ createDerivedIndexPattern, @@ -102,20 +100,29 @@ const TabComponent = (props: TabProps) => { [setTime] ); + const timeRange = { + interval: '1m', + to: currentTime, + from: currentTime - time, + ignoreLookback: true, + }; + + const defaultMetrics: Array<{ type: SnapshotMetricType }> = [ + { type: 'rx' }, + { type: 'tx' }, + buildCustomMetric('system.cpu.user.pct', 'user'), + buildCustomMetric('system.cpu.system.pct', 'system'), + buildCustomMetric('system.load.1', 'load1m'), + buildCustomMetric('system.load.5', 'load5m'), + buildCustomMetric('system.load.15', 'load15m'), + buildCustomMetric('system.memory.actual.used.bytes', 'usedMemory'), + buildCustomMetric('system.memory.actual.free', 'freeMemory'), + buildCustomMetric('system.cpu.cores', 'cores', 'max'), + ]; + const { nodes, reload } = useSnapshot( filter, - [ - { type: 'rx' }, - { type: 'tx' }, - buildCustomMetric('system.cpu.user.pct', 'user'), - buildCustomMetric('system.cpu.system.pct', 'system'), - buildCustomMetric('system.load.1', 'load1m'), - buildCustomMetric('system.load.5', 'load5m'), - buildCustomMetric('system.load.15', 'load15m'), - buildCustomMetric('system.memory.actual.used.bytes', 'usedMemory'), - buildCustomMetric('system.memory.actual.free', 'freeMemory'), - buildCustomMetric('system.cpu.cores', 'cores', 'max'), - ], + [...defaultMetrics, ...customMetrics], [], nodeType, sourceId, @@ -123,12 +130,20 @@ const TabComponent = (props: TabProps) => { accountId, region, false, - { - interval: '1m', - to: currentTime, - from: currentTime - time, - ignoreLookback: true, - } + timeRange + ); + + const { nodes: logRateNodes, reload: reloadLogRate } = useSnapshot( + filter, + [{ type: 'logRate' }], + [], + nodeType, + sourceId, + currentTime, + accountId, + region, + false, + timeRange ); const getDomain = useCallback( @@ -163,6 +178,7 @@ const TabComponent = (props: TabProps) => { [] ); const loadFormatter = useMemo(() => createInventoryMetricFormatter({ type: 'load' }), []); + const logRateFormatter = useMemo(() => createInventoryMetricFormatter({ type: 'logRate' }), []); const mergeTimeseries = useCallback((...series: MetricsExplorerSeries[]) => { const base = series[0]; @@ -196,19 +212,22 @@ const TabComponent = (props: TabProps) => { (event: PointerEvent) => { chartRefs.forEach((ref) => { if (ref.current) { - ref.current.dispatchExternalPointerEvent(event); + if (ref.current instanceof Chart) { + ref.current.dispatchExternalPointerEvent(event); + } else { + const charts = Object.values(ref.current); + charts.forEach((c) => { + if (c) { + c.dispatchExternalPointerEvent(event); + } + }); + } } }); }, [chartRefs] ); - const isDarkMode = useUiSetting('theme:darkMode'); - const tooltipProps = { - headerFormatter: (tooltipValue: TooltipValue) => - moment(tooltipValue.value).format('Y-MM-DD HH:mm:ss.SSS'), - }; - const getTimeseries = useCallback( (metricName: string) => { if (!nodes || !nodes.length) { @@ -219,6 +238,16 @@ const TabComponent = (props: TabProps) => { [nodes] ); + const getLogRateTimeseries = useCallback(() => { + if (!logRateNodes) { + return null; + } + if (logRateNodes.length === 0) { + return { rows: [], columns: [], id: '0' }; + } + return logRateNodes[0].metrics.find((m) => m.name === 'logRate')!.timeseries!; + }, [logRateNodes]); + const systemMetricsTs = useMemo(() => getTimeseries('system'), [getTimeseries]); const userMetricsTs = useMemo(() => getTimeseries('user'), [getTimeseries]); const rxMetricsTs = useMemo(() => getTimeseries('rx'), [getTimeseries]); @@ -229,10 +258,12 @@ const TabComponent = (props: TabProps) => { const usedMemoryMetricsTs = useMemo(() => getTimeseries('usedMemory'), [getTimeseries]); const freeMemoryMetricsTs = useMemo(() => getTimeseries('freeMemory'), [getTimeseries]); const coresMetricsTs = useMemo(() => getTimeseries('cores'), [getTimeseries]); + const logRateMetricsTs = useMemo(() => getLogRateTimeseries(), [getLogRateTimeseries]); useEffect(() => { reload(); - }, [time, reload]); + reloadLogRate(); + }, [time, reload, reloadLogRate]); if ( !systemMetricsTs || @@ -243,12 +274,14 @@ const TabComponent = (props: TabProps) => { !load5mMetricsTs || !load15mMetricsTs || !usedMemoryMetricsTs || - !freeMemoryMetricsTs + !freeMemoryMetricsTs || + !logRateMetricsTs ) { return ; } const cpuChartMetrics = buildChartMetricLabels([SYSTEM_METRIC_NAME, USER_METRIC_NAME], 'avg'); + const logRateChartMetrics = buildChartMetricLabels([LOG_RATE_METRIC_NAME], 'rate'); const networkChartMetrics = buildChartMetricLabels( [INBOUND_METRIC_NAME, OUTBOUND_METRIC_NAME], 'rate' @@ -277,6 +310,7 @@ const TabComponent = (props: TabProps) => { return r; }); const cpuTimeseries = mergeTimeseries(systemMetricsTs, userMetricsTs); + const logRateTimeseries = mergeTimeseries(logRateMetricsTs); const networkTimeseries = mergeTimeseries(rxMetricsTs, txMetricsTs); const loadTimeseries = mergeTimeseries(load1mMetricsTs, load5mMetricsTs, load15mMetricsTs); const memoryTimeseries = mergeTimeseries(usedMemoryMetricsTs, freeMemoryMetricsTs); @@ -290,173 +324,117 @@ const TabComponent = (props: TabProps) => { - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + {customMetrics.map((c) => { + const metricTS = getTimeseries(c.id); + const chartMetrics = buildChartMetricLabels([c.field], c.aggregation); + if (!metricTS) return null; + return ( + + { + customMetricRefs.current[c.id] = r; + }} + series={[{ metric: chartMetrics[0], series: metricTS }]} + tickFormatterForTime={formatter} + tickFormatter={createFormatterForMetric(c)} + onPointerUpdate={pointerUpdate} + domain={getDomain(mergeTimeseries(metricTS), chartMetrics)} + stack={true} + /> + + ); + })} ); }; +const ChartGridItem = euiStyled(EuiFlexItem)` + overflow: hidden +`; + const LoadingPlaceholder = () => { return (
{ const { mockedGetStartServices } = setup(); mockedCallFetchLogSourceStatusAPI.mockResolvedValue({ - data: { logIndexFields: [], logIndexStatus: 'available' }, + data: { logIndexStatus: 'available' }, }); const hasData = getLogsHasDataFetcher(mockedGetStartServices); @@ -82,7 +82,7 @@ describe('Logs UI Observability Homepage Functions', () => { const { mockedGetStartServices } = setup(); mockedCallFetchLogSourceStatusAPI.mockResolvedValue({ - data: { logIndexFields: [], logIndexStatus: 'empty' }, + data: { logIndexStatus: 'empty' }, }); const hasData = getLogsHasDataFetcher(mockedGetStartServices); @@ -96,7 +96,7 @@ describe('Logs UI Observability Homepage Functions', () => { const { mockedGetStartServices } = setup(); mockedCallFetchLogSourceStatusAPI.mockResolvedValue({ - data: { logIndexFields: [], logIndexStatus: 'missing' }, + data: { logIndexStatus: 'missing' }, }); const hasData = getLogsHasDataFetcher(mockedGetStartServices); @@ -112,7 +112,10 @@ describe('Logs UI Observability Homepage Functions', () => { mockedCallFetchLogSourceConfigurationAPI.mockResolvedValue({ data: { configuration: { - logAlias: 'filebeat-*', + logIndices: { + type: 'index_pattern', + indexPatternId: 'some-test-id', + }, fields: { timestamp: '@timestamp', tiebreaker: '_doc' }, }, }, diff --git a/x-pack/plugins/infra/server/lib/adapters/fields/framework_fields_adapter.ts b/x-pack/plugins/infra/server/lib/adapters/fields/framework_fields_adapter.ts index 8b170f49267f..268afccd4c2b 100644 --- a/x-pack/plugins/infra/server/lib/adapters/fields/framework_fields_adapter.ts +++ b/x-pack/plugins/infra/server/lib/adapters/fields/framework_fields_adapter.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { FieldSpec } from 'src/plugins/data/common'; import type { InfraPluginRequestHandlerContext } from '../../../types'; import { KibanaFramework } from '../framework/kibana_framework_adapter'; import { FieldsAdapter, IndexFieldDescriptor } from './adapter_types'; @@ -20,11 +21,17 @@ export class FrameworkFieldsAdapter implements FieldsAdapter { requestContext: InfraPluginRequestHandlerContext, indices: string ): Promise { - const indexPatternsService = this.framework.getIndexPatternsService(requestContext); + const indexPatternsService = await this.framework.getIndexPatternsServiceWithRequestContext( + requestContext + ); + + // NOTE: Unfortunately getFieldsForWildcard is typed to "any" here in the data plugin, FieldSpec is used below in the map. const response = await indexPatternsService.getFieldsForWildcard({ pattern: indices, + allowNoIndex: true, }); - return response.map((field) => ({ + + return response.map((field: FieldSpec) => ({ ...field, displayable: true, })); diff --git a/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts b/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts index 0176361ede66..d3ea162781b5 100644 --- a/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts +++ b/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts @@ -12,6 +12,7 @@ import { } from '@elastic/elasticsearch/api/requestParams'; import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport'; import { estypes } from '@elastic/elasticsearch'; +import { SavedObjectsClientContract, ElasticsearchClient } from 'src/core/server'; import { InfraRouteConfig, InfraServerPluginSetupDeps, @@ -32,16 +33,23 @@ import { import { RequestHandler } from '../../../../../../../src/core/server'; import { InfraConfig } from '../../../plugin'; import type { InfraPluginRequestHandlerContext } from '../../../types'; -import { IndexPatternsFetcher, UI_SETTINGS } from '../../../../../../../src/plugins/data/server'; +import { UI_SETTINGS } from '../../../../../../../src/plugins/data/server'; import { TimeseriesVisData } from '../../../../../../../src/plugins/vis_type_timeseries/server'; +import { InfraServerPluginStartDeps } from './adapter_types'; export class KibanaFramework { public router: IRouter; public plugins: InfraServerPluginSetupDeps; + private core: CoreSetup; - constructor(core: CoreSetup, config: InfraConfig, plugins: InfraServerPluginSetupDeps) { + constructor( + core: CoreSetup, + config: InfraConfig, + plugins: InfraServerPluginSetupDeps + ) { this.router = core.http.createRouter(); this.plugins = plugins; + this.core = core; } public registerRoute( @@ -195,10 +203,31 @@ export class KibanaFramework { return apiResult ? (await apiResult).body : undefined; } - public getIndexPatternsService( + public async getIndexPatternsServiceWithRequestContext( requestContext: InfraPluginRequestHandlerContext - ): IndexPatternsFetcher { - return new IndexPatternsFetcher(requestContext.core.elasticsearch.client.asCurrentUser, true); + ) { + return await this.createIndexPatternsService( + requestContext.core.savedObjects.client, + requestContext.core.elasticsearch.client.asCurrentUser + ); + } + + public async getIndexPatternsService( + savedObjectsClient: SavedObjectsClientContract, + elasticsearchClient: ElasticsearchClient + ) { + return await this.createIndexPatternsService(savedObjectsClient, elasticsearchClient); + } + + private async createIndexPatternsService( + savedObjectsClient: SavedObjectsClientContract, + elasticsearchClient: ElasticsearchClient + ) { + const [, startPlugins] = await this.core.getStartServices(); + return startPlugins.data.indexPatterns.indexPatternsServiceFactory( + savedObjectsClient, + elasticsearchClient + ); } public getSpaceId(request: KibanaRequest): string { diff --git a/x-pack/plugins/infra/server/lib/adapters/log_entries/kibana_log_entries_adapter.ts b/x-pack/plugins/infra/server/lib/adapters/log_entries/kibana_log_entries_adapter.ts index a72446fc1e1b..33df2b4d55d2 100644 --- a/x-pack/plugins/infra/server/lib/adapters/log_entries/kibana_log_entries_adapter.ts +++ b/x-pack/plugins/infra/server/lib/adapters/log_entries/kibana_log_entries_adapter.ts @@ -21,9 +21,9 @@ import { LogSummaryBucket, LOG_ENTRIES_PAGE_SIZE, } from '../../domains/log_entries_domain'; -import { InfraSourceConfiguration } from '../../sources'; import { SortedSearchHit } from '../framework'; import { KibanaFramework } from '../framework/kibana_framework_adapter'; +import { ResolvedLogSourceConfiguration } from '../../../../common/log_sources'; const TIMESTAMP_FORMAT = 'epoch_millis'; @@ -32,7 +32,7 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { public async getLogEntries( requestContext: InfraPluginRequestHandlerContext, - sourceConfiguration: InfraSourceConfiguration, + resolvedLogSourceConfiguration: ResolvedLogSourceConfiguration, fields: string[], params: LogEntriesParams ): Promise<{ documents: LogEntryDocument[]; hasMoreBefore?: boolean; hasMoreAfter?: boolean }> { @@ -64,13 +64,13 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { : {}; const sort = { - [sourceConfiguration.fields.timestamp]: sortDirection, - [sourceConfiguration.fields.tiebreaker]: sortDirection, + [resolvedLogSourceConfiguration.timestampField]: sortDirection, + [resolvedLogSourceConfiguration.tiebreakerField]: sortDirection, }; const esQuery = { allowNoIndices: true, - index: sourceConfiguration.logAlias, + index: resolvedLogSourceConfiguration.indices, ignoreUnavailable: true, body: { size: size + 1, // Extra one to test if it has more before or after @@ -83,7 +83,7 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { ...createFilterClauses(query, highlightQuery), { range: { - [sourceConfiguration.fields.timestamp]: { + [resolvedLogSourceConfiguration.timestampField]: { gte: startTimestamp, lte: endTimestamp, format: TIMESTAMP_FORMAT, @@ -125,7 +125,7 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { public async getContainedLogSummaryBuckets( requestContext: InfraPluginRequestHandlerContext, - sourceConfiguration: InfraSourceConfiguration, + resolvedLogSourceConfiguration: ResolvedLogSourceConfiguration, startTimestamp: number, endTimestamp: number, bucketSize: number, @@ -139,13 +139,13 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { const query = { allowNoIndices: true, - index: sourceConfiguration.logAlias, + index: resolvedLogSourceConfiguration.indices, ignoreUnavailable: true, body: { aggregations: { count_by_date: { date_range: { - field: sourceConfiguration.fields.timestamp, + field: resolvedLogSourceConfiguration.timestampField, format: TIMESTAMP_FORMAT, ranges: bucketIntervalStarts.map((bucketIntervalStart) => ({ from: bucketIntervalStart.getTime(), @@ -157,8 +157,8 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { top_hits: { size: 1, sort: [ - { [sourceConfiguration.fields.timestamp]: 'asc' }, - { [sourceConfiguration.fields.tiebreaker]: 'asc' }, + { [resolvedLogSourceConfiguration.timestampField]: 'asc' }, + { [resolvedLogSourceConfiguration.tiebreakerField]: 'asc' }, ], _source: false, }, @@ -172,7 +172,7 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter { ...createQueryFilterClauses(filterQuery), { range: { - [sourceConfiguration.fields.timestamp]: { + [resolvedLogSourceConfiguration.timestampField]: { gte: startTimestamp, lte: endTimestamp, format: TIMESTAMP_FORMAT, diff --git a/x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts b/x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts index 8fb8ee54d22a..0db6a9d83c85 100644 --- a/x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts +++ b/x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts @@ -70,7 +70,8 @@ export const createInventoryMetricThresholdExecutor = (libs: InfraBackendLibs) = const logQueryFields = await libs.getLogQueryFields( sourceId || 'default', - services.savedObjectsClient + services.savedObjectsClient, + services.scopedClusterClient.asCurrentUser ); const compositeSize = libs.configuration.inventory.compositeSize; diff --git a/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_chart_preview.ts b/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_chart_preview.ts index cb9ba8b25440..0914fab00dbe 100644 --- a/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_chart_preview.ts +++ b/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_chart_preview.ts @@ -7,7 +7,6 @@ import { i18n } from '@kbn/i18n'; import type { InfraPluginRequestHandlerContext } from '../../../types'; -import { InfraSource } from '../../sources'; import { KibanaFramework } from '../../adapters/framework/kibana_framework_adapter'; import { GetLogAlertsChartPreviewDataAlertParamsSubset, @@ -26,18 +25,19 @@ import { GroupedSearchQueryResponseRT, } from '../../../../common/alerting/logs/log_threshold/types'; import { decodeOrThrow } from '../../../../common/runtime_types'; +import { ResolvedLogSourceConfiguration } from '../../../../common/log_sources'; const COMPOSITE_GROUP_SIZE = 40; export async function getChartPreviewData( requestContext: InfraPluginRequestHandlerContext, - sourceConfiguration: InfraSource, + resolvedLogSourceConfiguration: ResolvedLogSourceConfiguration, callWithRequest: KibanaFramework['callWithRequest'], alertParams: GetLogAlertsChartPreviewDataAlertParamsSubset, buckets: number ) { - const indexPattern = sourceConfiguration.configuration.logAlias; - const timestampField = sourceConfiguration.configuration.fields.timestamp; + const indexPattern = resolvedLogSourceConfiguration.indices; + const timestampField = resolvedLogSourceConfiguration.timestampField; const { groupBy, timeSize, timeUnit } = alertParams; const isGrouped = groupBy && groupBy.length > 0 ? true : false; diff --git a/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts b/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts index 0dff7e107097..b81219b1afda 100644 --- a/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts +++ b/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts @@ -40,6 +40,7 @@ import { InfraBackendLibs } from '../../infra_types'; import { getIntervalInSeconds } from '../../../utils/get_interval_in_seconds'; import { decodeOrThrow } from '../../../../common/runtime_types'; import { UNGROUPED_FACTORY_KEY } from '../common/utils'; +import { resolveLogSourceConfiguration } from '../../../../common/log_sources'; type LogThresholdActionGroups = ActionGroupIdsOf; type LogThresholdAlertServices = AlertServices< @@ -72,8 +73,15 @@ export const createLogThresholdExecutor = (libs: InfraBackendLibs) => const { sources } = libs; const sourceConfiguration = await sources.getSourceConfiguration(savedObjectsClient, 'default'); - const indexPattern = sourceConfiguration.configuration.logAlias; - const timestampField = sourceConfiguration.configuration.fields.timestamp; + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + sourceConfiguration.configuration, + await libs.framework.getIndexPatternsService( + savedObjectsClient, + scopedClusterClient.asCurrentUser + ) + ); + const indexPattern = resolvedLogSourceConfiguration.indices; + const timestampField = resolvedLogSourceConfiguration.timestampField; try { const validatedParams = decodeOrThrow(alertParamsRT)(params); diff --git a/x-pack/plugins/infra/server/lib/alerting/log_threshold/mocks/index.ts b/x-pack/plugins/infra/server/lib/alerting/log_threshold/mocks/index.ts index 55a2868716bb..296a540b4a92 100644 --- a/x-pack/plugins/infra/server/lib/alerting/log_threshold/mocks/index.ts +++ b/x-pack/plugins/infra/server/lib/alerting/log_threshold/mocks/index.ts @@ -13,7 +13,10 @@ export const libsMock = { return Promise.resolve({ id: sourceId, configuration: { - logAlias: 'filebeat-*', + logIndices: { + type: 'index_pattern', + indexPatternId: 'some-id', + }, fields: { timestamp: '@timestamp' }, }, }); diff --git a/x-pack/plugins/infra/server/lib/domains/fields_domain.ts b/x-pack/plugins/infra/server/lib/domains/fields_domain.ts index d5ffa5698766..0997d9517fa8 100644 --- a/x-pack/plugins/infra/server/lib/domains/fields_domain.ts +++ b/x-pack/plugins/infra/server/lib/domains/fields_domain.ts @@ -18,17 +18,14 @@ export class InfraFieldsDomain { public async getFields( requestContext: InfraPluginRequestHandlerContext, sourceId: string, - indexType: 'LOGS' | 'METRICS' + indexType: 'METRICS' ): Promise { const { configuration } = await this.libs.sources.getSourceConfiguration( requestContext.core.savedObjects.client, sourceId ); - const fields = await this.adapter.getIndexFields( - requestContext, - indexType === 'LOGS' ? configuration.logAlias : configuration.metricAlias - ); + const fields = await this.adapter.getIndexFields(requestContext, configuration.metricAlias); return fields; } diff --git a/x-pack/plugins/infra/server/lib/domains/log_entries_domain/log_entries_domain.ts b/x-pack/plugins/infra/server/lib/domains/log_entries_domain/log_entries_domain.ts index 278ae0e086cf..ea57885bcdfb 100644 --- a/x-pack/plugins/infra/server/lib/domains/log_entries_domain/log_entries_domain.ts +++ b/x-pack/plugins/infra/server/lib/domains/log_entries_domain/log_entries_domain.ts @@ -12,7 +12,11 @@ import { LogEntriesSummaryBucket, LogEntriesSummaryHighlightsBucket, } from '../../../../common/http_api'; -import { LogSourceColumnConfiguration } from '../../../../common/http_api/log_sources'; +import { + LogSourceColumnConfiguration, + ResolvedLogSourceConfiguration, + resolveLogSourceConfiguration, +} from '../../../../common/log_sources'; import { LogColumn, LogEntryCursor, LogEntry } from '../../../../common/log_entry'; import { InfraSourceConfiguration, @@ -137,7 +141,10 @@ export class InfraLogEntriesDomain { requestContext.core.savedObjects.client, sourceId ); - + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + configuration, + await this.libs.framework.getIndexPatternsServiceWithRequestContext(requestContext) + ); const columnDefinitions = columnOverrides ?? configuration.logColumns; const messageFormattingRules = compileFormattingRules( @@ -148,7 +155,7 @@ export class InfraLogEntriesDomain { const { documents, hasMoreBefore, hasMoreAfter } = await this.adapter.getLogEntries( requestContext, - configuration, + resolvedLogSourceConfiguration, requiredFields, params ); @@ -199,9 +206,13 @@ export class InfraLogEntriesDomain { requestContext.core.savedObjects.client, sourceId ); + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + configuration, + await this.libs.framework.getIndexPatternsServiceWithRequestContext(requestContext) + ); const dateRangeBuckets = await this.adapter.getContainedLogSummaryBuckets( requestContext, - configuration, + resolvedLogSourceConfiguration, start, end, bucketSize, @@ -223,6 +234,10 @@ export class InfraLogEntriesDomain { requestContext.core.savedObjects.client, sourceId ); + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + configuration, + await this.libs.framework.getIndexPatternsServiceWithRequestContext(requestContext) + ); const messageFormattingRules = compileFormattingRules( getBuiltinRules(configuration.fields.message) ); @@ -240,7 +255,7 @@ export class InfraLogEntriesDomain { : highlightQuery; const summaryBuckets = await this.adapter.getContainedLogSummaryBuckets( requestContext, - configuration, + resolvedLogSourceConfiguration, startTimestamp, endTimestamp, bucketSize, @@ -299,14 +314,14 @@ export class InfraLogEntriesDomain { export interface LogEntriesAdapter { getLogEntries( requestContext: InfraPluginRequestHandlerContext, - sourceConfiguration: InfraSourceConfiguration, + resolvedLogSourceConfiguration: ResolvedLogSourceConfiguration, fields: string[], params: LogEntriesParams ): Promise<{ documents: LogEntryDocument[]; hasMoreBefore?: boolean; hasMoreAfter?: boolean }>; getContainedLogSummaryBuckets( requestContext: InfraPluginRequestHandlerContext, - sourceConfiguration: InfraSourceConfiguration, + resolvedLogSourceConfiguration: ResolvedLogSourceConfiguration, startTimestamp: number, endTimestamp: number, bucketSize: number, diff --git a/x-pack/plugins/infra/server/lib/infra_types.ts b/x-pack/plugins/infra/server/lib/infra_types.ts index f338d7957a34..0c57ff2e0584 100644 --- a/x-pack/plugins/infra/server/lib/infra_types.ts +++ b/x-pack/plugins/infra/server/lib/infra_types.ts @@ -13,6 +13,7 @@ import { InfraSourceStatus } from './source_status'; import { InfraConfig } from '../plugin'; import { KibanaFramework } from './adapters/framework/kibana_framework_adapter'; import { GetLogQueryFields } from '../services/log_queries/get_log_query_fields'; +import { handleEsError } from '../../../../../src/plugins/es_ui_shared/server'; export interface InfraDomainLibs { fields: InfraFieldsDomain; @@ -26,4 +27,5 @@ export interface InfraBackendLibs extends InfraDomainLibs { sources: InfraSources; sourceStatus: InfraSourceStatus; getLogQueryFields: GetLogQueryFields; + handleEsError: typeof handleEsError; } diff --git a/x-pack/plugins/infra/server/lib/source_status.ts b/x-pack/plugins/infra/server/lib/source_status.ts index 1fde742b8183..2b04bf84c154 100644 --- a/x-pack/plugins/infra/server/lib/source_status.ts +++ b/x-pack/plugins/infra/server/lib/source_status.ts @@ -7,6 +7,7 @@ import type { InfraPluginRequestHandlerContext } from '../types'; import { InfraSources } from './sources'; +import { ResolvedLogSourceConfiguration } from '../../common/log_sources'; export class InfraSourceStatus { constructor( @@ -14,20 +15,6 @@ export class InfraSourceStatus { private readonly libs: { sources: InfraSources } ) {} - public async getLogIndexNames( - requestContext: InfraPluginRequestHandlerContext, - sourceId: string - ): Promise { - const sourceConfiguration = await this.libs.sources.getSourceConfiguration( - requestContext.core.savedObjects.client, - sourceId - ); - const indexNames = await this.adapter.getIndexNames( - requestContext, - sourceConfiguration.configuration.logAlias - ); - return indexNames; - } public async getMetricIndexNames( requestContext: InfraPluginRequestHandlerContext, sourceId: string @@ -42,20 +29,6 @@ export class InfraSourceStatus { ); return indexNames; } - public async hasLogAlias( - requestContext: InfraPluginRequestHandlerContext, - sourceId: string - ): Promise { - const sourceConfiguration = await this.libs.sources.getSourceConfiguration( - requestContext.core.savedObjects.client, - sourceId - ); - const hasAlias = await this.adapter.hasAlias( - requestContext, - sourceConfiguration.configuration.logAlias - ); - return hasAlias; - } public async hasMetricAlias( requestContext: InfraPluginRequestHandlerContext, sourceId: string @@ -72,15 +45,11 @@ export class InfraSourceStatus { } public async getLogIndexStatus( requestContext: InfraPluginRequestHandlerContext, - sourceId: string + resolvedLogSourceConfiguration: ResolvedLogSourceConfiguration ): Promise { - const sourceConfiguration = await this.libs.sources.getSourceConfiguration( - requestContext.core.savedObjects.client, - sourceId - ); const indexStatus = await this.adapter.getIndexStatus( requestContext, - sourceConfiguration.configuration.logAlias + resolvedLogSourceConfiguration.indices ); return indexStatus; } diff --git a/x-pack/plugins/infra/server/lib/sources/defaults.ts b/x-pack/plugins/infra/server/lib/sources/defaults.ts index ff6d6a4f5514..b6139613cfce 100644 --- a/x-pack/plugins/infra/server/lib/sources/defaults.ts +++ b/x-pack/plugins/infra/server/lib/sources/defaults.ts @@ -16,7 +16,10 @@ export const defaultSourceConfiguration: InfraSourceConfiguration = { name: 'Default', description: '', metricAlias: METRICS_INDEX_PATTERN, - logAlias: LOGS_INDEX_PATTERN, + logIndices: { + type: 'index_name', + indexName: LOGS_INDEX_PATTERN, + }, fields: { container: 'container.id', host: 'host.name', diff --git a/x-pack/plugins/infra/server/lib/sources/migrations/7_13_0_convert_log_alias_to_log_indices.test.ts b/x-pack/plugins/infra/server/lib/sources/migrations/7_13_0_convert_log_alias_to_log_indices.test.ts new file mode 100644 index 000000000000..7dde0c590a96 --- /dev/null +++ b/x-pack/plugins/infra/server/lib/sources/migrations/7_13_0_convert_log_alias_to_log_indices.test.ts @@ -0,0 +1,62 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { migrationMocks } from 'src/core/server/mocks'; +import { convertLogAliasToLogIndices } from './7_13_0_convert_log_alias_to_log_indices'; +import { infraSourceConfigurationSavedObjectName } from '../saved_object_type'; + +describe('infra source configuration migration function for 7.13.0', () => { + test('migrates the logAlias property to logIndices', () => { + const unmigratedConfiguration = createTestSourceConfiguration({ + logAlias: 'filebeat-*', + }); + + const migratedConfiguration = convertLogAliasToLogIndices( + unmigratedConfiguration as any, + migrationMocks.createContext() + ); + + expect(migratedConfiguration).toStrictEqual( + createTestSourceConfiguration({ + logIndices: { + type: 'index_name', + indexName: 'filebeat-*', + }, + }) + ); + }); +}); + +const createTestSourceConfiguration = (additionalProperties = {}) => ({ + attributes: { + name: 'TEST CONFIGURATION', + description: '', + fields: { + pod: 'TEST POD FIELD', + host: 'TEST HOST FIELD', + message: ['TEST MESSAGE FIELD'], + container: 'TEST CONTAINER FIELD', + timestamp: 'TEST TIMESTAMP FIELD', + tiebreaker: 'TEST TIEBREAKER FIELD', + }, + inventoryDefaultView: '0', + metricsExplorerDefaultView: '0', + logColumns: [ + { + fieldColumn: { + id: 'TEST FIELD COLUMN ID', + field: 'TEST FIELD COLUMN FIELD', + }, + }, + ], + metricAlias: 'metricbeat-*,metrics-*', + anomalyThreshold: 20, + ...additionalProperties, + }, + id: 'TEST_ID', + type: infraSourceConfigurationSavedObjectName, +}); diff --git a/x-pack/plugins/infra/server/lib/sources/migrations/7_13_0_convert_log_alias_to_log_indices.ts b/x-pack/plugins/infra/server/lib/sources/migrations/7_13_0_convert_log_alias_to_log_indices.ts new file mode 100644 index 000000000000..599f2de19117 --- /dev/null +++ b/x-pack/plugins/infra/server/lib/sources/migrations/7_13_0_convert_log_alias_to_log_indices.ts @@ -0,0 +1,34 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { SavedObjectMigrationFn } from 'src/core/server'; +import { InfraSourceConfiguration } from '../../../../common/source_configuration/source_configuration'; +import { LOGS_INDEX_PATTERN } from '../../../../common/constants'; + +type SevenTwelveZeroSourceConfig = Omit & { + logAlias: string; +}; + +export const convertLogAliasToLogIndices: SavedObjectMigrationFn< + SevenTwelveZeroSourceConfig, + InfraSourceConfiguration +> = (sourceConfigurationDocument) => { + const { logAlias, ...otherAttributes } = sourceConfigurationDocument.attributes; + + const newAttributes: InfraSourceConfiguration = { + ...otherAttributes, + logIndices: { + type: 'index_name', + indexName: logAlias ?? LOGS_INDEX_PATTERN, + }, + }; + + return { + ...sourceConfigurationDocument, + attributes: newAttributes, + }; +}; diff --git a/x-pack/plugins/infra/server/lib/sources/migrations/7_9_0_add_new_indexing_strategy_index_names.ts b/x-pack/plugins/infra/server/lib/sources/migrations/7_9_0_add_new_indexing_strategy_index_names.ts index e71994fe1151..8c9a3ca1d5a0 100644 --- a/x-pack/plugins/infra/server/lib/sources/migrations/7_9_0_add_new_indexing_strategy_index_names.ts +++ b/x-pack/plugins/infra/server/lib/sources/migrations/7_9_0_add_new_indexing_strategy_index_names.ts @@ -8,9 +8,13 @@ import { SavedObjectMigrationFn } from 'src/core/server'; import { InfraSourceConfiguration } from '../../../../common/source_configuration/source_configuration'; +type SevenNineZeroSourceConfig = Omit & { + logAlias: string; +}; + export const addNewIndexingStrategyIndexNames: SavedObjectMigrationFn< - InfraSourceConfiguration, - InfraSourceConfiguration + SevenNineZeroSourceConfig, + SevenNineZeroSourceConfig > = (sourceConfigurationDocument) => { const oldLogAliasSegments = sourceConfigurationDocument.attributes.logAlias.split(','); const oldMetricAliasSegments = sourceConfigurationDocument.attributes.metricAlias.split(','); diff --git a/x-pack/plugins/infra/server/lib/sources/saved_object_type.ts b/x-pack/plugins/infra/server/lib/sources/saved_object_type.ts index 0612d1fa4762..135f715d8b60 100644 --- a/x-pack/plugins/infra/server/lib/sources/saved_object_type.ts +++ b/x-pack/plugins/infra/server/lib/sources/saved_object_type.ts @@ -7,6 +7,7 @@ import { SavedObjectsType } from 'src/core/server'; import { addNewIndexingStrategyIndexNames } from './migrations/7_9_0_add_new_indexing_strategy_index_names'; +import { convertLogAliasToLogIndices } from './migrations/7_13_0_convert_log_alias_to_log_indices'; export const infraSourceConfigurationSavedObjectName = 'infrastructure-ui-source'; @@ -23,5 +24,6 @@ export const infraSourceConfigurationSavedObjectType: SavedObjectsType = { }, migrations: { '7.9.0': addNewIndexingStrategyIndexNames, + '7.13.0': convertLogAliasToLogIndices, }, }; diff --git a/x-pack/plugins/infra/server/lib/sources/sources.test.ts b/x-pack/plugins/infra/server/lib/sources/sources.test.ts index 0786722e5a47..e5807322b87f 100644 --- a/x-pack/plugins/infra/server/lib/sources/sources.test.ts +++ b/x-pack/plugins/infra/server/lib/sources/sources.test.ts @@ -20,7 +20,7 @@ describe('the InfraSources lib', () => { updated_at: '2000-01-01T00:00:00.000Z', attributes: { metricAlias: 'METRIC_ALIAS', - logAlias: 'LOG_ALIAS', + logIndices: { type: 'index_pattern', indexPatternId: 'LOG_ALIAS' }, fields: { container: 'CONTAINER', host: 'HOST', @@ -39,7 +39,7 @@ describe('the InfraSources lib', () => { updatedAt: 946684800000, configuration: { metricAlias: 'METRIC_ALIAS', - logAlias: 'LOG_ALIAS', + logIndices: { type: 'index_pattern', indexPatternId: 'LOG_ALIAS' }, fields: { container: 'CONTAINER', host: 'HOST', @@ -56,7 +56,7 @@ describe('the InfraSources lib', () => { config: createMockStaticConfiguration({ default: { metricAlias: 'METRIC_ALIAS', - logAlias: 'LOG_ALIAS', + logIndices: { type: 'index_pattern', indexPatternId: 'LOG_ALIAS' }, fields: { host: 'HOST', pod: 'POD', @@ -86,7 +86,7 @@ describe('the InfraSources lib', () => { updatedAt: 946684800000, configuration: { metricAlias: 'METRIC_ALIAS', - logAlias: 'LOG_ALIAS', + logIndices: { type: 'index_pattern', indexPatternId: 'LOG_ALIAS' }, fields: { container: 'CONTAINER', host: 'HOST', @@ -118,7 +118,7 @@ describe('the InfraSources lib', () => { updatedAt: 946684800000, configuration: { metricAlias: expect.any(String), - logAlias: expect.any(String), + logIndices: expect.any(Object), fields: { container: expect.any(String), host: expect.any(String), diff --git a/x-pack/plugins/infra/server/lib/sources/sources.ts b/x-pack/plugins/infra/server/lib/sources/sources.ts index 7abbed0a9fbd..0016e4716725 100644 --- a/x-pack/plugins/infra/server/lib/sources/sources.ts +++ b/x-pack/plugins/infra/server/lib/sources/sources.ts @@ -5,7 +5,6 @@ * 2.0. */ -import * as runtimeTypes from 'io-ts'; import { failure } from 'io-ts/lib/PathReporter'; import { identity, constant } from 'fp-ts/lib/function'; import { pipe } from 'fp-ts/lib/pipeable'; @@ -21,8 +20,9 @@ import { InfraStaticSourceConfiguration, pickSavedSourceConfiguration, SourceConfigurationSavedObjectRuntimeType, - StaticSourceConfigurationRuntimeType, InfraSource, + sourceConfigurationConfigFilePropertiesRT, + SourceConfigurationConfigFileProperties, } from '../../../common/source_configuration/source_configuration'; import { InfraConfig } from '../../../server'; @@ -199,19 +199,32 @@ export class InfraSources { } private async getStaticDefaultSourceConfiguration() { - const staticSourceConfiguration = pipe( - runtimeTypes - .type({ - sources: runtimeTypes.type({ - default: StaticSourceConfigurationRuntimeType, - }), - }) - .decode(this.libs.config), + const staticSourceConfiguration: SourceConfigurationConfigFileProperties['sources']['default'] = pipe( + sourceConfigurationConfigFilePropertiesRT.decode(this.libs.config), map(({ sources: { default: defaultConfiguration } }) => defaultConfiguration), fold(constant({}), identity) ); - return mergeSourceConfiguration(defaultSourceConfiguration, staticSourceConfiguration); + // NOTE: Legacy logAlias needs converting to a logIndices reference until we can remove + // config file sources in 8.0.0. + if (staticSourceConfiguration && staticSourceConfiguration.logAlias) { + const convertedStaticSourceConfiguration: InfraStaticSourceConfiguration & { + logAlias?: string; + } = { + ...staticSourceConfiguration, + logIndices: { + type: 'index_name', + indexName: staticSourceConfiguration.logAlias, + }, + }; + delete convertedStaticSourceConfiguration.logAlias; + return mergeSourceConfiguration( + defaultSourceConfiguration, + convertedStaticSourceConfiguration + ); + } else { + return mergeSourceConfiguration(defaultSourceConfiguration, staticSourceConfiguration); + } } private async getSavedSourceConfiguration( diff --git a/x-pack/plugins/infra/server/plugin.ts b/x-pack/plugins/infra/server/plugin.ts index f818776fdf82..7c5666049bd6 100644 --- a/x-pack/plugins/infra/server/plugin.ts +++ b/x-pack/plugins/infra/server/plugin.ts @@ -31,6 +31,7 @@ import { LogEntriesService } from './services/log_entries'; import { InfraPluginRequestHandlerContext } from './types'; import { UsageCollector } from './usage/usage_collector'; import { createGetLogQueryFields } from './services/log_queries/get_log_query_fields'; +import { handleEsError } from '../../../../src/plugins/es_ui_shared/server'; export const config = { schema: schema.object({ @@ -42,7 +43,7 @@ export const config = { schema.object({ default: schema.maybe( schema.object({ - logAlias: schema.maybe(schema.string()), + logAlias: schema.maybe(schema.string()), // NOTE / TODO: Should be deprecated in 8.0.0 metricAlias: schema.maybe(schema.string()), fields: schema.maybe( schema.object({ @@ -123,7 +124,8 @@ export class InfraServerPlugin implements Plugin { sources, sourceStatus, ...domainLibs, - getLogQueryFields: createGetLogQueryFields(sources), + getLogQueryFields: createGetLogQueryFields(sources, framework), + handleEsError, }; plugins.features.registerKibanaFeature(METRICS_FEATURE); diff --git a/x-pack/plugins/infra/server/routes/alerting/preview.ts b/x-pack/plugins/infra/server/routes/alerting/preview.ts index 3008504f3b06..4cafc743b1ec 100644 --- a/x-pack/plugins/infra/server/routes/alerting/preview.ts +++ b/x-pack/plugins/infra/server/routes/alerting/preview.ts @@ -86,7 +86,8 @@ export const initAlertPreviewRoute = ({ case METRIC_INVENTORY_THRESHOLD_ALERT_TYPE_ID: { const logQueryFields = await getLogQueryFields( sourceId || 'default', - requestContext.core.savedObjects.client + requestContext.core.savedObjects.client, + requestContext.core.elasticsearch.client.asCurrentUser ); const { nodeType, diff --git a/x-pack/plugins/infra/server/routes/log_alerts/chart_preview_data.ts b/x-pack/plugins/infra/server/routes/log_alerts/chart_preview_data.ts index b4fbad0bc331..4cda9db3079e 100644 --- a/x-pack/plugins/infra/server/routes/log_alerts/chart_preview_data.ts +++ b/x-pack/plugins/infra/server/routes/log_alerts/chart_preview_data.ts @@ -14,6 +14,7 @@ import { } from '../../../common/http_api/log_alerts/chart_preview_data'; import { createValidationFunction } from '../../../common/runtime_types'; import { getChartPreviewData } from '../../lib/alerting/log_threshold/log_threshold_chart_preview'; +import { resolveLogSourceConfiguration } from '../../../common/log_sources'; export const initGetLogAlertsChartPreviewDataRoute = ({ framework, sources }: InfraBackendLibs) => { framework.registerRoute( @@ -29,15 +30,20 @@ export const initGetLogAlertsChartPreviewDataRoute = ({ framework, sources }: In data: { sourceId, buckets, alertParams }, } = request.body; - const sourceConfiguration = await sources.getSourceConfiguration( + const { configuration } = await sources.getSourceConfiguration( requestContext.core.savedObjects.client, sourceId ); + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + configuration, + await framework.getIndexPatternsServiceWithRequestContext(requestContext) + ); + try { const { series } = await getChartPreviewData( requestContext, - sourceConfiguration, + resolvedLogSourceConfiguration, framework.callWithRequest, alertParams, buckets diff --git a/x-pack/plugins/infra/server/routes/log_sources/status.ts b/x-pack/plugins/infra/server/routes/log_sources/status.ts index fd0b4cebfa72..b43cff83a63f 100644 --- a/x-pack/plugins/infra/server/routes/log_sources/status.ts +++ b/x-pack/plugins/infra/server/routes/log_sources/status.ts @@ -13,11 +13,13 @@ import { } from '../../../common/http_api/log_sources'; import { createValidationFunction } from '../../../common/runtime_types'; import { InfraBackendLibs } from '../../lib/infra_types'; +import { resolveLogSourceConfiguration } from '../../../common/log_sources'; export const initLogSourceStatusRoutes = ({ framework, sourceStatus, fields, + sources, }: InfraBackendLibs) => { framework.registerRoute( { @@ -31,16 +33,24 @@ export const initLogSourceStatusRoutes = ({ const { sourceId } = request.params; try { - const logIndexStatus = await sourceStatus.getLogIndexStatus(requestContext, sourceId); - const logIndexFields = - logIndexStatus !== 'missing' - ? await fields.getFields(requestContext, sourceId, 'LOGS') - : []; + const sourceConfiguration = await sources.getSourceConfiguration( + requestContext.core.savedObjects.client, + sourceId + ); + + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + sourceConfiguration.configuration, + await framework.getIndexPatternsServiceWithRequestContext(requestContext) + ); + + const logIndexStatus = await sourceStatus.getLogIndexStatus( + requestContext, + resolvedLogSourceConfiguration + ); return response.ok({ body: getLogSourceStatusSuccessResponsePayloadRT.encode({ data: { - logIndexFields, logIndexStatus, }, }), diff --git a/x-pack/plugins/infra/server/routes/snapshot/index.ts b/x-pack/plugins/infra/server/routes/snapshot/index.ts index c5394a02c1d0..846fabcfa4e6 100644 --- a/x-pack/plugins/infra/server/routes/snapshot/index.ts +++ b/x-pack/plugins/infra/server/routes/snapshot/index.ts @@ -20,7 +20,7 @@ import { getNodes } from './lib/get_nodes'; const escapeHatch = schema.object({}, { unknowns: 'allow' }); export const initSnapshotRoute = (libs: InfraBackendLibs) => { - const { framework } = libs; + const { framework, handleEsError } = libs; framework.registerRoute( { @@ -43,23 +43,27 @@ export const initSnapshotRoute = (libs: InfraBackendLibs) => { const compositeSize = libs.configuration.inventory.compositeSize; const logQueryFields = await libs.getLogQueryFields( snapshotRequest.sourceId, - requestContext.core.savedObjects.client + requestContext.core.savedObjects.client, + requestContext.core.elasticsearch.client.asCurrentUser ); UsageCollector.countNode(snapshotRequest.nodeType); const client = createSearchClient(requestContext, framework); - const snapshotResponse = await getNodes( - client, - snapshotRequest, - source, - logQueryFields, - compositeSize - ); - - return response.ok({ - body: SnapshotNodeResponseRT.encode(snapshotResponse), - }); + try { + const snapshotResponse = await getNodes( + client, + snapshotRequest, + source, + logQueryFields, + compositeSize + ); + return response.ok({ + body: SnapshotNodeResponseRT.encode(snapshotResponse), + }); + } catch (err) { + return handleEsError({ error: err, response }); + } } ); }; diff --git a/x-pack/plugins/infra/server/routes/snapshot/lib/transform_request_to_metrics_api_request.test.ts b/x-pack/plugins/infra/server/routes/snapshot/lib/transform_request_to_metrics_api_request.test.ts index 1e1c202b7e60..de44cf016886 100644 --- a/x-pack/plugins/infra/server/routes/snapshot/lib/transform_request_to_metrics_api_request.test.ts +++ b/x-pack/plugins/infra/server/routes/snapshot/lib/transform_request_to_metrics_api_request.test.ts @@ -42,7 +42,10 @@ const source: InfraSource = { name: 'Default', description: '', metricAlias: 'metrics-*,metricbeat-*', - logAlias: 'logs-*,filebeat-*,kibana_sample_data_logs*', + logIndices: { + type: 'index_pattern', + indexPatternId: 'kibana_index_pattern', + }, fields: { container: 'container.id', host: 'host.name', diff --git a/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.test.ts b/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.test.ts index bc4976a068f4..7c7417d038e2 100644 --- a/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.test.ts +++ b/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.test.ts @@ -25,6 +25,7 @@ import { logEntriesSearchRequestStateRT, logEntriesSearchStrategyProvider, } from './log_entries_search_strategy'; +import { getIndexPatternsMock } from './mocks'; describe('LogEntries search strategy', () => { it('handles initial search requests', async () => { @@ -102,7 +103,7 @@ describe('LogEntries search strategy', () => { fields: { '@timestamp': [1605116827143], 'event.dataset': ['HIT_DATASET'], - MESSAGE_FIELD: ['HIT_MESSAGE'], + message: ['HIT_MESSAGE'], 'container.id': ['HIT_CONTAINER_ID'], }, sort: [1605116827143 as any, 1 as any], // incorrectly typed as string upstream @@ -167,7 +168,7 @@ describe('LogEntries search strategy', () => { columnId: 'MESSAGE_COLUMN_ID', message: [ { - field: 'MESSAGE_FIELD', + field: 'message', value: ['HIT_MESSAGE'], highlights: [], }, @@ -255,7 +256,10 @@ const createSourceConfigurationMock = (): InfraSource => ({ configuration: { name: 'SOURCE_NAME', description: 'SOURCE_DESCRIPTION', - logAlias: 'log-indices-*', + logIndices: { + type: 'index_pattern', + indexPatternId: 'some-test-id', + }, metricAlias: 'metric-indices-*', inventoryDefaultView: 'DEFAULT_VIEW', metricsExplorerDefaultView: 'DEFAULT_VIEW', @@ -319,4 +323,5 @@ const createDataPluginMock = (esSearchStrategyMock: ISearchStrategy): any => ({ search: { getSearchStrategy: jest.fn().mockReturnValue(esSearchStrategyMock), }, + indexPatterns: getIndexPatternsMock(), }); diff --git a/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.ts b/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.ts index 32bb0596ab56..fc5dab9006df 100644 --- a/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.ts +++ b/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.ts @@ -21,7 +21,7 @@ import type { import { LogSourceColumnConfiguration, logSourceFieldColumnConfigurationRT, -} from '../../../common/http_api/log_sources'; +} from '../../../common/log_sources'; import { getLogEntryCursorFromHit, LogColumn, @@ -56,6 +56,7 @@ import { getSortDirection, LogEntryHit, } from './queries/log_entries'; +import { resolveLogSourceConfiguration } from '../../../common/log_sources'; type LogEntriesSearchRequest = IKibanaSearchRequest; type LogEntriesSearchResponse = IKibanaSearchResponse; @@ -74,15 +75,26 @@ export const logEntriesSearchStrategyProvider = ({ defer(() => { const request = decodeOrThrow(asyncRequestRT)(rawRequest); - const sourceConfiguration$ = defer(() => - sources.getSourceConfiguration(dependencies.savedObjectsClient, request.params.sourceId) + const resolvedSourceConfiguration$ = defer(() => + forkJoin([ + sources.getSourceConfiguration( + dependencies.savedObjectsClient, + request.params.sourceId + ), + data.indexPatterns.indexPatternsServiceFactory( + dependencies.savedObjectsClient, + dependencies.esClient.asCurrentUser + ), + ]).pipe( + concatMap(([sourceConfiguration, indexPatternsService]) => + resolveLogSourceConfiguration(sourceConfiguration.configuration, indexPatternsService) + ) + ) ).pipe(take(1), shareReplay(1)); const messageFormattingRules$ = defer(() => - sourceConfiguration$.pipe( - map(({ configuration }) => - compileFormattingRules(getBuiltinRules(configuration.fields.message)) - ) + resolvedSourceConfiguration$.pipe( + map(({ messageField }) => compileFormattingRules(getBuiltinRules(messageField))) ) ).pipe(take(1), shareReplay(1)); @@ -94,23 +106,23 @@ export const logEntriesSearchStrategyProvider = ({ const initialRequest$ = of(request).pipe( filter(asyncInitialRequestRT.is), concatMap(({ params }) => - forkJoin([sourceConfiguration$, messageFormattingRules$]).pipe( + forkJoin([resolvedSourceConfiguration$, messageFormattingRules$]).pipe( map( - ([{ configuration }, messageFormattingRules]): IEsSearchRequest => { + ([ + { indices, timestampField, tiebreakerField, columns }, + messageFormattingRules, + ]): IEsSearchRequest => { return { // @ts-expect-error @elastic/elasticsearch declares indices_boost as Record params: createGetLogEntriesQuery( - configuration.logAlias, + indices, params.startTimestamp, params.endTimestamp, pickRequestCursor(params), params.size + 1, - configuration.fields.timestamp, - configuration.fields.tiebreaker, - getRequiredFields( - params.columns ?? configuration.logColumns, - messageFormattingRules - ), + timestampField, + tiebreakerField, + getRequiredFields(params.columns ?? columns, messageFormattingRules), params.query, params.highlightPhrase ), @@ -126,18 +138,17 @@ export const logEntriesSearchStrategyProvider = ({ concatMap((esRequest) => esSearchStrategy.search(esRequest, options, dependencies)) ); - return combineLatest([searchResponse$, sourceConfiguration$, messageFormattingRules$]).pipe( - map(([esResponse, { configuration }, messageFormattingRules]) => { + return combineLatest([ + searchResponse$, + resolvedSourceConfiguration$, + messageFormattingRules$, + ]).pipe( + map(([esResponse, { columns }, messageFormattingRules]) => { const rawResponse = decodeOrThrow(getLogEntriesResponseRT)(esResponse.rawResponse); const entries = rawResponse.hits.hits .slice(0, request.params.size) - .map( - getLogEntryFromHit( - request.params.columns ?? configuration.logColumns, - messageFormattingRules - ) - ); + .map(getLogEntryFromHit(request.params.columns ?? columns, messageFormattingRules)); const sortDirection = getSortDirection(pickRequestCursor(request.params)); diff --git a/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.test.ts b/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.test.ts index 7ac8b71c04b2..785a4414a984 100644 --- a/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.test.ts +++ b/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.test.ts @@ -18,12 +18,14 @@ import { ISearchStrategy, SearchStrategyDependencies, } from 'src/plugins/data/server'; +import { getIndexPatternsMock } from './mocks'; import { createInfraSourcesMock } from '../../lib/sources/mocks'; import { logEntrySearchRequestStateRT, logEntrySearchStrategyProvider, } from './log_entry_search_strategy'; import { createSearchSessionsClientMock } from '../../../../../../src/plugins/data/server/search/mocks'; +import { InfraSource } from '../../../common/source_configuration/source_configuration'; describe('LogEntry search strategy', () => { it('handles initial search requests', async () => { @@ -197,13 +199,16 @@ describe('LogEntry search strategy', () => { }); }); -const createSourceConfigurationMock = () => ({ +const createSourceConfigurationMock = (): InfraSource => ({ id: 'SOURCE_ID', origin: 'stored' as const, configuration: { name: 'SOURCE_NAME', description: 'SOURCE_DESCRIPTION', - logAlias: 'log-indices-*', + logIndices: { + type: 'index_pattern', + indexPatternId: 'some-test-id', + }, metricAlias: 'metric-indices-*', inventoryDefaultView: 'DEFAULT_VIEW', metricsExplorerDefaultView: 'DEFAULT_VIEW', @@ -256,4 +261,5 @@ const createDataPluginMock = (esSearchStrategyMock: ISearchStrategy): any => ({ search: { getSearchStrategy: jest.fn().mockReturnValue(esSearchStrategyMock), }, + indexPatterns: getIndexPatternsMock(), }); diff --git a/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.ts b/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.ts index b6073f1bbe4c..c35c05d947da 100644 --- a/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.ts +++ b/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.ts @@ -6,7 +6,7 @@ */ import * as rt from 'io-ts'; -import { concat, defer, of } from 'rxjs'; +import { concat, defer, of, forkJoin } from 'rxjs'; import { concatMap, filter, map, shareReplay, take } from 'rxjs/operators'; import type { IEsSearchRequest, @@ -32,6 +32,7 @@ import { jsonFromBase64StringRT, } from '../../utils/typed_search_strategy'; import { createGetLogEntryQuery, getLogEntryResponseRT, LogEntryHit } from './queries/log_entry'; +import { resolveLogSourceConfiguration } from '../../../common/log_sources'; type LogEntrySearchRequest = IKibanaSearchRequest; type LogEntrySearchResponse = IKibanaSearchResponse; @@ -50,9 +51,22 @@ export const logEntrySearchStrategyProvider = ({ defer(() => { const request = decodeOrThrow(asyncRequestRT)(rawRequest); - const sourceConfiguration$ = defer(() => - sources.getSourceConfiguration(dependencies.savedObjectsClient, request.params.sourceId) - ).pipe(shareReplay(1)); + const resolvedSourceConfiguration$ = defer(() => + forkJoin([ + sources.getSourceConfiguration( + dependencies.savedObjectsClient, + request.params.sourceId + ), + data.indexPatterns.indexPatternsServiceFactory( + dependencies.savedObjectsClient, + dependencies.esClient.asCurrentUser + ), + ]).pipe( + concatMap(([sourceConfiguration, indexPatternsService]) => + resolveLogSourceConfiguration(sourceConfiguration.configuration, indexPatternsService) + ) + ) + ).pipe(take(1), shareReplay(1)); const recoveredRequest$ = of(request).pipe( filter(asyncRecoveredRequestRT.is), @@ -62,15 +76,15 @@ export const logEntrySearchStrategyProvider = ({ const initialRequest$ = of(request).pipe( filter(asyncInitialRequestRT.is), concatMap(({ params }) => - sourceConfiguration$.pipe( + resolvedSourceConfiguration$.pipe( map( - ({ configuration }): IEsSearchRequest => ({ + ({ indices, timestampField, tiebreakerField }): IEsSearchRequest => ({ // @ts-expect-error @elastic/elasticsearch declares indices_boost as Record params: createGetLogEntryQuery( - configuration.logAlias, + indices, params.logEntryId, - configuration.fields.timestamp, - configuration.fields.tiebreaker + timestampField, + tiebreakerField ), }) ) diff --git a/x-pack/plugins/infra/server/services/log_entries/mocks.ts b/x-pack/plugins/infra/server/services/log_entries/mocks.ts new file mode 100644 index 000000000000..7c508b98554e --- /dev/null +++ b/x-pack/plugins/infra/server/services/log_entries/mocks.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { IIndexPattern, IFieldType, IndexPatternsContract } from 'src/plugins/data/common'; + +const indexPatternFields: IFieldType[] = [ + { + name: 'event.dataset', + type: 'string', + esTypes: ['keyword'], + aggregatable: true, + filterable: true, + searchable: true, + }, +]; + +const indexPattern: IIndexPattern = { + id: '1234', + title: 'log-indices-*', + timeFieldName: '@timestamp', + fields: indexPatternFields, +}; + +export const getIndexPatternsMock = (): any => { + return { + indexPatternsServiceFactory: async () => { + return { + get: async (id) => indexPattern, + getFieldsForWildcard: async (options) => indexPatternFields, + } as Pick; + }, + }; +}; diff --git a/x-pack/plugins/infra/server/services/log_queries/get_log_query_fields.ts b/x-pack/plugins/infra/server/services/log_queries/get_log_query_fields.ts index 9497a8b44276..55491db97dbd 100644 --- a/x-pack/plugins/infra/server/services/log_queries/get_log_query_fields.ts +++ b/x-pack/plugins/infra/server/services/log_queries/get_log_query_fields.ts @@ -5,26 +5,31 @@ * 2.0. */ -import { SavedObjectsClientContract } from 'src/core/server'; +import { SavedObjectsClientContract, ElasticsearchClient } from 'src/core/server'; import { InfraSources } from '../../lib/sources'; +import { resolveLogSourceConfiguration } from '../../../common/log_sources'; +import { KibanaFramework } from '../../lib/adapters/framework/kibana_framework_adapter'; -// NOTE: TEMPORARY: This will become a subset of the new resolved KIP compatible log source configuration. export interface LogQueryFields { indexPattern: string; timestamp: string; } -// NOTE: TEMPORARY: This will become a subset of the new resolved KIP compatible log source configuration. -export const createGetLogQueryFields = (sources: InfraSources) => { +export const createGetLogQueryFields = (sources: InfraSources, framework: KibanaFramework) => { return async ( sourceId: string, - savedObjectsClient: SavedObjectsClientContract + savedObjectsClient: SavedObjectsClientContract, + elasticsearchClient: ElasticsearchClient ): Promise => { const source = await sources.getSourceConfiguration(savedObjectsClient, sourceId); + const resolvedLogSourceConfiguration = await resolveLogSourceConfiguration( + source.configuration, + await framework.getIndexPatternsService(savedObjectsClient, elasticsearchClient) + ); return { - indexPattern: source.configuration.logAlias, - timestamp: source.configuration.fields.timestamp, + indexPattern: resolvedLogSourceConfiguration.indices, + timestamp: resolvedLogSourceConfiguration.timestampField, }; }; }; diff --git a/x-pack/plugins/infra/server/utils/elasticsearch_runtime_types.ts b/x-pack/plugins/infra/server/utils/elasticsearch_runtime_types.ts index b0e4685f5b92..e2dbf02ae2d0 100644 --- a/x-pack/plugins/infra/server/utils/elasticsearch_runtime_types.ts +++ b/x-pack/plugins/infra/server/utils/elasticsearch_runtime_types.ts @@ -7,12 +7,12 @@ import * as rt from 'io-ts'; -export const shardFailureRT = rt.type({ - index: rt.string, - node: rt.string, - reason: rt.type({ - reason: rt.string, - type: rt.string, +export const shardFailureRT = rt.partial({ + index: rt.union([rt.string, rt.null]), + node: rt.union([rt.string, rt.null]), + reason: rt.partial({ + reason: rt.union([rt.string, rt.null]), + type: rt.union([rt.string, rt.null]), }), shard: rt.number, }); diff --git a/x-pack/plugins/infra/server/utils/typed_search_strategy.ts b/x-pack/plugins/infra/server/utils/typed_search_strategy.ts index 358eda6375f1..546fd90a2da5 100644 --- a/x-pack/plugins/infra/server/utils/typed_search_strategy.ts +++ b/x-pack/plugins/infra/server/utils/typed_search_strategy.ts @@ -51,9 +51,9 @@ export const createAsyncRequestRTs = ({ type: 'shardFailure' as const, shardInfo: { - index: failure.index, - node: failure.node, - shard: failure.shard, + index: failure.index ?? null, + node: failure.node ?? null, + shard: failure.shard ?? null, }, - message: failure.reason.reason, + message: failure.reason?.reason ?? null, }); diff --git a/x-pack/plugins/lens/common/constants.test.ts b/x-pack/plugins/lens/common/constants.test.ts new file mode 100644 index 000000000000..1bf3ec49a478 --- /dev/null +++ b/x-pack/plugins/lens/common/constants.test.ts @@ -0,0 +1,30 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { getEditPath } from './constants'; + +describe('getEditPath', function () { + it('should return value when no time range', function () { + expect(getEditPath(undefined)).toEqual('#/edit_by_value'); + }); + + it('should return value when no time range but id is given', function () { + expect(getEditPath('1234354')).toEqual('#/edit/1234354'); + }); + + it('should return value when time range is given', function () { + expect(getEditPath(undefined, { from: 'now-15m', to: 'now' })).toEqual( + '#/edit_by_value?_g=(time:(from:now-15m,to:now))' + ); + }); + + it('should return value when time range and id is given', function () { + expect(getEditPath('12345', { from: 'now-15m', to: 'now' })).toEqual( + '#/edit/12345?_g=(time:(from:now-15m,to:now))' + ); + }); +}); diff --git a/x-pack/plugins/lens/common/constants.ts b/x-pack/plugins/lens/common/constants.ts index c3e556b16788..26edf66130ee 100644 --- a/x-pack/plugins/lens/common/constants.ts +++ b/x-pack/plugins/lens/common/constants.ts @@ -5,6 +5,9 @@ * 2.0. */ +import rison from 'rison-node'; +import type { TimeRange } from '../../../../src/plugins/data/common/query'; + export const PLUGIN_ID = 'lens'; export const APP_ID = 'lens'; export const LENS_EMBEDDABLE_TYPE = 'lens'; @@ -17,8 +20,18 @@ export function getBasePath() { return `#/`; } -export function getEditPath(id: string | undefined) { - return id ? `#/edit/${encodeURIComponent(id)}` : `#/${LENS_EDIT_BY_VALUE}`; +const GLOBAL_RISON_STATE_PARAM = '_g'; + +export function getEditPath(id: string | undefined, timeRange?: TimeRange) { + let timeParam = ''; + + if (timeRange) { + timeParam = `?${GLOBAL_RISON_STATE_PARAM}=${rison.encode({ time: timeRange })}`; + } + + return id + ? `#/edit/${encodeURIComponent(id)}${timeParam}` + : `#/${LENS_EDIT_BY_VALUE}${timeParam}`; } export function getFullPath(id?: string) { diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/dimension_container.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/dimension_container.tsx index 574cd4029223..f66e8ba87e8e 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/dimension_container.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/dimension_container.tsx @@ -7,7 +7,7 @@ import './dimension_container.scss'; -import React, { useState, useEffect } from 'react'; +import React, { useState, useEffect, useCallback } from 'react'; import { EuiFlyoutHeader, EuiFlyoutFooter, @@ -18,6 +18,8 @@ import { EuiFlexItem, EuiFocusTrap, EuiOutsideClickDetector, + EuiWindowEvent, + keys, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; @@ -35,10 +37,10 @@ export function DimensionContainer({ }) { const [focusTrapIsEnabled, setFocusTrapIsEnabled] = useState(false); - const closeFlyout = () => { + const closeFlyout = useCallback(() => { handleClose(); setFocusTrapIsEnabled(false); - }; + }, [handleClose]); useEffect(() => { if (isOpen) { @@ -49,8 +51,19 @@ export function DimensionContainer({ } }, [isOpen]); + const closeOnEscape = useCallback( + (event: KeyboardEvent) => { + if (event.key === keys.ESCAPE) { + event.preventDefault(); + closeFlyout(); + } + }, + [closeFlyout] + ); + return isOpen ? ( +
{ operation: { dataType: 'number', isBucketed: false, - label: 'Cumulative sum of Records', + label: 'Cumulative sum of Records label', scale: undefined, }, }, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions.test.ts index 3add39cc5fb8..c131b1651282 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions.test.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions.test.ts @@ -11,7 +11,10 @@ import { countOperation, counterRateOperation, movingAverageOperation, + cumulativeSumOperation, derivativeOperation, + AvgIndexPatternColumn, + DerivativeIndexPatternColumn, } from './definitions'; import { getFieldByNameFactory } from '../pure_helpers'; import { documentField } from '../document_field'; @@ -35,7 +38,7 @@ const indexPatternFields = [ }, { name: 'bytes', - displayName: 'bytes', + displayName: 'bytesLabel', type: 'number', aggregatable: true, searchable: true, @@ -98,6 +101,73 @@ const baseColumnArgs: { field: indexPattern.fields[2], }; +const layer: IndexPatternLayer = { + indexPatternId: '1', + columnOrder: ['date', 'metric', 'ref'], + columns: { + date: { + label: '', + customLabel: true, + dataType: 'date', + isBucketed: true, + operationType: 'date_histogram', + sourceField: 'timestamp', + params: { interval: 'auto' }, + }, + metric: { + label: 'metricLabel', + customLabel: true, + dataType: 'number', + isBucketed: false, + operationType: 'average', + sourceField: 'bytes', + params: {}, + } as AvgIndexPatternColumn, + ref: { + label: '', + customLabel: true, + dataType: 'number', + isBucketed: false, + operationType: 'differences', + references: ['metric'], + } as DerivativeIndexPatternColumn, + }, +}; + +describe('labels', () => { + const calcColumnArgs = { + ...baseColumnArgs, + referenceIds: ['metric'], + layer, + previousColumn: layer.columns.metric, + }; + it('should use label of referenced operation to create label for derivative and moving average', () => { + expect(derivativeOperation.buildColumn(calcColumnArgs)).toEqual( + expect.objectContaining({ + label: 'Differences of metricLabel', + }) + ); + expect(movingAverageOperation.buildColumn(calcColumnArgs)).toEqual( + expect.objectContaining({ + label: 'Moving average of metricLabel', + }) + ); + }); + + it('should use displayName of a field for a label for counter rate and cumulative sum', () => { + expect(counterRateOperation.buildColumn(calcColumnArgs)).toEqual( + expect.objectContaining({ + label: 'Counter rate of bytesLabel per second', + }) + ); + expect(cumulativeSumOperation.buildColumn(calcColumnArgs)).toEqual( + expect.objectContaining({ + label: 'Cumulative sum of bytesLabel', + }) + ); + }); +}); + describe('time scale transition', () => { it('should carry over time scale and adjust label on operation from count to sum', () => { expect( @@ -107,7 +177,7 @@ describe('time scale transition', () => { ).toEqual( expect.objectContaining({ timeScale: 'h', - label: 'Sum of bytes per hour', + label: 'Sum of bytesLabel per hour', }) ); }); @@ -125,27 +195,6 @@ describe('time scale transition', () => { ); }); - it('should carry over time scale and adjust label on operation from sum to count', () => { - expect( - countOperation.buildColumn({ - ...baseColumnArgs, - previousColumn: { - label: 'Sum of bytes per hour', - timeScale: 'h', - dataType: 'number', - isBucketed: false, - operationType: 'sum', - sourceField: 'bytes', - }, - }) - ).toEqual( - expect.objectContaining({ - timeScale: 'h', - label: 'Count of records per hour', - }) - ); - }); - it('should not set time scale if it was not set previously', () => { expect( countOperation.buildColumn({ @@ -188,7 +237,7 @@ describe('time scale transition', () => { expect( sumOperation.onFieldChange( { - label: 'Sum of bytes per hour', + label: 'Sum of bytesLabel per hour', timeScale: 'h', dataType: 'number', isBucketed: false, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx index 331aa528e6d5..c57f70ba1b58 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx @@ -66,16 +66,26 @@ export const counterRateOperation: OperationDefinition< }, getDefaultLabel: (column, indexPattern, columns) => { const ref = columns[column.references[0]]; - return ofName(ref && 'sourceField' in ref ? ref.sourceField : undefined, column.timeScale); + return ofName( + ref && 'sourceField' in ref + ? indexPattern.getFieldByName(ref.sourceField)?.displayName + : undefined, + column.timeScale + ); }, toExpression: (layer, columnId) => { return dateBasedOperationToExpression(layer, columnId, 'lens_counter_rate'); }, - buildColumn: ({ referenceIds, previousColumn, layer }) => { + buildColumn: ({ referenceIds, previousColumn, layer, indexPattern }) => { const metric = layer.columns[referenceIds[0]]; const timeScale = previousColumn?.timeScale || DEFAULT_TIME_SCALE; return { - label: ofName(metric && 'sourceField' in metric ? metric.sourceField : undefined, timeScale), + label: ofName( + metric && 'sourceField' in metric + ? indexPattern.getFieldByName(metric.sourceField)?.displayName + : undefined, + timeScale + ), dataType: 'number', operationType: 'counter_rate', isBucketed: false, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx index 1664f3639b59..7cec1fa0d4bb 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx @@ -64,15 +64,23 @@ export const cumulativeSumOperation: OperationDefinition< }, getDefaultLabel: (column, indexPattern, columns) => { const ref = columns[column.references[0]]; - return ofName(ref && 'sourceField' in ref ? ref.sourceField : undefined); + return ofName( + ref && 'sourceField' in ref + ? indexPattern.getFieldByName(ref.sourceField)?.displayName + : undefined + ); }, toExpression: (layer, columnId) => { return dateBasedOperationToExpression(layer, columnId, 'cumulative_sum'); }, - buildColumn: ({ referenceIds, previousColumn, layer }) => { + buildColumn: ({ referenceIds, previousColumn, layer, indexPattern }) => { const ref = layer.columns[referenceIds[0]]; return { - label: ofName(ref && 'sourceField' in ref ? ref.sourceField : undefined), + label: ofName( + ref && 'sourceField' in ref + ? indexPattern.getFieldByName(ref.sourceField)?.displayName + : undefined + ), dataType: 'number', operationType: 'cumulative_sum', isBucketed: false, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx index c50e9270eaac..bef3fbc2e48a 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx @@ -66,8 +66,7 @@ export const derivativeOperation: OperationDefinition< } }, getDefaultLabel: (column, indexPattern, columns) => { - const ref = columns[column.references[0]]; - return ofName(ref && 'sourceField' in ref ? ref.sourceField : undefined, column.timeScale); + return ofName(columns[column.references[0]]?.label, column.timeScale); }, toExpression: (layer, columnId) => { return dateBasedOperationToExpression(layer, columnId, 'derivative'); @@ -75,10 +74,7 @@ export const derivativeOperation: OperationDefinition< buildColumn: ({ referenceIds, previousColumn, layer }) => { const ref = layer.columns[referenceIds[0]]; return { - label: ofName( - ref && 'sourceField' in ref ? ref.sourceField : undefined, - previousColumn?.timeScale - ), + label: ofName(ref?.label, previousColumn?.timeScale), dataType: 'number', operationType: OPERATION_NAME, isBucketed: false, diff --git a/x-pack/plugins/lens/public/plugin.ts b/x-pack/plugins/lens/public/plugin.ts index aed4db2e88e2..81937f3f4155 100644 --- a/x-pack/plugins/lens/public/plugin.ts +++ b/x-pack/plugins/lens/public/plugin.ts @@ -96,7 +96,7 @@ export interface LensPublicStart { * * @experimental */ - navigateToPrefilledEditor: (input: LensEmbeddableInput) => void; + navigateToPrefilledEditor: (input: LensEmbeddableInput, openInNewTab?: boolean) => void; /** * Method which returns true if the user has permission to use Lens as defined by application capabilities. */ @@ -243,8 +243,9 @@ export class LensPlugin { return { EmbeddableComponent: getEmbeddableComponent(startDependencies.embeddable), - navigateToPrefilledEditor: (input: LensEmbeddableInput) => { - if (input.timeRange) { + navigateToPrefilledEditor: (input: LensEmbeddableInput, openInNewTab?: boolean) => { + // for openInNewTab, we set the time range in url via getEditPath below + if (input.timeRange && !openInNewTab) { startDependencies.data.query.timefilter.timefilter.setTime(input.timeRange); } const transfer = new EmbeddableStateTransfer( @@ -252,7 +253,8 @@ export class LensPlugin { core.application.currentAppId$ ); transfer.navigateToEditor('lens', { - path: getEditPath(undefined), + openInNewTab, + path: getEditPath(undefined, openInNewTab ? input.timeRange : undefined), state: { originatingApp: '', valueInput: input, diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap index 268ce4cbb516..95921fa61233 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap @@ -1,5 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`AddLicense component when license is active should display correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; +exports[`AddLicense component when license is active should display correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; -exports[`AddLicense component when license is expired should display with correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; +exports[`AddLicense component when license is expired should display with correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap index b75dee3c7830..4d8b653c4b10 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap @@ -1,9 +1,9 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`RequestTrialExtension component should display when enterprise license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when enterprise license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; -exports[`RequestTrialExtension component should display when license is active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when license is active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; -exports[`RequestTrialExtension component should display when license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; -exports[`RequestTrialExtension component should display when platinum license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when platinum license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription features(opens in a new tab or window), request an extension now.

Extend trial
"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap index 00737c708b82..be634a5b4f74 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap @@ -1,7 +1,7 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`RevertToBasic component should display when license is about to expire 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription features(opens in a new tab or window).

"`; +exports[`RevertToBasic component should display when license is about to expire 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription features(opens in a new tab or window).

"`; -exports[`RevertToBasic component should display when license is expired 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription features(opens in a new tab or window).

"`; +exports[`RevertToBasic component should display when license is expired 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription features(opens in a new tab or window).

"`; -exports[`RevertToBasic component should display when trial is active 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription features(opens in a new tab or window).

"`; +exports[`RevertToBasic component should display when trial is active 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription features(opens in a new tab or window).

"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap index 9f08c5f11c2a..1cacadb82463 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap @@ -1,9 +1,9 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`StartTrial component when trial is allowed display for basic license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed display for basic license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; -exports[`StartTrial component when trial is allowed should display for expired enterprise license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed should display for expired enterprise license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; -exports[`StartTrial component when trial is allowed should display for expired platinum license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed should display for expired platinum license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; -exports[`StartTrial component when trial is allowed should display for gold license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed should display for gold license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription features(opens in a new tab or window) have to offer.

"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap index c89d18328221..c785ed7c99bd 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap @@ -268,9 +268,11 @@ exports[`UploadLicense should display a modal when license requires acknowledgem
{ // @ts-expect-error const call = syncContext.stopLoading.getCall(0); - expect(call.args[2]).toEqual(defaultConfig); + expect(call.args[2]!.minSourceZoom).toEqual(defaultConfig.minSourceZoom); + expect(call.args[2]!.maxSourceZoom).toEqual(defaultConfig.maxSourceZoom); + expect(call.args[2]!.layerName).toEqual(defaultConfig.layerName); + expect(call.args[2]!.urlTemplate!.startsWith(defaultConfig.urlTemplate)).toEqual(true); }); it('Should not resync when no changes to source params', async () => { @@ -185,7 +188,12 @@ describe('syncData', () => { // @ts-expect-error const call = syncContext.stopLoading.getCall(0); - expect(call.args[2]).toEqual({ ...defaultConfig, ...changes }); + + const newMeta = { ...defaultConfig, ...changes }; + expect(call.args[2]!.minSourceZoom).toEqual(newMeta.minSourceZoom); + expect(call.args[2]!.maxSourceZoom).toEqual(newMeta.maxSourceZoom); + expect(call.args[2]!.layerName).toEqual(newMeta.layerName); + expect(call.args[2]!.urlTemplate!.startsWith(newMeta.urlTemplate)).toEqual(true); }); }); }); diff --git a/x-pack/plugins/maps/public/classes/layers/tiled_vector_layer/tiled_vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/tiled_vector_layer/tiled_vector_layer.tsx index f2fe91695380..90c4896f2a28 100644 --- a/x-pack/plugins/maps/public/classes/layers/tiled_vector_layer/tiled_vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/tiled_vector_layer/tiled_vector_layer.tsx @@ -13,6 +13,7 @@ import { } from 'mapbox-gl'; import { EuiIcon } from '@elastic/eui'; import { Feature } from 'geojson'; +import uuid from 'uuid/v4'; import { IVectorStyle, VectorStyle } from '../../styles/vector/vector_style'; import { SOURCE_DATA_REQUEST_ID, LAYER_TYPE } from '../../../../common/constants'; import { VectorLayer, VectorLayerArguments } from '../vector_layer'; @@ -24,6 +25,7 @@ import { } from '../../../../common/descriptor_types'; import { MVTSingleLayerVectorSourceConfig } from '../../sources/mvt_single_layer_vector_source/types'; import { canSkipSourceUpdate } from '../../util/can_skip_fetch'; +import { isRefreshOnlyQuery } from '../../util/is_refresh_only_query'; export class TiledVectorLayer extends VectorLayer { static type = LAYER_TYPE.TILED_VECTOR; @@ -69,7 +71,6 @@ export class TiledVectorLayer extends VectorLayer { this._style as IVectorStyle ); const prevDataRequest = this.getSourceDataRequest(); - const dataRequest = await this._source.getUrlTemplateWithMeta(searchFilters); if (prevDataRequest) { const data: MVTSingleLayerVectorSourceConfig = prevDataRequest.getData() as MVTSingleLayerVectorSourceConfig; if (data) { @@ -92,7 +93,22 @@ export class TiledVectorLayer extends VectorLayer { startLoading(SOURCE_DATA_REQUEST_ID, requestToken, searchFilters); try { - stopLoading(SOURCE_DATA_REQUEST_ID, requestToken, dataRequest, {}); + const prevMeta = prevDataRequest ? prevDataRequest.getMeta() : undefined; + const prevData = prevDataRequest + ? (prevDataRequest.getData() as MVTSingleLayerVectorSourceConfig) + : undefined; + const urlToken = + !prevData || isRefreshOnlyQuery(prevMeta ? prevMeta.query : undefined, searchFilters.query) + ? uuid() + : prevData.urlToken; + + const newUrlTemplateAndMeta = await this._source.getUrlTemplateWithMeta(searchFilters); + const urlTemplateAndMetaWithToken = { + ...newUrlTemplateAndMeta, + urlToken, + urlTemplate: newUrlTemplateAndMeta.urlTemplate + `&token=${urlToken}`, + }; + stopLoading(SOURCE_DATA_REQUEST_ID, requestToken, urlTemplateAndMetaWithToken, {}); } catch (error) { onLoadError(SOURCE_DATA_REQUEST_ID, requestToken, error.message); } @@ -113,7 +129,7 @@ export class TiledVectorLayer extends VectorLayer { if (!sourceDataRequest) { // this is possible if the layer was invisible at startup. // the actions will not perform any data=syncing as an optimization when a layer is invisible - // when turning the layer back into visible, it's possible the url has not been resovled yet. + // when turning the layer back into visible, it's possible the url had not been resolved yet. return; } diff --git a/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts b/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts index 5ac487c71317..ad413419a289 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts @@ -125,7 +125,7 @@ describe('ESGeoGridSource', () => { getHttp.mockReturnValue({ basePath: { prepend(path: string) { - return `rootdir${path};`; + return `rootdir${path}`; }, }, }); @@ -282,8 +282,8 @@ describe('ESGeoGridSource', () => { expect(urlTemplateWithMeta.layerName).toBe('source_layer'); expect(urlTemplateWithMeta.minSourceZoom).toBe(0); expect(urlTemplateWithMeta.maxSourceZoom).toBe(24); - expect(urlTemplateWithMeta.urlTemplate).toBe( - "rootdir/api/maps/mvt/getGridTile;?x={x}&y={y}&z={z}&geometryFieldName=bar&index=undefined&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:())),'1':('0':size,'1':0),'2':('0':filter,'1':!((geo_bounding_box:(bar:(bottom_right:!(180,-82.67628),top_left:!(-180,82.67628))),meta:(alias:!n,disabled:!f,key:bar,negate:!f)))),'3':('0':query),'4':('0':index,'1':(fields:())),'5':('0':query,'1':(language:KQL,query:'',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':aggs,'1':(gridSplit:(aggs:(gridCentroid:(geo_centroid:(field:bar))),geotile_grid:(bounds:!n,field:bar,precision:!n,shard_size:65535,size:65535))))))&requestType=heatmap&geoFieldType=geo_point" + expect(urlTemplateWithMeta.urlTemplate).toEqual( + "rootdir/api/maps/mvt/getGridTile/{z}/{x}/{y}.pbf?geometryFieldName=bar&index=undefined&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:())),'1':('0':size,'1':0),'2':('0':filter,'1':!((geo_bounding_box:(bar:(bottom_right:!(180,-82.67628),top_left:!(-180,82.67628))),meta:(alias:!n,disabled:!f,key:bar,negate:!f)))),'3':('0':query),'4':('0':index,'1':(fields:())),'5':('0':query,'1':(language:KQL,query:'',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':aggs,'1':(gridSplit:(aggs:(gridCentroid:(geo_centroid:(field:bar))),geotile_grid:(bounds:!n,field:bar,precision:!n,shard_size:65535,size:65535))))))&requestType=heatmap&geoFieldType=geo_point" ); }); @@ -293,9 +293,13 @@ describe('ESGeoGridSource', () => { searchSessionId: '1', }); - expect(urlTemplateWithMeta.urlTemplate).toBe( - "rootdir/api/maps/mvt/getGridTile;?x={x}&y={y}&z={z}&geometryFieldName=bar&index=undefined&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:())),'1':('0':size,'1':0),'2':('0':filter,'1':!((geo_bounding_box:(bar:(bottom_right:!(180,-82.67628),top_left:!(-180,82.67628))),meta:(alias:!n,disabled:!f,key:bar,negate:!f)))),'3':('0':query),'4':('0':index,'1':(fields:())),'5':('0':query,'1':(language:KQL,query:'',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':aggs,'1':(gridSplit:(aggs:(gridCentroid:(geo_centroid:(field:bar))),geotile_grid:(bounds:!n,field:bar,precision:!n,shard_size:65535,size:65535))))))&requestType=heatmap&geoFieldType=geo_point&searchSessionId=1" - ); + expect( + urlTemplateWithMeta.urlTemplate.startsWith( + "rootdir/api/maps/mvt/getGridTile/{z}/{x}/{y}.pbf?geometryFieldName=bar&index=undefined&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:())),'1':('0':size,'1':0),'2':('0':filter,'1':!((geo_bounding_box:(bar:(bottom_right:!(180,-82.67628),top_left:!(-180,82.67628))),meta:(alias:!n,disabled:!f,key:bar,negate:!f)))),'3':('0':query),'4':('0':index,'1':(fields:())),'5':('0':query,'1':(language:KQL,query:'',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':aggs,'1':(gridSplit:(aggs:(gridCentroid:(geo_centroid:(field:bar))),geotile_grid:(bounds:!n,field:bar,precision:!n,shard_size:65535,size:65535))))))&requestType=heatmap&geoFieldType=geo_point" + ) + ).toBe(true); + + expect(urlTemplateWithMeta.urlTemplate.endsWith('&searchSessionId=1')).toBe(true); }); }); diff --git a/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx b/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx index d601e4fa9a39..e9cf62d8f408 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx +++ b/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx @@ -441,19 +441,17 @@ export class ESGeoGridSource extends AbstractESAggSource implements ITiledSingle const risonDsl = rison.encode(dsl); const mvtUrlServicePath = getHttp().basePath.prepend( - `/${GIS_API_PATH}/${MVT_GETGRIDTILE_API_PATH}` + `/${GIS_API_PATH}/${MVT_GETGRIDTILE_API_PATH}/{z}/{x}/{y}.pbf` ); const geoField = await this._getGeoField(); const urlTemplate = `${mvtUrlServicePath}\ -?x={x}\ -&y={y}\ -&z={z}\ -&geometryFieldName=${this._descriptor.geoField}\ +?geometryFieldName=${this._descriptor.geoField}\ &index=${indexPattern.title}\ &requestBody=${risonDsl}\ &requestType=${this._descriptor.requestType}\ &geoFieldType=${geoField.type}`; + return { layerName: this.getLayerName(), minSourceZoom: this.getMinZoom(), diff --git a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts index c5b1d6e0b7ba..014dfe7da929 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts @@ -83,7 +83,7 @@ describe('ESSearchSource', () => { getHttp.mockReturnValue({ basePath: { prepend(path: string) { - return `rootdir${path};`; + return `rootdir${path}`; }, }, }); @@ -115,7 +115,7 @@ describe('ESSearchSource', () => { }); const urlTemplateWithMeta = await esSearchSource.getUrlTemplateWithMeta(searchFilters); expect(urlTemplateWithMeta.urlTemplate).toBe( - `rootdir/api/maps/mvt/getTile;?x={x}&y={y}&z={z}&geometryFieldName=bar&index=foobar-title-*&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:(),title:'foobar-title-*')),'1':('0':size,'1':1000),'2':('0':filter,'1':!()),'3':('0':query),'4':('0':index,'1':(fields:(),title:'foobar-title-*')),'5':('0':query,'1':(language:KQL,query:'tooltipField: foobar',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':fieldsFromSource,'1':!(tooltipField,styleField)),'7':('0':source,'1':!(tooltipField,styleField))))&geoFieldType=geo_shape` + `rootdir/api/maps/mvt/getTile/{z}/{x}/{y}.pbf?geometryFieldName=bar&index=foobar-title-*&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:(),title:'foobar-title-*')),'1':('0':size,'1':1000),'2':('0':filter,'1':!()),'3':('0':query),'4':('0':index,'1':(fields:(),title:'foobar-title-*')),'5':('0':query,'1':(language:KQL,query:'tooltipField: foobar',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':fieldsFromSource,'1':!(tooltipField,styleField)),'7':('0':source,'1':!(tooltipField,styleField))))&geoFieldType=geo_shape` ); }); @@ -129,7 +129,7 @@ describe('ESSearchSource', () => { searchSessionId: '1', }); expect(urlTemplateWithMeta.urlTemplate).toBe( - `rootdir/api/maps/mvt/getTile;?x={x}&y={y}&z={z}&geometryFieldName=bar&index=foobar-title-*&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:(),title:'foobar-title-*')),'1':('0':size,'1':1000),'2':('0':filter,'1':!()),'3':('0':query),'4':('0':index,'1':(fields:(),title:'foobar-title-*')),'5':('0':query,'1':(language:KQL,query:'tooltipField: foobar',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':fieldsFromSource,'1':!(tooltipField,styleField)),'7':('0':source,'1':!(tooltipField,styleField))))&geoFieldType=geo_shape&searchSessionId=1` + `rootdir/api/maps/mvt/getTile/{z}/{x}/{y}.pbf?geometryFieldName=bar&index=foobar-title-*&requestBody=(foobar:ES_DSL_PLACEHOLDER,params:('0':('0':index,'1':(fields:(),title:'foobar-title-*')),'1':('0':size,'1':1000),'2':('0':filter,'1':!()),'3':('0':query),'4':('0':index,'1':(fields:(),title:'foobar-title-*')),'5':('0':query,'1':(language:KQL,query:'tooltipField: foobar',queryLastTriggeredAt:'2019-04-25T20:53:22.331Z')),'6':('0':fieldsFromSource,'1':!(tooltipField,styleField)),'7':('0':source,'1':!(tooltipField,styleField))))&geoFieldType=geo_shape&searchSessionId=1` ); }); }); diff --git a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx index 82d7b09e9c3f..ff4675413985 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx +++ b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx @@ -710,19 +710,17 @@ export class ESSearchSource extends AbstractESSource implements ITiledSingleLaye const risonDsl = rison.encode(dsl); const mvtUrlServicePath = getHttp().basePath.prepend( - `/${GIS_API_PATH}/${MVT_GETTILE_API_PATH}` + `/${GIS_API_PATH}/${MVT_GETTILE_API_PATH}/{z}/{x}/{y}.pbf` ); const geoField = await this._getGeoField(); const urlTemplate = `${mvtUrlServicePath}\ -?x={x}\ -&y={y}\ -&z={z}\ -&geometryFieldName=${this._descriptor.geoField}\ +?geometryFieldName=${this._descriptor.geoField}\ &index=${indexPattern.title}\ &requestBody=${risonDsl}\ &geoFieldType=${geoField.type}`; + return { layerName: this.getLayerName(), minSourceZoom: this.getMinZoom(), diff --git a/x-pack/plugins/maps/public/classes/sources/mvt_single_layer_vector_source/types.ts b/x-pack/plugins/maps/public/classes/sources/mvt_single_layer_vector_source/types.ts index 27e148d9bcb2..fb7d7e135b86 100644 --- a/x-pack/plugins/maps/public/classes/sources/mvt_single_layer_vector_source/types.ts +++ b/x-pack/plugins/maps/public/classes/sources/mvt_single_layer_vector_source/types.ts @@ -14,4 +14,5 @@ export interface MVTSingleLayerVectorSourceConfig { maxSourceZoom: number; fields?: MVTFieldDescriptor[]; tooltipProperties?: string[]; + urlToken?: string; } diff --git a/x-pack/plugins/maps/server/mvt/mvt_routes.ts b/x-pack/plugins/maps/server/mvt/mvt_routes.ts index 1423e4ef5a20..b844d5400e2f 100644 --- a/x-pack/plugins/maps/server/mvt/mvt_routes.ts +++ b/x-pack/plugins/maps/server/mvt/mvt_routes.ts @@ -21,7 +21,7 @@ import { } from '../../common/constants'; import { getGridTile, getTile } from './get_tile'; -const CACHE_TIMEOUT = 0; // Todo. determine good value. Unsure about full-implications (e.g. wrt. time-based data). +const CACHE_TIMEOUT_SECONDS = 60 * 60; export function initMVTRoutes({ router, @@ -32,17 +32,20 @@ export function initMVTRoutes({ }) { router.get( { - path: `${API_ROOT_PATH}/${MVT_GETTILE_API_PATH}`, + path: `${API_ROOT_PATH}/${MVT_GETTILE_API_PATH}/{z}/{x}/{y}.pbf`, validate: { - query: schema.object({ + params: schema.object({ x: schema.number(), y: schema.number(), z: schema.number(), + }), + query: schema.object({ geometryFieldName: schema.string(), requestBody: schema.string(), index: schema.string(), geoFieldType: schema.string(), searchSessionId: schema.maybe(schema.string()), + token: schema.maybe(schema.string()), }), }, }, @@ -51,7 +54,7 @@ export function initMVTRoutes({ request: KibanaRequest, unknown>, response: KibanaResponseFactory ) => { - const { query } = request; + const { query, params } = request; const abortController = new AbortController(); request.events.aborted$.subscribe(() => { @@ -64,9 +67,9 @@ export function initMVTRoutes({ logger, context, geometryFieldName: query.geometryFieldName as string, - x: query.x as number, - y: query.y as number, - z: query.z as number, + x: parseInt((params as any).x, 10) as number, + y: parseInt((params as any).y, 10) as number, + z: parseInt((params as any).z, 10) as number, index: query.index as string, requestBody: requestBodyDSL as any, geoFieldType: query.geoFieldType as ES_GEO_FIELD_TYPE, @@ -80,18 +83,21 @@ export function initMVTRoutes({ router.get( { - path: `${API_ROOT_PATH}/${MVT_GETGRIDTILE_API_PATH}`, + path: `${API_ROOT_PATH}/${MVT_GETGRIDTILE_API_PATH}/{z}/{x}/{y}.pbf`, validate: { - query: schema.object({ + params: schema.object({ x: schema.number(), y: schema.number(), z: schema.number(), + }), + query: schema.object({ geometryFieldName: schema.string(), requestBody: schema.string(), index: schema.string(), requestType: schema.string(), geoFieldType: schema.string(), searchSessionId: schema.maybe(schema.string()), + token: schema.maybe(schema.string()), }), }, }, @@ -100,7 +106,7 @@ export function initMVTRoutes({ request: KibanaRequest, unknown>, response: KibanaResponseFactory ) => { - const { query } = request; + const { query, params } = request; const abortController = new AbortController(); request.events.aborted$.subscribe(() => { abortController.abort(); @@ -112,9 +118,9 @@ export function initMVTRoutes({ logger, context, geometryFieldName: query.geometryFieldName as string, - x: query.x as number, - y: query.y as number, - z: query.z as number, + x: parseInt((params as any).x, 10) as number, + y: parseInt((params as any).y, 10) as number, + z: parseInt((params as any).z, 10) as number, index: query.index as string, requestBody: requestBodyDSL as any, requestType: query.requestType as RENDER_AS, @@ -133,7 +139,8 @@ function sendResponse(response: KibanaResponseFactory, tile: any) { 'content-disposition': 'inline', 'content-length': tile ? `${tile.length}` : `0`, 'Content-Type': 'application/x-protobuf', - 'Cache-Control': `max-age=${CACHE_TIMEOUT}`, + 'Cache-Control': `public, max-age=${CACHE_TIMEOUT_SECONDS}`, + 'Last-Modified': `${new Date().toUTCString()}`, }; if (tile) { diff --git a/x-pack/plugins/ml/public/application/components/anomalies_table/links_menu.js b/x-pack/plugins/ml/public/application/components/anomalies_table/links_menu.js index 116dc88b266c..7339b50d4ab3 100644 --- a/x-pack/plugins/ml/public/application/components/anomalies_table/links_menu.js +++ b/x-pack/plugins/ml/public/application/components/anomalies_table/links_menu.js @@ -465,7 +465,7 @@ class LinksMenuUI extends Component { > ); diff --git a/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/actions_section.test.js.snap b/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/actions_section.test.js.snap index 9b6932716dd8..6de2f82c4dda 100644 --- a/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/actions_section.test.js.snap +++ b/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/actions_section.test.js.snap @@ -5,7 +5,7 @@ exports[`ActionsSection renders with no actions selected 1`] = `

@@ -105,7 +105,7 @@ exports[`ActionsSection renders with skip_result and skip_model_update selected

@@ -205,7 +205,7 @@ exports[`ActionsSection renders with skip_result selected 1`] = `

diff --git a/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap b/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap index b4a424535c9e..f790d70b0bc8 100644 --- a/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap +++ b/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap @@ -21,7 +21,7 @@ exports[`RuleEditorFlyout renders the flyout after adding a condition to a rule id="flyoutTitle" > @@ -91,7 +91,7 @@ exports[`RuleEditorFlyout renders the flyout after adding a condition to a rule

@@ -266,7 +266,7 @@ exports[`RuleEditorFlyout renders the flyout after setting the rule to edit 1`] id="flyoutTitle" > @@ -350,7 +350,7 @@ exports[`RuleEditorFlyout renders the flyout after setting the rule to edit 1`]

@@ -525,7 +525,7 @@ exports[`RuleEditorFlyout renders the flyout for creating a rule with conditions id="flyoutTitle" > @@ -595,7 +595,7 @@ exports[`RuleEditorFlyout renders the flyout for creating a rule with conditions

@@ -762,7 +762,7 @@ exports[`RuleEditorFlyout renders the select action component for a detector wit id="flyoutTitle" > diff --git a/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/scope_section.test.js.snap b/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/scope_section.test.js.snap index c2e96208f29b..976d1b288cad 100644 --- a/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/scope_section.test.js.snap +++ b/x-pack/plugins/ml/public/application/components/rule_editor/__snapshots__/scope_section.test.js.snap @@ -24,7 +24,7 @@ exports[`ScopeSection false canGetFilters privilege show NoPermissionCallOut whe indeterminate={false} label={ @@ -63,7 +63,7 @@ exports[`ScopeSection renders when enabled with no scope supplied 1`] = ` indeterminate={false} label={ @@ -116,7 +116,7 @@ exports[`ScopeSection renders when enabled with scope supplied 1`] = ` indeterminate={false} label={ @@ -169,7 +169,7 @@ exports[`ScopeSection renders when not enabled 1`] = ` indeterminate={false} label={ @@ -207,7 +207,7 @@ exports[`ScopeSection show NoFilterListsCallOut when no filter list IDs 1`] = ` indeterminate={false} label={ diff --git a/x-pack/plugins/ml/public/application/components/rule_editor/actions_section.js b/x-pack/plugins/ml/public/application/components/rule_editor/actions_section.js index 340f2369740e..1c6fa3fc7d05 100644 --- a/x-pack/plugins/ml/public/application/components/rule_editor/actions_section.js +++ b/x-pack/plugins/ml/public/application/components/rule_editor/actions_section.js @@ -31,7 +31,7 @@ export function ActionsSection({ actions, onSkipResultChange, onSkipModelUpdateC

diff --git a/x-pack/plugins/ml/public/application/components/rule_editor/rule_editor_flyout.js b/x-pack/plugins/ml/public/application/components/rule_editor/rule_editor_flyout.js index 42c5cdc611ff..78fdb2a0838c 100644 --- a/x-pack/plugins/ml/public/application/components/rule_editor/rule_editor_flyout.js +++ b/x-pack/plugins/ml/public/application/components/rule_editor/rule_editor_flyout.js @@ -105,7 +105,7 @@ class RuleEditorFlyoutUI extends Component { 'xpack.ml.ruleEditor.ruleEditorFlyout.unableToConfigureRulesNotificationMesssage', { defaultMessage: - 'Unable to configure rules as an error occurred obtaining details for job ID {jobId}', + 'Unable to configure job rules as an error occurred obtaining details for job ID {jobId}', values: { jobId: anomaly.jobId }, } ) @@ -159,7 +159,7 @@ class RuleEditorFlyoutUI extends Component { i18n.translate( 'xpack.ml.ruleEditor.ruleEditorFlyout.errorWithLoadingFilterListsNotificationMesssage', { - defaultMessage: 'Error loading the filter lists used in the rule scope', + defaultMessage: 'Error loading the filter lists used in the job rule scope', } ) ); @@ -510,7 +510,7 @@ class RuleEditorFlyoutUI extends Component {

@@ -555,7 +555,7 @@ class RuleEditorFlyoutUI extends Component { 'xpack.ml.ruleEditor.ruleEditorFlyout.conditionsDescription', { defaultMessage: - 'Add numeric conditions for when the rule applies. Multiple conditions are combined using AND.', + 'Add numeric conditions for when the job rule applies. Multiple conditions are combined using AND.', } ); @@ -571,12 +571,12 @@ class RuleEditorFlyoutUI extends Component { {isCreate === true ? ( ) : ( )} @@ -590,9 +590,9 @@ class RuleEditorFlyoutUI extends Component {

diff --git a/x-pack/plugins/ml/public/application/components/rule_editor/scope_section.js b/x-pack/plugins/ml/public/application/components/rule_editor/scope_section.js index fcf24be8af31..8f2c126a9511 100644 --- a/x-pack/plugins/ml/public/application/components/rule_editor/scope_section.js +++ b/x-pack/plugins/ml/public/application/components/rule_editor/scope_section.js @@ -45,7 +45,7 @@ function NoFilterListsCallOut() { @@ -134,7 +134,7 @@ export function ScopeSection({ label={ } checked={isEnabled} diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/evaluate_panel.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/evaluate_panel.tsx index 3795af32f663..f37be6f6f0eb 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/evaluate_panel.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/classification_exploration/evaluate_panel.tsx @@ -409,7 +409,7 @@ export const EvaluatePanel: FC = ({ jobConfig, jobStatus, se 'xpack.ml.dataframe.analytics.classificationExploration.evaluateSectionAvgRecallTooltip', { defaultMessage: - 'This value shows how many of the data points that are actual class members were identified correctly as class members.', + 'Mean recall shows how many of the data points that are actual class members were identified correctly as class members.', } )} /> diff --git a/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx b/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx index 4adb79f065cd..c108257094b6 100644 --- a/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx +++ b/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx @@ -361,7 +361,7 @@ export const SwimlaneContainer: FC = ({ diff --git a/x-pack/plugins/ml/server/models/data_recognizer/modules/security_network/manifest.json b/x-pack/plugins/ml/server/models/data_recognizer/modules/security_network/manifest.json index 55f07ab077d4..2a2c0c202f66 100755 --- a/x-pack/plugins/ml/server/models/data_recognizer/modules/security_network/manifest.json +++ b/x-pack/plugins/ml/server/models/data_recognizer/modules/security_network/manifest.json @@ -4,11 +4,7 @@ "description": "Detect anomalous network activity in your ECS-compatible network logs.", "type": "network data", "logoFile": "logo.json", - "defaultIndexPattern": [ - "logs-*", - "filebeat-*", - "packetbeat-*" - ], + "defaultIndexPattern": "logs-*,filebeat-*,packetbeat-*", "query": { "bool": { "filter": [ diff --git a/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap index 351b988ea5bc..fe277062bc95 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap @@ -15,6 +15,7 @@ exports[`NoData should show a default message if reason is unknown 1`] = ` >

- + - + = { upp: 'synthetics', tpt: 'apm', svl: 'apm', - kpi: 'rum', - pld: 'rum', - nwk: 'metrics', - mem: 'metrics', - logs: 'logs', - cpu: 'metrics', + kpi: 'ux', + pld: 'ux', + nwk: 'infra_metrics', + mem: 'infra_metrics', + logs: 'infra_logs', + cpu: 'infra_metrics', }; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.test.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.test.ts index 0de78c45041d..56c20289669f 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.test.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.test.ts @@ -6,12 +6,14 @@ */ import { LensAttributes } from './lens_attributes'; -import { mockIndexPattern } from '../rtl_helpers'; +import { mockAppIndexPattern, mockIndexPattern } from '../rtl_helpers'; import { getDefaultConfigs } from './default_configs'; import { sampleAttribute } from './test_data/sample_attribute'; import { LCP_FIELD, SERVICE_NAME, USER_AGENT_NAME } from './constants/elasticsearch_fieldnames'; describe('Lens Attribute', () => { + mockAppIndexPattern(); + const reportViewConfig = getDefaultConfigs({ reportType: 'pld', indexPattern: mockIndexPattern, @@ -53,7 +55,6 @@ describe('Lens Attribute', () => { readFromDocValues: true, }, fieldName: 'transaction.type', - columnType: null, }) ); }); @@ -72,7 +73,6 @@ describe('Lens Attribute', () => { readFromDocValues: true, }, fieldName: 'transaction.duration.us', - columnType: null, }) ); }); diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts index 12a5b19fb02f..01d74dc2ac36 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts @@ -45,6 +45,34 @@ function buildNumberColumn(sourceField: string) { }; } +export const parseCustomFieldName = ( + sourceField: string, + reportViewConfig: DataSeries, + selectedDefinitions: Record +) => { + let fieldName = sourceField; + let columnType; + + const rdf = reportViewConfig.reportDefinitions ?? []; + + const customField = rdf.find(({ field }) => field === fieldName); + + if (customField) { + if (selectedDefinitions[fieldName]) { + fieldName = selectedDefinitions[fieldName]; + if (customField?.options) + columnType = customField?.options?.find(({ field }) => field === fieldName)?.columnType; + } else if (customField.defaultValue) { + fieldName = customField.defaultValue; + } else if (customField.options?.[0].field) { + fieldName = customField.options?.[0].field; + columnType = customField.options?.[0].columnType; + } + } + + return { fieldName, columnType }; +}; + export class LensAttributes { indexPattern: IndexPattern; layers: Record; @@ -124,6 +152,18 @@ export class LensAttributes { }; } + getNumberColumn(sourceField: string, columnType?: string, operationType?: string) { + if (columnType === 'operation' || operationType) { + if (operationType === 'median' || operationType === 'average') { + return this.getNumberOperationColumn(sourceField, operationType); + } + if (operationType?.includes('th')) { + return this.getPercentileNumberColumn(sourceField, operationType); + } + } + return this.getNumberRangeColumn(sourceField); + } + getNumberOperationColumn( sourceField: string, operationType: 'average' | 'median' @@ -149,7 +189,7 @@ export class LensAttributes { ...buildNumberColumn(sourceField), label: i18n.translate('xpack.observability.expView.columns.label', { defaultMessage: '{percentileValue} percentile of {sourceField}', - values: { sourceField, percentileValue }, + values: { sourceField: this.reportViewConfig.labels[sourceField], percentileValue }, }), operationType: 'percentile', params: { percentile: Number(percentileValue.split('th')[0]) }, @@ -186,15 +226,7 @@ export class LensAttributes { return this.getDateHistogramColumn(fieldName); } if (fieldType === 'number') { - if (columnType === 'operation' || operationType) { - if (operationType === 'median' || operationType === 'average') { - return this.getNumberOperationColumn(fieldName, operationType); - } - if (operationType?.includes('th')) { - return this.getPercentileNumberColumn(sourceField, operationType); - } - } - return this.getNumberRangeColumn(fieldName); + return this.getNumberColumn(fieldName, columnType, operationType); } // FIXME review my approach again @@ -202,27 +234,7 @@ export class LensAttributes { } getCustomFieldName(sourceField: string) { - let fieldName = sourceField; - let columnType = null; - - const rdf = this.reportViewConfig.reportDefinitions ?? []; - - const customField = rdf.find(({ field }) => field === fieldName); - - if (customField) { - if (this.reportDefinitions[fieldName]) { - fieldName = this.reportDefinitions[fieldName]; - if (customField?.options) - columnType = customField?.options?.find(({ field }) => field === fieldName)?.columnType; - } else if (customField.defaultValue) { - fieldName = customField.defaultValue; - } else if (customField.options?.[0].field) { - fieldName = customField.options?.[0].field; - columnType = customField.options?.[0].columnType; - } - } - - return { fieldName, columnType }; + return parseCustomFieldName(sourceField, this.reportViewConfig, this.reportDefinitions); } getFieldMeta(sourceField: string) { diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/kpi_trends_config.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/kpi_trends_config.ts index cd38d912850c..6e8413b342ce 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/kpi_trends_config.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/kpi_trends_config.ts @@ -25,6 +25,7 @@ import { USER_AGENT_OS, USER_AGENT_VERSION, TRANSACTION_TIME_TO_FIRST_BYTE, + TRANSACTION_URL, } from '../constants/elasticsearch_fieldnames'; export function getKPITrendsLensConfig({ seriesId, indexPattern }: ConfigProps): DataSeries { @@ -42,6 +43,10 @@ export function getKPITrendsLensConfig({ seriesId, indexPattern }: ConfigProps): }, hasOperationType: false, defaultFilters: [ + { + field: TRANSACTION_URL, + isNegated: false, + }, USER_AGENT_OS, CLIENT_GEO_COUNTRY_NAME, USER_AGENT_DEVICE, diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/performance_dist_config.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/performance_dist_config.ts index 4b6d5dd6e741..847e7db18757 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/performance_dist_config.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/rum/performance_dist_config.ts @@ -21,6 +21,7 @@ import { TRANSACTION_DURATION, TRANSACTION_TIME_TO_FIRST_BYTE, TRANSACTION_TYPE, + TRANSACTION_URL, USER_AGENT_DEVICE, USER_AGENT_NAME, USER_AGENT_OS, @@ -42,6 +43,10 @@ export function getPerformanceDistLensConfig({ seriesId, indexPattern }: ConfigP }, hasOperationType: false, defaultFilters: [ + { + field: TRANSACTION_URL, + isNegated: false, + }, USER_AGENT_OS, CLIENT_GEO_COUNTRY_NAME, USER_AGENT_DEVICE, diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/synthetics/monitor_duration_config.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/synthetics/monitor_duration_config.ts index efbc3d14441c..3b55f5b8eabc 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/synthetics/monitor_duration_config.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/synthetics/monitor_duration_config.ts @@ -42,6 +42,6 @@ export function getMonitorDurationConfig({ seriesId }: Props): DataSeries { field: 'monitor.id', }, ], - labels: { ...FieldLabels }, + labels: { ...FieldLabels, 'monitor.duration.us': 'Monitor duration' }, }; } diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx index 257eb3a739f0..375c021bc9b5 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx @@ -7,12 +7,14 @@ import React from 'react'; import { fireEvent, screen, waitFor } from '@testing-library/dom'; -import { render, mockUrlStorage, mockCore } from './rtl_helpers'; +import { render, mockUrlStorage, mockCore, mockAppIndexPattern } from './rtl_helpers'; import { ExploratoryView } from './exploratory_view'; import { getStubIndexPattern } from '../../../../../../../src/plugins/data/public/test_utils'; import * as obsvInd from './utils/observability_index_patterns'; describe('ExploratoryView', () => { + mockAppIndexPattern(); + beforeEach(() => { const indexPattern = getStubIndexPattern( 'apm-*', diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx index 6bc069aafa5b..7b5dde852cf9 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx @@ -15,6 +15,8 @@ import { useUrlStorage } from './hooks/use_url_storage'; import { useLensAttributes } from './hooks/use_lens_attributes'; import { EmptyView } from './components/empty_view'; import { TypedLensByValueInput } from '../../../../../lens/public'; +import { useAppIndexPatternContext } from './hooks/use_app_index_pattern'; +import { ReportToDataTypeMap } from './configurations/constants'; export function ExploratoryView() { const { @@ -25,6 +27,8 @@ export function ExploratoryView() { null ); + const { loadIndexPattern } = useAppIndexPatternContext(); + const LensComponent = lens?.EmbeddableComponent; const { firstSeriesId: seriesId, firstSeries: series } = useUrlStorage(); @@ -33,13 +37,19 @@ export function ExploratoryView() { seriesId, }); + useEffect(() => { + if (series?.reportType || series?.dataType) { + loadIndexPattern({ dataType: series?.dataType ?? ReportToDataTypeMap[series?.reportType] }); + } + }, [series?.reportType, series?.dataType, loadIndexPattern]); + useEffect(() => { setLensAttributes(lensAttributesT); // eslint-disable-next-line react-hooks/exhaustive-deps }, [JSON.stringify(lensAttributesT ?? {}), series?.reportType, series?.time?.from]); return ( - + {lens ? ( <> diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx index de6912f256be..4c43c1152172 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx @@ -41,13 +41,16 @@ describe('ExploratoryViewHeader', function () { fireEvent.click(getByText('Open in Lens')); expect(core?.lens?.navigateToPrefilledEditor).toHaveBeenCalledTimes(1); - expect(core?.lens?.navigateToPrefilledEditor).toHaveBeenCalledWith({ - attributes: { title: 'Performance distribution' }, - id: '', - timeRange: { - from: 'now-15m', - to: 'now', + expect(core?.lens?.navigateToPrefilledEditor).toHaveBeenCalledWith( + { + attributes: { title: 'Performance distribution' }, + id: '', + timeRange: { + from: 'now-15m', + to: 'now', + }, }, - }); + true + ); }); }); diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx index 17f06436c853..af5657a56a99 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx @@ -45,11 +45,14 @@ export function ExploratoryViewHeader({ seriesId, lensAttributes }: Props) { isDisabled={!lens.canUseEditor() || lensAttributes === null} onClick={() => { if (lensAttributes) { - lens.navigateToPrefilledEditor({ - id: '', - timeRange: series.time, - attributes: lensAttributes, - }); + lens.navigateToPrefilledEditor( + { + id: '', + timeRange: series.time, + attributes: lensAttributes, + }, + true + ); } }} > diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_app_index_pattern.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_app_index_pattern.tsx new file mode 100644 index 000000000000..77d0d54ec5a7 --- /dev/null +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_app_index_pattern.tsx @@ -0,0 +1,115 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { createContext, useContext, Context, useState, useCallback, useMemo } from 'react'; +import { IndexPattern } from '../../../../../../../../src/plugins/data/common'; +import { AppDataType } from '../types'; +import { useKibana } from '../../../../../../../../src/plugins/kibana_react/public'; +import { ObservabilityPublicPluginsStart } from '../../../../plugin'; +import { ObservabilityIndexPatterns } from '../utils/observability_index_patterns'; +import { getDataHandler } from '../../../../data_handler'; +import { UXHasDataResponse } from '../../../../typings/fetch_overview_data'; + +export interface IIndexPatternContext { + loading: boolean; + selectedApp: AppDataType; + indexPatterns: IndexPatternState; + hasAppData: HasAppDataState; + loadIndexPattern: (params: { dataType: AppDataType }) => void; +} + +export const IndexPatternContext = createContext>({}); + +interface ProviderProps { + children: JSX.Element; +} + +type HasAppDataState = Record; +type IndexPatternState = Record; + +export function IndexPatternContextProvider({ children }: ProviderProps) { + const [loading, setLoading] = useState(false); + const [selectedApp, setSelectedApp] = useState(); + const [indexPatterns, setIndexPatterns] = useState({} as IndexPatternState); + const [hasAppData, setHasAppData] = useState({ + infra_metrics: null, + infra_logs: null, + synthetics: null, + ux: null, + apm: null, + } as HasAppDataState); + + const { + services: { data }, + } = useKibana(); + + const checkIfAppHasData = async (dataType: AppDataType) => { + const handler = getDataHandler(dataType === 'synthetics' ? 'uptime' : dataType); + return handler?.hasData(); + }; + + const loadIndexPattern: IIndexPatternContext['loadIndexPattern'] = useCallback( + async ({ dataType }) => { + setSelectedApp(dataType); + + if (hasAppData[dataType] === null) { + setLoading(true); + try { + let hasDataT = await checkIfAppHasData(dataType); + + if (dataType === 'ux') { + hasDataT = (hasDataT as UXHasDataResponse).hasData as boolean; + } + + setHasAppData((prevState) => ({ ...prevState, [dataType]: hasDataT })); + + if (hasDataT || hasAppData?.[dataType]) { + const obsvIndexP = new ObservabilityIndexPatterns(data); + const indPattern = await obsvIndexP.getIndexPattern(dataType); + + setIndexPatterns((prevState) => ({ ...prevState, [dataType]: indPattern })); + } + setLoading(false); + } catch (e) { + setLoading(false); + } + } + }, + [data, hasAppData] + ); + + return ( + + {children} + + ); +} + +export const useAppIndexPatternContext = () => { + const { selectedApp, loading, hasAppData, loadIndexPattern, indexPatterns } = useContext( + (IndexPatternContext as unknown) as Context + ); + + return useMemo(() => { + return { + hasAppData, + selectedApp, + loading, + indexPattern: indexPatterns?.[selectedApp], + hasData: hasAppData?.[selectedApp], + loadIndexPattern, + }; + }, [hasAppData, indexPatterns, loadIndexPattern, loading, selectedApp]); +}; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_default_index_pattern.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_default_index_pattern.tsx deleted file mode 100644 index c5a4d0249266..000000000000 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_default_index_pattern.tsx +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { createContext, useContext, Context, useState, useEffect } from 'react'; -import { IndexPattern } from '../../../../../../../../src/plugins/data/common'; -import { AppDataType } from '../types'; -import { useKibana } from '../../../../../../../../src/plugins/kibana_react/public'; -import { ObservabilityPublicPluginsStart } from '../../../../plugin'; -import { ObservabilityIndexPatterns } from '../utils/observability_index_patterns'; - -export interface IIndexPatternContext { - indexPattern: IndexPattern; - loadIndexPattern: (dataType: AppDataType) => void; -} - -export const IndexPatternContext = createContext>({}); - -interface ProviderProps { - indexPattern?: IndexPattern; - children: JSX.Element; -} - -export function IndexPatternContextProvider({ - children, - indexPattern: initialIndexPattern, -}: ProviderProps) { - const [indexPattern, setIndexPattern] = useState(initialIndexPattern); - - useEffect(() => { - setIndexPattern(initialIndexPattern); - }, [initialIndexPattern]); - - const { - services: { data }, - } = useKibana(); - - const loadIndexPattern = async (dataType: AppDataType) => { - setIndexPattern(undefined); - const obsvIndexP = new ObservabilityIndexPatterns(data); - const indPattern = await obsvIndexP.getIndexPattern(dataType); - setIndexPattern(indPattern!); - }; - - return ( - - {children} - - ); -} - -export const useIndexPatternContext = () => { - return useContext((IndexPatternContext as unknown) as Context); -}; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_init_exploratory_view.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_init_exploratory_view.ts deleted file mode 100644 index de4343b29011..000000000000 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_init_exploratory_view.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -import { useFetcher } from '../../../..'; -import { IKbnUrlStateStorage } from '../../../../../../../../src/plugins/kibana_utils/public'; -import { useKibana } from '../../../../../../../../src/plugins/kibana_react/public'; -import { ObservabilityPublicPluginsStart } from '../../../../plugin'; -import { AllShortSeries } from './use_url_storage'; -import { ReportToDataTypeMap } from '../configurations/constants'; -import { DataType, ObservabilityIndexPatterns } from '../utils/observability_index_patterns'; - -export const useInitExploratoryView = (storage: IKbnUrlStateStorage) => { - const { - services: { data }, - } = useKibana(); - - const allSeriesKey = 'sr'; - - const allSeries = storage.get(allSeriesKey) ?? {}; - - const allSeriesIds = Object.keys(allSeries); - - const firstSeriesId = allSeriesIds?.[0]; - - const firstSeries = allSeries[firstSeriesId]; - - let dataType: DataType = firstSeries?.dataType ?? 'rum'; - - if (firstSeries?.rt) { - dataType = ReportToDataTypeMap[firstSeries?.rt]; - } - - const { data: indexPattern, error } = useFetcher(() => { - const obsvIndexP = new ObservabilityIndexPatterns(data); - - return obsvIndexP.getIndexPattern(dataType); - }, [dataType, data]); - - if (error) { - throw error; - } - - return indexPattern; -}; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts index 555b21618c4b..a5fce74c4a2f 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts @@ -12,7 +12,7 @@ import { useUrlStorage } from './use_url_storage'; import { getDefaultConfigs } from '../configurations/default_configs'; import { DataSeries, SeriesUrl, UrlFilter } from '../types'; -import { useIndexPatternContext } from './use_default_index_pattern'; +import { useAppIndexPatternContext } from './use_app_index_pattern'; interface Props { seriesId: string; @@ -43,7 +43,7 @@ export const useLensAttributes = ({ const { breakdown, seriesType, operationType, reportType, reportDefinitions = {} } = series ?? {}; - const { indexPattern } = useIndexPatternContext(); + const { indexPattern } = useAppIndexPatternContext(); return useMemo(() => { if (!indexPattern || !reportType) { diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx index a4fe15025245..139b7faac4a3 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx @@ -56,7 +56,7 @@ interface ShortUrlSeries { export type AllShortSeries = Record; export type AllSeries = Record; -export const NEW_SERIES_KEY = 'newSeriesKey'; +export const NEW_SERIES_KEY = 'new-series-key'; export function useUrlStorage(seriesId?: string) { const allSeriesKey = 'sr'; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx index f903c4d7d44f..9fe133098549 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx @@ -13,13 +13,12 @@ import { ExploratoryView } from './exploratory_view'; import { useKibana } from '../../../../../../../src/plugins/kibana_react/public'; import { ObservabilityPublicPluginsStart } from '../../../plugin'; import { useBreadcrumbs } from '../../../hooks/use_breadcrumbs'; -import { IndexPatternContextProvider } from './hooks/use_default_index_pattern'; +import { IndexPatternContextProvider } from './hooks/use_app_index_pattern'; import { createKbnUrlStateStorage, withNotifyOnErrors, } from '../../../../../../../src/plugins/kibana_utils/public/'; import { UrlStorageContextProvider } from './hooks/use_url_storage'; -import { useInitExploratoryView } from './hooks/use_init_exploratory_view'; import { WithHeaderLayout } from '../../app/layout/with_header'; export function ExploratoryViewPage() { @@ -45,20 +44,16 @@ export function ExploratoryViewPage() { ...withNotifyOnErrors(notifications!.toasts), }); - const indexPattern = useInitExploratoryView(kbnUrlStateStorage); - return ( - {indexPattern ? ( - - - - - - ) : null} + + + + + ); } diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx index b826409dd9e3..7763e8ad7122 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx @@ -22,7 +22,7 @@ import { import { ObservabilityPublicPluginsStart } from '../../../plugin'; import { EuiThemeProvider } from '../../../../../../../src/plugins/kibana_react/common'; import { lensPluginMock } from '../../../../../lens/public/mocks'; -import { IndexPatternContextProvider } from './hooks/use_default_index_pattern'; +import { IndexPatternContextProvider } from './hooks/use_app_index_pattern'; import { AllSeries, UrlStorageContextProvider } from './hooks/use_url_storage'; import { withNotifyOnErrors, @@ -33,6 +33,7 @@ import * as useUrlHook from './hooks/use_url_storage'; import * as useSeriesFilterHook from './hooks/use_series_filters'; import * as useHasDataHook from '../../../hooks/use_has_data'; import * as useValuesListHook from '../../../hooks/use_values_list'; +import * as useAppIndexPatternHook from './hooks/use_app_index_pattern'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths import { getStubIndexPattern } from '../../../../../../../src/plugins/data/public/index_patterns/index_pattern.stub'; @@ -148,7 +149,7 @@ export function MockKibanaProvider>({ - + {children} @@ -234,6 +235,19 @@ export const mockUseHasData = () => { return { spy, onRefreshTimeRange }; }; +export const mockAppIndexPattern = () => { + const loadIndexPattern = jest.fn(); + const spy = jest.spyOn(useAppIndexPatternHook, 'useAppIndexPatternContext').mockReturnValue({ + indexPattern: mockIndexPattern, + selectedApp: 'ux', + hasData: true, + loading: false, + hasAppData: { ux: true } as any, + loadIndexPattern, + }); + return { spy, loadIndexPattern }; +}; + export const mockUseValuesList = (values?: string[]) => { const onRefreshTimeRange = jest.fn(); const spy = jest.spyOn(useValuesListHook, 'useValuesList').mockReturnValue({ diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx index 029c39df13aa..df5b57124f0e 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx @@ -66,7 +66,7 @@ export function XYChartTypesSelect({ const { data = [], loading } = useFetcher(() => lens.getXyVisTypes(), [lens]); - let vizTypes = data ?? []; + let vizTypes = data; if ((excludeChartTypes ?? []).length > 0) { vizTypes = vizTypes.filter(({ id }) => !excludeChartTypes?.includes(id as SeriesType)); @@ -95,6 +95,7 @@ export function XYChartTypesSelect({ return ( ); @@ -28,11 +30,11 @@ describe('DataTypesCol', function () { fireEvent.click(screen.getByText(/user experience\(rum\)/i)); expect(setSeries).toHaveBeenCalledTimes(1); - expect(setSeries).toHaveBeenCalledWith('newSeriesKey', { dataType: 'rum' }); + expect(setSeries).toHaveBeenCalledWith(NEW_SERIES_KEY, { dataType: 'ux' }); }); it('should set series on change on already selected', function () { - const { removeSeries } = mockUrlStorage({ + mockUrlStorage({ data: { [NEW_SERIES_KEY]: { dataType: 'synthetics', @@ -50,10 +52,5 @@ describe('DataTypesCol', function () { }); expect(button.classList).toContain('euiButton--fill'); - - fireEvent.click(button); - - // undefined on click selected - expect(removeSeries).toHaveBeenCalledWith('newSeriesKey'); }); }); diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx index d7e90d34a259..79008d91b294 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx @@ -7,27 +7,25 @@ import React from 'react'; import { EuiButton, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; +import styled from 'styled-components'; import { AppDataType } from '../../types'; -import { useIndexPatternContext } from '../../hooks/use_default_index_pattern'; +import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern'; import { NEW_SERIES_KEY, useUrlStorage } from '../../hooks/use_url_storage'; export const dataTypes: Array<{ id: AppDataType; label: string }> = [ { id: 'synthetics', label: 'Synthetic Monitoring' }, - { id: 'rum', label: 'User Experience(RUM)' }, - { id: 'logs', label: 'Logs' }, - { id: 'metrics', label: 'Metrics' }, - { id: 'apm', label: 'APM' }, + { id: 'ux', label: 'User Experience(RUM)' }, + // { id: 'infra_logs', label: 'Logs' }, + // { id: 'infra_metrics', label: 'Metrics' }, + // { id: 'apm', label: 'APM' }, ]; export function DataTypesCol() { const { series, setSeries, removeSeries } = useUrlStorage(NEW_SERIES_KEY); - const { loadIndexPattern, indexPattern } = useIndexPatternContext(); + const { loading } = useAppIndexPatternContext(); const onDataTypeChange = (dataType?: AppDataType) => { - if (dataType) { - loadIndexPattern(dataType); - } if (!dataType) { removeSeries(NEW_SERIES_KEY); } else { @@ -38,7 +36,7 @@ export function DataTypesCol() { const selectedDataType = series.dataType; return ( - + {dataTypes.map(({ id: dataTypeId, label }) => ( { - onDataTypeChange(dataTypeId === selectedDataType ? undefined : dataTypeId); + onDataTypeChange(dataTypeId); }} > {label} ))} - + ); } + +const FlexGroup = styled(EuiFlexGroup)` + width: 100%; +`; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/date_picker_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/date_picker_col.tsx new file mode 100644 index 000000000000..a245d39cee08 --- /dev/null +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/date_picker_col.tsx @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { SeriesDatePicker } from '../../series_date_picker'; + +interface Props { + seriesId: string; +} +export function DatePickerCol({ seriesId }: Props) { + return ( +
+ +
+ ); +} diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx index 46167af0b244..b33671f78bfe 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx @@ -29,7 +29,9 @@ export function OperationTypeSelect({ useEffect(() => { setSeries(seriesId, { ...series, operationType: operationType || defaultOperationType }); - }, [defaultOperationType, seriesId, operationType, setSeries, series]); + // We only want to call this when defaultOperationType changes + // eslint-disable-next-line react-hooks/exhaustive-deps + }, [defaultOperationType]); const options = [ { @@ -72,6 +74,7 @@ export function OperationTypeSelect({ return ( ) { + const { reportDefinitions } = dataView; + const customColumn = reportDefinitions.find((item) => item.custom); + if (customColumn?.field && selectedDefinition[customColumn?.field]) { + const { columnType } = parseCustomFieldName(customColumn.field, dataView, selectedDefinition); + + return columnType; + } + return null; +} + +const MaxWidthStyle = { maxWidth: 250 }; export function ReportDefinitionCol({ dataViewSeries }: { dataViewSeries: DataSeries }) { - const { indexPattern } = useIndexPatternContext(); + const { indexPattern } = useAppIndexPatternContext(); const { series, setSeries } = useUrlStorage(NEW_SERIES_KEY); @@ -54,14 +70,19 @@ export function ReportDefinitionCol({ dataViewSeries }: { dataViewSeries: DataSe }); }; + const columnType = getColumnType(dataViewSeries, rtd); + return ( - + + + + {indexPattern && reportDefinitions.map(({ field, custom, options, defaultValue }) => ( {!custom ? ( - - + + onChange(field, val)} filters={(filters ?? []).map(({ query }) => query)} time={series.time} - width={200} + fullWidth={true} /> {rtd?.[field] && ( @@ -100,17 +121,21 @@ export function ReportDefinitionCol({ dataViewSeries }: { dataViewSeries: DataSe )} ))} - - - - {hasOperationType && ( - + {(hasOperationType || columnType === 'operation') && ( + )} - + + + + ); } + +const FlexGroup = styled(EuiFlexGroup)` + width: 100%; +`; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx index f845bf9885af..c5b8f1147af5 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx @@ -7,14 +7,17 @@ import React from 'react'; import { fireEvent, screen } from '@testing-library/react'; -import { mockUrlStorage, render } from '../../rtl_helpers'; +import { mockAppIndexPattern, mockUrlStorage, render } from '../../rtl_helpers'; import { ReportTypesCol, SELECTED_DATA_TYPE_FOR_REPORT } from './report_types_col'; import { ReportTypes } from '../series_builder'; import { DEFAULT_TIME } from '../../configurations/constants'; +import { NEW_SERIES_KEY } from '../../hooks/use_url_storage'; describe('ReportTypesCol', function () { + mockAppIndexPattern(); + it('should render properly', function () { - render(); + render(); screen.getByText('Performance distribution'); screen.getByText('KPI over time'); }); @@ -30,7 +33,7 @@ describe('ReportTypesCol', function () { fireEvent.click(screen.getByText(/monitor duration/i)); - expect(setSeries).toHaveBeenCalledWith('newSeriesKey', { + expect(setSeries).toHaveBeenCalledWith(NEW_SERIES_KEY, { breakdown: 'user_agent.name', reportDefinitions: {}, reportType: 'upd', @@ -42,7 +45,7 @@ describe('ReportTypesCol', function () { it('should set selected as filled', function () { const { setSeries } = mockUrlStorage({ data: { - newSeriesKey: { + [NEW_SERIES_KEY]: { dataType: 'synthetics', reportType: 'upp', breakdown: 'monitor.status', @@ -61,7 +64,7 @@ describe('ReportTypesCol', function () { fireEvent.click(button); // undefined on click selected - expect(setSeries).toHaveBeenCalledWith('newSeriesKey', { + expect(setSeries).toHaveBeenCalledWith(NEW_SERIES_KEY, { dataType: 'synthetics', time: DEFAULT_TIME, }); diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx index a8f98b98026b..b8ab1c80009d 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx @@ -7,11 +7,13 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n/react'; import { EuiButton, EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui'; +import styled from 'styled-components'; import { ReportViewTypeId, SeriesUrl } from '../../types'; import { NEW_SERIES_KEY, useUrlStorage } from '../../hooks/use_url_storage'; import { DEFAULT_TIME } from '../../configurations/constants'; -import { useIndexPatternContext } from '../../hooks/use_default_index_pattern'; +import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern'; interface Props { reportTypes: Array<{ id: ReportViewTypeId; label: string }>; @@ -23,19 +25,29 @@ export function ReportTypesCol({ reportTypes }: Props) { setSeries, } = useUrlStorage(NEW_SERIES_KEY); - const { indexPattern } = useIndexPatternContext(); + const { loading, hasData, selectedApp } = useAppIndexPatternContext(); + + if (!loading && !hasData && selectedApp) { + return ( + + ); + } return reportTypes?.length > 0 ? ( - + {reportTypes.map(({ id: reportType, label }) => ( { if (reportType === selectedReportType) { setSeries(NEW_SERIES_KEY, { @@ -56,7 +68,7 @@ export function ReportTypesCol({ reportTypes }: Props) { ))} - + ) : ( {SELECTED_DATA_TYPE_FOR_REPORT} ); @@ -66,3 +78,7 @@ export const SELECTED_DATA_TYPE_FOR_REPORT = i18n.translate( 'xpack.observability.expView.reportType.noDataType', { defaultMessage: 'Select a data type to start building a series.' } ); + +const FlexGroup = styled(EuiFlexGroup)` + width: 100%; +`; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx index 4d5033eca241..b630ee55b578 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx @@ -28,18 +28,18 @@ export function CustomReportField({ field, seriesId, options: opts, defaultValue const { reportDefinitions } = series; - const NO_SELECT = 'no_select'; - - const options = [{ label: 'Select metric', field: NO_SELECT }, ...(opts ?? [])]; + const options = opts ?? []; return ( -
+
({ value: fd, inputDisplay: label, }))} - valueOfSelected={reportDefinitions?.[field] || defaultValue || NO_SELECT} + valueOfSelected={reportDefinitions?.[field] || defaultValue || options?.[0].field} onChange={(value) => onChange(value)} />
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx index 2280109fdacd..5831b8be04c3 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx @@ -5,11 +5,10 @@ * 2.0. */ -import React, { useState } from 'react'; +import React, { useEffect, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiButton, EuiBasicTable, EuiSpacer, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; -import styled from 'styled-components'; import { AppDataType, ReportViewTypeId, ReportViewTypes, SeriesUrl } from '../types'; import { DataTypesCol } from './columns/data_types_col'; import { ReportTypesCol } from './columns/report_types_col'; @@ -17,7 +16,7 @@ import { ReportDefinitionCol } from './columns/report_definition_col'; import { ReportFilters } from './columns/report_filters'; import { ReportBreakdowns } from './columns/report_breakdowns'; import { NEW_SERIES_KEY, useUrlStorage } from '../hooks/use_url_storage'; -import { useIndexPatternContext } from '../hooks/use_default_index_pattern'; +import { useAppIndexPatternContext } from '../hooks/use_app_index_pattern'; import { getDefaultConfigs } from '../configurations/default_configs'; export const ReportTypes: Record> = { @@ -25,7 +24,7 @@ export const ReportTypes: Record { return getDefaultConfigs({ @@ -70,19 +71,23 @@ export function SeriesBuilder() { }); }; + useEffect(() => { + setIsFlyoutVisible(!!series.dataType); + }, [series.dataType]); + const columns = [ { name: i18n.translate('xpack.observability.expView.seriesBuilder.dataType', { defaultMessage: 'Data Type', }), - width: '20%', + width: '15%', render: (val: string) => , }, { name: i18n.translate('xpack.observability.expView.seriesBuilder.report', { defaultMessage: 'Report', }), - width: '20%', + width: '15%', render: (val: string) => ( ), @@ -92,16 +97,25 @@ export function SeriesBuilder() { defaultMessage: 'Definition', }), width: '30%', - render: (val: string) => - reportType && indexPattern ? ( - - ) : null, + render: (val: string) => { + if (dataType && hasData) { + return loading ? ( + INITIATING_VIEW + ) : reportType ? ( + + ) : ( + SELECT_REPORT_TYPE + ); + } + + return null; + }, }, { name: i18n.translate('xpack.observability.expView.seriesBuilder.filters', { defaultMessage: 'Filters', }), - width: '25%', + width: '20%', render: (val: string) => reportType && indexPattern ? : null, }, @@ -109,7 +123,7 @@ export function SeriesBuilder() { name: i18n.translate('xpack.observability.expView.seriesBuilder.breakdown', { defaultMessage: 'Breakdowns', }), - width: '25%', + width: '20%', field: 'id', render: (val: string) => reportType && indexPattern ? ( @@ -126,14 +140,15 @@ export function SeriesBuilder() { ReportViewTypes[reportType] }`; - const newSeriesN = { + const newSeriesN: SeriesUrl = { + time, + filters, + breakdown, reportType, seriesType, - filters, - reportDefinitions, operationType, - time: { from: 'now-30m', to: 'now' }, - } as SeriesUrl; + reportDefinitions, + }; setSeries(newSeriesId, newSeriesN).then(() => { removeSeries(NEW_SERIES_KEY); @@ -148,7 +163,7 @@ export function SeriesBuilder() { if (isFlyoutVisible) { flyout = ( - + <> - + {i18n.translate('xpack.observability.expView.seriesBuilder.add', { defaultMessage: 'Add', })} @@ -165,6 +187,7 @@ export function SeriesBuilder() { { @@ -178,7 +201,7 @@ export function SeriesBuilder() { - + ); } @@ -205,6 +228,13 @@ export function SeriesBuilder() { ); } -const BottomFlyout = styled.div` - height: 300px; -`; +const INITIATING_VIEW = i18n.translate('xpack.observability.expView.seriesBuilder.initView', { + defaultMessage: 'Initiating view ...', +}); + +const SELECT_REPORT_TYPE = i18n.translate( + 'xpack.observability.expView.seriesBuilder.selectReportType', + { + defaultMessage: 'Select a report type to define visualization.', + } +); diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/actions_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/chart_options.tsx similarity index 95% rename from x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/actions_col.tsx rename to x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/chart_options.tsx index fe54262e1384..975817a8417d 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/actions_col.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/chart_options.tsx @@ -15,7 +15,7 @@ interface Props { series: DataSeries; } -export function ActionsCol({ series }: Props) { +export function ChartOptions({ series }: Props) { return ( diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx index 3e6d7890f4c8..5f5c99ca796c 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx @@ -13,7 +13,8 @@ import { EuiLoadingSpinner, EuiFilterGroup, } from '@elastic/eui'; -import { useIndexPatternContext } from '../../hooks/use_default_index_pattern'; +import styled from 'styled-components'; +import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern'; import { useUrlStorage } from '../../hooks/use_url_storage'; import { UrlFilter } from '../../types'; import { FilterValueButton } from './filter_value_btn'; @@ -23,12 +24,13 @@ interface Props { seriesId: string; label: string; field: string; + isNegated?: boolean; goBack: () => void; nestedField?: string; } -export function FilterExpanded({ seriesId, field, label, goBack, nestedField }: Props) { - const { indexPattern } = useIndexPatternContext(); +export function FilterExpanded({ seriesId, field, label, goBack, nestedField, isNegated }: Props) { + const { indexPattern } = useAppIndexPatternContext(); const [value, setValue] = useState(''); @@ -37,9 +39,10 @@ export function FilterExpanded({ seriesId, field, label, goBack, nestedField }: const { series } = useUrlStorage(seriesId); const { values, loading } = useValuesList({ + query: value, + indexPattern, sourceField: field, time: series.time, - indexPattern, }); const filters = series?.filters ?? []; @@ -51,7 +54,7 @@ export function FilterExpanded({ seriesId, field, label, goBack, nestedField }: ); return ( - <> + goBack()}> {label} @@ -71,16 +74,18 @@ export function FilterExpanded({ seriesId, field, label, goBack, nestedField }: {displayValues.map((opt) => ( - + {isNegated !== false && ( + + )} ))} - + ); } + +const Wrapper = styled.div` + max-width: 400px; +`; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx index efccb351c261..849fb8ffa66b 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx @@ -7,7 +7,7 @@ import { i18n } from '@kbn/i18n'; import React, { useMemo } from 'react'; import { EuiFilterButton, hexToRgb } from '@elastic/eui'; -import { useIndexPatternContext } from '../../hooks/use_default_index_pattern'; +import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern'; import { useUrlStorage } from '../../hooks/use_url_storage'; import { useSeriesFilters } from '../../hooks/use_series_filters'; import { euiStyled } from '../../../../../../../../../src/plugins/kibana_react/common'; @@ -39,7 +39,7 @@ export function FilterValueButton({ }: Props) { const { series } = useUrlStorage(seriesId); - const { indexPattern } = useIndexPatternContext(); + const { indexPattern } = useAppIndexPatternContext(); const { setFilter, removeFilter } = useSeriesFilters({ seriesId }); diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx index aaaa02c7c569..ba2cdc545fbe 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx @@ -8,18 +8,17 @@ import { i18n } from '@kbn/i18n'; import React from 'react'; import { EuiButtonIcon } from '@elastic/eui'; -import { DataSeries } from '../../types'; import { useUrlStorage } from '../../hooks/use_url_storage'; interface Props { - series: DataSeries; + seriesId: string; } -export function RemoveSeries({ series }: Props) { +export function RemoveSeries({ seriesId }: Props) { const { removeSeries } = useUrlStorage(); const onClick = () => { - removeSeries(series.id); + removeSeries(seriesId); }; return ( { + removeSeries(seriesId); + setSeries(NEW_SERIES_KEY, { ...series, dataType: ReportToDataTypeMap[series.reportType] }); + }; + + return ( + + + + + + + + + ); +} diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx index c9bb44cfd8cc..88cb53826341 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx @@ -32,6 +32,7 @@ export interface Field { label: string; field: string; nested?: string; + isNegated?: boolean; } export function SeriesFilter({ series, isNew, seriesId, defaultFilters = [] }: Props) { @@ -39,11 +40,17 @@ export function SeriesFilter({ series, isNew, seriesId, defaultFilters = [] }: P const [selectedField, setSelectedField] = useState(); - const options = defaultFilters.map((field) => { + const options: Field[] = defaultFilters.map((field) => { if (typeof field === 'string') { return { label: FieldLabels[field], field }; } - return { label: FieldLabels[field.field], field: field.field, nested: field.nested }; + + return { + label: FieldLabels[field.field], + field: field.field, + nested: field.nested, + isNegated: field.isNegated, + }; }); const disabled = seriesId === NEW_SERIES_KEY && !isNew; @@ -92,6 +99,7 @@ export function SeriesFilter({ series, isNew, seriesId, defaultFilters = [] }: P field={selectedField.field} label={selectedField.label} nestedField={selectedField.nested} + isNegated={selectedField.isNegated} goBack={() => { setSelectedField(undefined); }} diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.test.tsx index a38b50d610c7..30844a3f78a7 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.test.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.test.tsx @@ -7,13 +7,15 @@ import React from 'react'; import { screen, waitFor } from '@testing-library/react'; -import { mockIndexPattern, mockUrlStorage, render } from '../rtl_helpers'; +import { mockAppIndexPattern, mockIndexPattern, mockUrlStorage, render } from '../rtl_helpers'; import { SelectedFilters } from './selected_filters'; import { getDefaultConfigs } from '../configurations/default_configs'; import { NEW_SERIES_KEY } from '../hooks/use_url_storage'; import { USER_AGENT_NAME } from '../configurations/constants/elasticsearch_fieldnames'; describe('SelectedFilters', function () { + mockAppIndexPattern(); + const dataViewSeries = getDefaultConfigs({ reportType: 'pld', indexPattern: mockIndexPattern, diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx index 34e69f688eaa..4055a592c75d 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx @@ -10,7 +10,7 @@ import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import { NEW_SERIES_KEY, useUrlStorage } from '../hooks/use_url_storage'; import { FilterLabel } from '../components/filter_label'; import { DataSeries, UrlFilter } from '../types'; -import { useIndexPatternContext } from '../hooks/use_default_index_pattern'; +import { useAppIndexPatternContext } from '../hooks/use_app_index_pattern'; import { useSeriesFilters } from '../hooks/use_series_filters'; import { getFiltersFromDefs } from '../hooks/use_lens_attributes'; @@ -37,7 +37,7 @@ export function SelectedFilters({ seriesId, isNew, series: dataSeries }: Props) const { removeFilter } = useSeriesFilters({ seriesId }); - const { indexPattern } = useIndexPatternContext(); + const { indexPattern } = useAppIndexPatternContext(); return (filters.length > 0 || definitionFilters.length > 0) && indexPattern ? ( @@ -45,7 +45,7 @@ export function SelectedFilters({ seriesId, isNew, series: dataSeries }: Props) {filters.map(({ field, values, notValues }) => ( {(values ?? []).map((val) => ( - + ))} {(notValues ?? []).map((val) => ( - + ( {' '} - {val === NEW_SERIES_KEY ? 'new-series-preview' : val} + {val === NEW_SERIES_KEY ? 'series-preview' : val} ), }, @@ -63,34 +64,30 @@ export function SeriesEditor() { align: 'center' as const, width: '15%', field: 'id', - render: (val: string, item: DataSeries) => , + render: (val: string, item: DataSeries) => , + }, + { + name: ( +
+ +
+ ), + width: '20%', + field: 'id', + align: 'right' as const, + render: (val: string, item: DataSeries) => , }, - ] - : []), - { - name: ( -
- {i18n.translate('xpack.observability.expView.seriesEditor.time', { - defaultMessage: 'Time', - })} -
- ), - width: '20%', - field: 'id', - align: 'right' as const, - render: (val: string, item: DataSeries) => , - }, - - ...(firstSeriesId !== NEW_SERIES_KEY - ? [ { name: i18n.translate('xpack.observability.expView.seriesEditor.actions', { defaultMessage: 'Actions', }), align: 'center' as const, - width: '5%', + width: '8%', field: 'id', - render: (val: string, item: DataSeries) => , + render: (val: string, item: DataSeries) => , }, ] : []), @@ -100,7 +97,7 @@ export function SeriesEditor() { const items: DataSeries[] = []; - const { indexPattern } = useIndexPatternContext(); + const { indexPattern } = useAppIndexPatternContext(); allSeriesKeys.forEach((seriesKey) => { const series = allSeries[seriesKey]; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts index 141dcecd0ba5..bd908661365c 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts @@ -57,7 +57,7 @@ export interface DataSeries { breakdowns: string[]; defaultSeriesType: SeriesType; - defaultFilters: Array; + defaultFilters: Array; seriesTypes: SeriesType[]; filters?: PersistableFilter[]; reportDefinitions: ReportDefinition[]; @@ -91,7 +91,7 @@ export interface ConfigProps { indexPattern: IIndexPattern; } -export type AppDataType = 'synthetics' | 'rum' | 'logs' | 'metrics' | 'apm'; +export type AppDataType = 'synthetics' | 'ux' | 'infra_logs' | 'infra_metrics' | 'apm'; type FormatType = 'duration' | 'number'; type InputFormat = 'microseconds' | 'milliseconds' | 'seconds'; diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts index b6f544db2a31..f1347e1d21cc 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts @@ -40,17 +40,17 @@ const fieldFormats = { describe('ObservabilityIndexPatterns', function () { const { data } = mockCore(); data!.indexPatterns.get = jest.fn().mockReturnValue({ title: 'index-*' }); - data!.indexPatterns.createAndSave = jest.fn().mockReturnValue({ id: indexPatternList.rum }); + data!.indexPatterns.createAndSave = jest.fn().mockReturnValue({ id: indexPatternList.ux }); data!.indexPatterns.updateSavedObject = jest.fn(); it('should return index pattern for app', async function () { const obsv = new ObservabilityIndexPatterns(data!); - const indexP = await obsv.getIndexPattern('rum'); + const indexP = await obsv.getIndexPattern('ux'); expect(indexP).toEqual({ title: 'index-*' }); - expect(data?.indexPatterns.get).toHaveBeenCalledWith(indexPatternList.rum); + expect(data?.indexPatterns.get).toHaveBeenCalledWith(indexPatternList.ux); expect(data?.indexPatterns.get).toHaveBeenCalledTimes(1); }); @@ -61,9 +61,9 @@ describe('ObservabilityIndexPatterns', function () { const obsv = new ObservabilityIndexPatterns(data!); - const indexP = await obsv.getIndexPattern('rum'); + const indexP = await obsv.getIndexPattern('ux'); - expect(indexP).toEqual({ id: indexPatternList.rum }); + expect(indexP).toEqual({ id: indexPatternList.ux }); expect(data?.indexPatterns.createAndSave).toHaveBeenCalledWith({ fieldFormats, @@ -77,7 +77,7 @@ describe('ObservabilityIndexPatterns', function () { it('should return getFieldFormats', function () { const obsv = new ObservabilityIndexPatterns(data!); - expect(obsv.getFieldFormats('rum')).toEqual(fieldFormats); + expect(obsv.getFieldFormats('ux')).toEqual(fieldFormats); }); it('should validate field formats', async function () { @@ -85,7 +85,7 @@ describe('ObservabilityIndexPatterns', function () { const obsv = new ObservabilityIndexPatterns(data!); - await obsv.validateFieldFormats('rum', mockIndexPattern); + await obsv.validateFieldFormats('ux', mockIndexPattern); expect(data?.indexPatterns.updateSavedObject).toHaveBeenCalledTimes(1); expect(data?.indexPatterns.updateSavedObject).toHaveBeenCalledWith( diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts index 527ef48364d2..b890df69d993 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts @@ -14,36 +14,35 @@ import { } from '../../../../../../../../src/plugins/data/public'; import { rumFieldFormats } from '../configurations/rum/field_formats'; import { syntheticsFieldFormats } from '../configurations/synthetics/field_formats'; -import { FieldFormat, FieldFormatParams } from '../types'; - -const appFieldFormats: Record = { - rum: rumFieldFormats, - apm: null, - logs: null, - metrics: null, +import { AppDataType, FieldFormat, FieldFormatParams } from '../types'; +import { apmFieldFormats } from '../configurations/apm/field_formats'; + +const appFieldFormats: Record = { + infra_logs: null, + infra_metrics: null, + ux: rumFieldFormats, + apm: apmFieldFormats, synthetics: syntheticsFieldFormats, }; -function getFieldFormatsForApp(app: DataType) { +function getFieldFormatsForApp(app: AppDataType) { return appFieldFormats[app]; } -export type DataType = 'synthetics' | 'apm' | 'logs' | 'metrics' | 'rum'; - -export const indexPatternList: Record = { +export const indexPatternList: Record = { synthetics: 'synthetics_static_index_pattern_id', apm: 'apm_static_index_pattern_id', - rum: 'rum_static_index_pattern_id', - logs: 'logs_static_index_pattern_id', - metrics: 'metrics_static_index_pattern_id', + ux: 'rum_static_index_pattern_id', + infra_logs: 'infra_logs_static_index_pattern_id', + infra_metrics: 'infra_metrics_static_index_pattern_id', }; -const appToPatternMap: Record = { +const appToPatternMap: Record = { synthetics: '(synthetics-data-view)*,heartbeat-*,synthetics-*', apm: 'apm-*', - rum: '(rum-data-view)*,apm-*', - logs: 'logs-*,filebeat-*', - metrics: 'metrics-*,metricbeat-*', + ux: '(rum-data-view)*,apm-*', + infra_logs: 'logs-*,filebeat-*', + infra_metrics: 'metrics-*,metricbeat-*', }; export function isParamsSame(param1: IFieldFormat['_params'], param2: FieldFormatParams) { @@ -66,7 +65,7 @@ export class ObservabilityIndexPatterns { this.data = data; } - async createIndexPattern(app: DataType) { + async createIndexPattern(app: AppDataType) { if (!this.data) { throw new Error('data is not defined'); } @@ -81,7 +80,7 @@ export class ObservabilityIndexPatterns { }); } // we want to make sure field formats remain same - async validateFieldFormats(app: DataType, indexPattern: IndexPattern) { + async validateFieldFormats(app: AppDataType, indexPattern: IndexPattern) { const defaultFieldFormats = getFieldFormatsForApp(app); if (defaultFieldFormats && defaultFieldFormats.length > 0) { let isParamsDifferent = false; @@ -99,7 +98,7 @@ export class ObservabilityIndexPatterns { } } - getFieldFormats(app: DataType) { + getFieldFormats(app: AppDataType) { const fieldFormatMap: IndexPatternSpec['fieldFormats'] = {}; (appFieldFormats?.[app] ?? []).forEach(({ field, format }) => { @@ -109,7 +108,7 @@ export class ObservabilityIndexPatterns { return fieldFormatMap; } - async getIndexPattern(app: DataType): Promise { + async getIndexPattern(app: AppDataType): Promise { if (!this.data) { throw new Error('data is not defined'); } diff --git a/x-pack/plugins/observability/public/components/shared/field_value_suggestions/__stories__/field_value_selection.stories.tsx b/x-pack/plugins/observability/public/components/shared/field_value_suggestions/__stories__/field_value_selection.stories.tsx index 8e95d8e711ad..ae91e1a43918 100644 --- a/x-pack/plugins/observability/public/components/shared/field_value_suggestions/__stories__/field_value_selection.stories.tsx +++ b/x-pack/plugins/observability/public/components/shared/field_value_suggestions/__stories__/field_value_selection.stories.tsx @@ -12,7 +12,8 @@ import { CoreStart } from 'src/core/public'; import { text } from '@storybook/addon-knobs'; import { EuiThemeProvider } from '../../../../../../../../src/plugins/kibana_react/common'; import { createKibanaReactContext } from '../../../../../../../../src/plugins/kibana_react/public'; -import { FieldValueSelection, FieldValueSelectionProps } from '../field_value_selection'; +import { FieldValueSelectionProps } from '../types'; +import { FieldValueSelection } from '../field_value_selection'; const KibanaReactContext = createKibanaReactContext(({ uiSettings: { get: () => {}, get$: () => new Observable() }, diff --git a/x-pack/plugins/observability/public/components/shared/field_value_suggestions/field_value_selection.tsx b/x-pack/plugins/observability/public/components/shared/field_value_suggestions/field_value_selection.tsx index d14039ba173a..d7e075d7fc3f 100644 --- a/x-pack/plugins/observability/public/components/shared/field_value_suggestions/field_value_selection.tsx +++ b/x-pack/plugins/observability/public/components/shared/field_value_suggestions/field_value_selection.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { FormEvent, Fragment, useEffect, useState, Dispatch, SetStateAction } from 'react'; +import React, { FormEvent, useEffect, useState } from 'react'; import { EuiButton, EuiPopover, @@ -15,20 +15,8 @@ import { EuiSelectableOption, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { PopoverAnchorPosition } from '@elastic/eui/src/components/popover/popover'; - -export interface FieldValueSelectionProps { - value?: string; - label: string; - loading?: boolean; - onChange: (val?: string) => void; - values?: string[]; - setQuery: Dispatch>; - anchorPosition?: PopoverAnchorPosition; - forceOpen?: boolean; - button?: JSX.Element; - width?: number; -} +import styled from 'styled-components'; +import { FieldValueSelectionProps } from './types'; const formatOptions = (values?: string[], value?: string): EuiSelectableOption[] => { return (values ?? []).map((val) => ({ @@ -38,6 +26,7 @@ const formatOptions = (values?: string[], value?: string): EuiSelectableOption[] }; export function FieldValueSelection({ + fullWidth, label, value, loading, @@ -47,6 +36,7 @@ export function FieldValueSelection({ width, forceOpen, anchorPosition, + singleSelection, onChange: onSelectionChange, }: FieldValueSelectionProps) { const [options, setOptions] = useState(formatOptions(values, value)); @@ -81,13 +71,14 @@ export function FieldValueSelection({ iconSide="right" onClick={onButtonClick} data-test-subj={'fieldValueSelectionBtn'} + fullWidth={fullWidth} > {label} ); return ( - + - + ); } + +const Wrapper = styled.div` + &&& { + div.euiPopover__anchor { + width: 100%; + max-width: 250px; + .euiButton { + width: 100%; + } + } + } +`; diff --git a/x-pack/plugins/observability/public/components/shared/field_value_suggestions/index.tsx b/x-pack/plugins/observability/public/components/shared/field_value_suggestions/index.tsx index 9ffe2584c8d7..a3bfd8daac7d 100644 --- a/x-pack/plugins/observability/public/components/shared/field_value_suggestions/index.tsx +++ b/x-pack/plugins/observability/public/components/shared/field_value_suggestions/index.tsx @@ -8,27 +8,12 @@ import React, { useState } from 'react'; import { useDebounce } from 'react-use'; -import { PopoverAnchorPosition } from '@elastic/eui/src/components/popover/popover'; import { useValuesList } from '../../../hooks/use_values_list'; -import { IndexPattern } from '../../../../../../../src/plugins/data/common'; import { FieldValueSelection } from './field_value_selection'; -import { ESFilter } from '../../../../../../../typings/elasticsearch'; - -export interface FieldValueSuggestionsProps { - value?: string; - label: string; - indexPattern: IndexPattern; - sourceField: string; - onChange: (val?: string) => void; - filters: ESFilter[]; - anchorPosition?: PopoverAnchorPosition; - time?: { from: string; to: string }; - forceOpen?: boolean; - button?: JSX.Element; - width?: number; -} +import { FieldValueSuggestionsProps } from './types'; export function FieldValueSuggestions({ + fullWidth, sourceField, label, indexPattern, @@ -39,6 +24,7 @@ export function FieldValueSuggestions({ width, forceOpen, anchorPosition, + singleSelection, onChange: onSelectionChange, }: FieldValueSuggestionsProps) { const [query, setQuery] = useState(''); @@ -56,6 +42,8 @@ export function FieldValueSuggestions({ return ( void; + filters: ESFilter[]; + time?: { from: string; to: string }; +}; + +export type FieldValueSelectionProps = CommonProps & { + loading?: boolean; + onChange: (val?: string) => void; + values?: string[]; + setQuery: Dispatch>; +}; diff --git a/x-pack/plugins/observability/public/components/shared/index.tsx b/x-pack/plugins/observability/public/components/shared/index.tsx index 976139fdc121..d4d7521a6b09 100644 --- a/x-pack/plugins/observability/public/components/shared/index.tsx +++ b/x-pack/plugins/observability/public/components/shared/index.tsx @@ -7,7 +7,7 @@ import React, { lazy, Suspense } from 'react'; import type { CoreVitalProps, HeaderMenuPortalProps } from './types'; -import type { FieldValueSuggestionsProps } from './field_value_suggestions'; +import type { FieldValueSuggestionsProps } from './field_value_suggestions/types'; const CoreVitalsLazy = lazy(() => import('./core_web_vitals/index')); diff --git a/x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts b/x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts index 726c83d0c225..ae3e2eb8c270 100644 --- a/x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts +++ b/x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts @@ -125,6 +125,7 @@ export interface ObservabilityFetchDataResponse { apm: ApmFetchDataResponse; infra_metrics: MetricsFetchDataResponse; infra_logs: LogsFetchDataResponse; + synthetics: UptimeFetchDataResponse; uptime: UptimeFetchDataResponse; ux: UxFetchDataResponse; } @@ -134,5 +135,6 @@ export interface ObservabilityHasDataResponse { infra_metrics: boolean; infra_logs: boolean; uptime: boolean; + synthetics: boolean; ux: UXHasDataResponse; } diff --git a/x-pack/plugins/observability/typings/common.ts b/x-pack/plugins/observability/typings/common.ts index 0d0b2af85170..81477d0a7f81 100644 --- a/x-pack/plugins/observability/typings/common.ts +++ b/x-pack/plugins/observability/typings/common.ts @@ -9,7 +9,9 @@ export type ObservabilityApp = | 'infra_metrics' | 'infra_logs' | 'apm' + // we will remove uptime in future to replace to be replace by synthetics | 'uptime' + | 'synthetics' | 'observability-overview' | 'stack_monitoring' | 'ux'; diff --git a/x-pack/plugins/security/public/management/api_keys/api_keys_grid/api_keys_grid_page.test.tsx b/x-pack/plugins/security/public/management/api_keys/api_keys_grid/api_keys_grid_page.test.tsx index ba879e99f159..72fd79805f97 100644 --- a/x-pack/plugins/security/public/management/api_keys/api_keys_grid/api_keys_grid_page.test.tsx +++ b/x-pack/plugins/security/public/management/api_keys/api_keys_grid/api_keys_grid_page.test.tsx @@ -70,7 +70,8 @@ authc.getCurrentUser.mockResolvedValue( }) ); -describe('APIKeysGridPage', () => { +// FLAKY: https://github.com/elastic/kibana/issues/97085 +describe.skip('APIKeysGridPage', () => { it('loads and displays API keys', async () => { const history = createMemoryHistory({ initialEntries: ['/'] }); diff --git a/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap b/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap index 60453d354f29..eb266ce93338 100644 --- a/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap +++ b/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap @@ -14,9 +14,11 @@ exports[` renders permission denied if required 1`] = `
{ aria-expanded="false" aria-haspopup="true" aria-label="Account menu" - class="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItem__button" + class="euiButtonEmpty euiButtonEmpty--text euiHeaderSectionItemButton" data-test-subj="userMenuButton" type="button" > @@ -80,18 +80,22 @@ describe('SecurityNavControlService', () => { -
- -
+ +
+ diff --git a/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap b/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap index bcb8a6c97535..785c57490e8e 100644 --- a/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap +++ b/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap @@ -1,3 +1,3 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`ResetSessionPage renders as expected 1`] = `"MockedFonts

You do not have permission to access the requested page

Either go back to the previous page or log in as a different user.

Log in as different user
"`; +exports[`ResetSessionPage renders as expected 1`] = `"MockedFonts

You do not have permission to access the requested page

Either go back to the previous page or log in as a different user.

Log in as different user
"`; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts index 76ccfb0a433b..c61ab85f4327 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts @@ -494,7 +494,7 @@ export const threshold = t.intersection([ thresholdField, t.exact( t.partial({ - cardinality: t.union([t.array(thresholdCardinalityField), t.null]), + cardinality: t.array(thresholdCardinalityField), }) ), ]); @@ -507,7 +507,7 @@ export const thresholdNormalized = t.intersection([ thresholdFieldNormalized, t.exact( t.partial({ - cardinality: t.union([t.array(thresholdCardinalityField), t.null]), + cardinality: t.array(thresholdCardinalityField), }) ), ]); diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/rule_schemas.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/request/rule_schemas.ts index 5cf2b6242b2f..c7b33372e595 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/rule_schemas.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/schemas/request/rule_schemas.ts @@ -57,16 +57,16 @@ import { interval, enabled, updated_at, + updated_by, created_at, + created_by, job_status, status_date, last_success_at, last_success_message, last_failure_at, last_failure_message, - throttleOrNull, - createdByOrNull, - updatedByOrNull, + throttle, } from '../common/schemas'; const createSchema = < @@ -137,7 +137,7 @@ interface APIParams< defaultable: Defaultable; } -const commonParams = { +const baseParams = { required: { name, description, @@ -159,12 +159,11 @@ const commonParams = { tags, interval, enabled, - throttle: throttleOrNull, + throttle, actions, author, false_positives, from, - rule_id, // maxSignals not used in ML rules but probably should be used max_signals, risk_score_mapping, @@ -177,10 +176,26 @@ const commonParams = { }, }; const { - create: commonCreateParams, - patch: commonPatchParams, - response: commonResponseParams, -} = buildAPISchemas(commonParams); + create: baseCreateParams, + patch: basePatchParams, + response: baseResponseParams, +} = buildAPISchemas(baseParams); + +// "shared" types are the same across all rule types, and built from "baseParams" above +// with some variations for each route. These intersect with type specific schemas below +// to create the full schema for each route. +export const sharedCreateSchema = t.intersection([ + baseCreateParams, + t.exact(t.partial({ rule_id })), +]); +export type SharedCreateSchema = t.TypeOf; + +export const sharedUpdateSchema = t.intersection([ + baseCreateParams, + t.exact(t.partial({ rule_id })), + t.exact(t.partial({ id })), +]); +export type SharedUpdateSchema = t.TypeOf; const eqlRuleParams = { required: { @@ -318,74 +333,28 @@ const createTypeSpecific = t.union([ export type CreateTypeSpecific = t.TypeOf; // Convenience types for building specific types of rules -export const eqlCreateSchema = t.intersection([eqlCreateParams, commonCreateParams]); -export type EqlCreateSchema = t.TypeOf; - -export const threatMatchCreateSchema = t.intersection([ - threatMatchCreateParams, - commonCreateParams, -]); -export type ThreatMatchCreateSchema = t.TypeOf; - -export const queryCreateSchema = t.intersection([queryCreateParams, commonCreateParams]); -export type QueryCreateSchema = t.TypeOf; - -export const savedQueryCreateSchema = t.intersection([savedQueryCreateParams, commonCreateParams]); -export type SavedQueryCreateSchema = t.TypeOf; - -export const thresholdCreateSchema = t.intersection([thresholdCreateParams, commonCreateParams]); -export type ThresholdCreateSchema = t.TypeOf; - -export const machineLearningCreateSchema = t.intersection([ - machineLearningCreateParams, - commonCreateParams, -]); -export type MachineLearningCreateSchema = t.TypeOf; - -export const createRulesSchema = t.intersection([commonCreateParams, createTypeSpecific]); +type CreateSchema = SharedCreateSchema & T; +export type EqlCreateSchema = CreateSchema>; +export type ThreatMatchCreateSchema = CreateSchema>; +export type QueryCreateSchema = CreateSchema>; +export type SavedQueryCreateSchema = CreateSchema>; +export type ThresholdCreateSchema = CreateSchema>; +export type MachineLearningCreateSchema = CreateSchema< + t.TypeOf +>; + +export const createRulesSchema = t.intersection([sharedCreateSchema, createTypeSpecific]); export type CreateRulesSchema = t.TypeOf; -export const eqlUpdateSchema = t.intersection([ - eqlCreateParams, - commonCreateParams, - t.exact(t.partial({ id })), -]); -export type EqlUpdateSchema = t.TypeOf; - -export const threatMatchUpdateSchema = t.intersection([ - threatMatchCreateParams, - commonCreateParams, - t.exact(t.partial({ id })), -]); -export type ThreatMatchUpdateSchema = t.TypeOf; - -export const queryUpdateSchema = t.intersection([ - queryCreateParams, - commonCreateParams, - t.exact(t.partial({ id })), -]); -export type QueryUpdateSchema = t.TypeOf; - -export const savedQueryUpdateSchema = t.intersection([ - savedQueryCreateParams, - commonCreateParams, - t.exact(t.partial({ id })), -]); -export type SavedQueryUpdateSchema = t.TypeOf; - -export const thresholdUpdateSchema = t.intersection([ - thresholdCreateParams, - commonCreateParams, - t.exact(t.partial({ id })), -]); -export type ThresholdUpdateSchema = t.TypeOf; - -export const machineLearningUpdateSchema = t.intersection([ - machineLearningCreateParams, - commonCreateParams, - t.exact(t.partial({ id })), -]); -export type MachineLearningUpdateSchema = t.TypeOf; +type UpdateSchema = SharedUpdateSchema & T; +export type EqlUpdateSchema = UpdateSchema>; +export type ThreatMatchUpdateSchema = UpdateSchema>; +export type QueryUpdateSchema = UpdateSchema>; +export type SavedQueryUpdateSchema = UpdateSchema>; +export type ThresholdUpdateSchema = UpdateSchema>; +export type MachineLearningUpdateSchema = UpdateSchema< + t.TypeOf +>; const patchTypeSpecific = t.union([ eqlPatchParams, @@ -406,26 +375,23 @@ const responseTypeSpecific = t.union([ ]); export type ResponseTypeSpecific = t.TypeOf; -export const updateRulesSchema = t.intersection([ - commonCreateParams, - createTypeSpecific, - t.exact(t.partial({ id })), -]); +export const updateRulesSchema = t.intersection([createTypeSpecific, sharedUpdateSchema]); export type UpdateRulesSchema = t.TypeOf; export const fullPatchSchema = t.intersection([ - commonPatchParams, + basePatchParams, patchTypeSpecific, t.exact(t.partial({ id })), ]); const responseRequiredFields = { id, + rule_id, immutable, updated_at, - updated_by: updatedByOrNull, + updated_by, created_at, - created_by: createdByOrNull, + created_by, }; const responseOptionalFields = { status: job_status, @@ -437,7 +403,7 @@ const responseOptionalFields = { }; export const fullResponseSchema = t.intersection([ - commonResponseParams, + baseResponseParams, responseTypeSpecific, t.exact(t.type(responseRequiredFields)), t.exact(t.partial(responseOptionalFields)), diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_rules_schema.test.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_rules_schema.test.ts deleted file mode 100644 index f9cd405db935..000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_rules_schema.test.ts +++ /dev/null @@ -1,128 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { findRulesSchema, FindRulesSchema } from './find_rules_schema'; -import { pipe } from 'fp-ts/lib/pipeable'; -import { left } from 'fp-ts/lib/Either'; -import { RulesSchema } from './rules_schema'; -import { exactCheck } from '../../../exact_check'; -import { foldLeftRight, getPaths } from '../../../test_utils'; -import { getRulesSchemaMock } from './rules_schema.mocks'; -import { getFindRulesSchemaMock } from './find_rules_schema.mocks'; - -describe('find_rules_schema', () => { - test('it should validate a typical single find rules response', () => { - const payload = getFindRulesSchemaMock(); - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(getFindRulesSchemaMock()); - }); - - test('it should validate an empty find rules response', () => { - const payload = getFindRulesSchemaMock(); - payload.data = []; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - const expected = getFindRulesSchemaMock(); - expected.data = []; - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(expected); - }); - - test('it should invalidate a typical single find rules response if it is has an extra property on it', () => { - const payload: FindRulesSchema & { invalid_data?: 'invalid' } = getFindRulesSchemaMock(); - payload.invalid_data = 'invalid'; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['invalid keys "invalid_data"']); - expect(message.schema).toEqual({}); - }); - - test('it should invalidate a typical single find rules response if the rules are invalid within it', () => { - const payload = getFindRulesSchemaMock(); - const invalidRule: RulesSchema & { invalid_extra_data?: string } = getRulesSchemaMock(); - invalidRule.invalid_extra_data = 'invalid_data'; - payload.data = [invalidRule]; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['invalid keys "invalid_extra_data"']); - expect(message.schema).toEqual({}); - }); - - test('it should invalidate a typical single find rules response if the rule is missing a required field such as name', () => { - const payload = getFindRulesSchemaMock(); - const invalidRule = getRulesSchemaMock(); - // @ts-expect-error - delete invalidRule.name; - payload.data = [invalidRule]; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "undefined" supplied to "name"', - ]); - expect(message.schema).toEqual({}); - }); - - test('it should invalidate a typical single find rules response if it is missing perPage', () => { - const payload = getFindRulesSchemaMock(); - // @ts-expect-error - delete payload.perPage; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "undefined" supplied to "perPage"', - ]); - expect(message.schema).toEqual({}); - }); - - test('it should invalidate a typical single find rules response if it has a negative perPage number', () => { - const payload = getFindRulesSchemaMock(); - payload.perPage = -1; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['Invalid value "-1" supplied to "perPage"']); - expect(message.schema).toEqual({}); - }); - - test('it should invalidate a typical single find rules response if it has a negative page number', () => { - const payload = getFindRulesSchemaMock(); - payload.page = -1; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['Invalid value "-1" supplied to "page"']); - expect(message.schema).toEqual({}); - }); - - test('it should invalidate a typical single find rules response if it has a negative total', () => { - const payload = getFindRulesSchemaMock(); - payload.total = -1; - const decoded = findRulesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['Invalid value "-1" supplied to "total"']); - expect(message.schema).toEqual({}); - }); -}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_rules_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_rules_schema.ts deleted file mode 100644 index c477bc108a7d..000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_rules_schema.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import * as t from 'io-ts'; - -import { rulesSchema } from './rules_schema'; -import { page, perPage, total } from '../common/schemas'; - -export const findRulesSchema = t.exact( - t.type({ - page, - perPage, - total, - data: t.array(rulesSchema), - }) -); - -export type FindRulesSchema = t.TypeOf; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts index 021cab086438..fa8ebaf597f4 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts @@ -6,7 +6,6 @@ */ export * from './error_schema'; -export * from './find_rules_schema'; export * from './import_rules_schema'; export * from './prepackaged_rules_schema'; export * from './prepackaged_rules_status_schema'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/utils.ts b/x-pack/plugins/security_solution/common/detection_engine/utils.ts index a2c362b08dc7..1f4e4e140ce1 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/utils.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/utils.ts @@ -12,7 +12,7 @@ import { EntriesArray, ExceptionListItemSchema, } from '../shared_imports'; -import { Type, JobStatus } from './schemas/common/schemas'; +import { Type, JobStatus, Threshold, ThresholdNormalized } from './schemas/common/schemas'; export const hasLargeValueItem = ( exceptionItems: Array @@ -55,5 +55,12 @@ export const normalizeThresholdField = ( : [thresholdField!]; }; +export const normalizeThresholdObject = (threshold: Threshold): ThresholdNormalized => { + return { + ...threshold, + field: normalizeThresholdField(threshold.field), + }; +}; + export const getRuleStatusText = (value: JobStatus | null | undefined): JobStatus | null => value === 'partial failure' ? 'warning' : value != null ? value : null; diff --git a/x-pack/plugins/security_solution/common/validate.ts b/x-pack/plugins/security_solution/common/validate.ts index 79a0351b824e..1ac41ecbfb88 100644 --- a/x-pack/plugins/security_solution/common/validate.ts +++ b/x-pack/plugins/security_solution/common/validate.ts @@ -27,7 +27,7 @@ export const validate = ( }; export const validateNonExact = ( - obj: object, + obj: unknown, schema: T ): [t.TypeOf | null, string | null] => { const decoded = schema.decode(obj); diff --git a/x-pack/plugins/security_solution/cypress/objects/rule.ts b/x-pack/plugins/security_solution/cypress/objects/rule.ts index 68c7796f7ca3..e85b3f45b4ea 100644 --- a/x-pack/plugins/security_solution/cypress/objects/rule.ts +++ b/x-pack/plugins/security_solution/cypress/objects/rule.ts @@ -332,5 +332,5 @@ export const editedRule = { export const expectedExportedRule = (ruleResponse: Cypress.Response) => { const jsonrule = ruleResponse.body; - return `{"author":[],"actions":[],"created_at":"${jsonrule.created_at}","updated_at":"${jsonrule.updated_at}","created_by":"elastic","description":"${jsonrule.description}","enabled":false,"false_positives":[],"from":"now-17520h","id":"${jsonrule.id}","immutable":false,"index":["exceptions-*"],"interval":"10s","rule_id":"rule_testing","language":"kuery","output_index":".siem-signals-default","max_signals":100,"risk_score":${jsonrule.risk_score},"risk_score_mapping":[],"name":"${jsonrule.name}","query":"${jsonrule.query}","references":[],"severity":"${jsonrule.severity}","severity_mapping":[],"updated_by":"elastic","tags":[],"to":"now","type":"query","threat":[],"throttle":"no_actions","version":1,"exceptions_list":[]}\n{"exported_count":1,"missing_rules":[],"missing_rules_count":0}\n`; + return `{"id":"${jsonrule.id}","updated_at":"${jsonrule.updated_at}","updated_by":"elastic","created_at":"${jsonrule.created_at}","created_by":"elastic","name":"${jsonrule.name}","tags":[],"interval":"10s","enabled":false,"description":"${jsonrule.description}","risk_score":${jsonrule.risk_score},"severity":"${jsonrule.severity}","output_index":".siem-signals-default","author":[],"false_positives":[],"from":"now-17520h","rule_id":"rule_testing","max_signals":100,"risk_score_mapping":[],"severity_mapping":[],"threat":[],"to":"now","references":[],"version":1,"exceptions_list":[],"immutable":false,"type":"query","language":"kuery","index":["exceptions-*"],"query":"${jsonrule.query}","throttle":"no_actions","actions":[]}\n{"exported_count":1,"missing_rules":[],"missing_rules_count":0}\n`; }; diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/select_rule_type/index.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/select_rule_type/index.tsx index 64f0f5f65b1e..5650c2c55488 100644 --- a/x-pack/plugins/security_solution/public/detections/components/rules/select_rule_type/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/rules/select_rule_type/index.tsx @@ -111,7 +111,6 @@ export const SelectRuleType: React.FC = ({ icon={} selectable={querySelectableConfig} layout="horizontal" - textAlign="left" /> )} @@ -131,7 +130,6 @@ export const SelectRuleType: React.FC = ({ isDisabled={mlSelectableConfig.isDisabled && !mlSelectableConfig.isSelected} selectable={mlSelectableConfig} layout="horizontal" - textAlign="left" /> )} @@ -145,7 +143,6 @@ export const SelectRuleType: React.FC = ({ icon={} selectable={thresholdSelectableConfig} layout="horizontal" - textAlign="left" /> )} @@ -159,7 +156,6 @@ export const SelectRuleType: React.FC = ({ icon={} selectable={eqlSelectableConfig} layout="horizontal" - textAlign="left" /> )} @@ -173,7 +169,6 @@ export const SelectRuleType: React.FC = ({ icon={} selectable={threatMatchSelectableConfig} layout="horizontal" - textAlign="left" /> )} diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details.tsx index bc89fe572b93..204c3a86ce3e 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details.tsx @@ -194,7 +194,7 @@ export const PolicyDetails = React.memo(() => { noTimeline data-test-subj="policyDetailsPage" noPadding - style={{ 'background-color': theme.eui.euiHeaderBackgroundColor }} + style={{ backgroundColor: theme.eui.euiHeaderBackgroundColor }} className="policyDetailsPage" > diff --git a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/trusted_apps_grid/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/trusted_apps_grid/__snapshots__/index.test.tsx.snap index efae0a4b8b3a..220494b3a569 100644 --- a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/trusted_apps_grid/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/trusted_apps_grid/__snapshots__/index.test.tsx.snap @@ -2919,7 +2919,7 @@ exports[`TrustedAppsGrid renders correctly when loaded data 1`] = `
`; @@ -44,7 +46,6 @@ exports[`renders with a space name entirely made of whitespace 1`] = ` = (props: Props) => { const spaceColor = getSpaceColor(space); + const spaceInitials = getSpaceInitials(space); + + const spaceImageUrl = getSpaceImageUrl(space); + + const avatarConfig: Partial = spaceImageUrl + ? { imageUrl: spaceImageUrl } + : { initials: spaceInitials, initialsLength: MAX_SPACE_INITIALS }; + return ( = (props: Props) => { 'aria-hidden': true, })} size={size || 'm'} - initialsLength={MAX_SPACE_INITIALS} - initials={getSpaceInitials(space)} color={isValidHex(spaceColor) ? spaceColor : ''} - imageUrl={getSpaceImageUrl(space)} + {...avatarConfig} {...rest} /> ); diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index 4ec86a71dcb2..b567d9effe1b 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -8677,30 +8677,17 @@ "xpack.fleet.settings.flyoutTitle": "Fleet 設定", "xpack.fleet.settings.globalOutputTitle": "グローバル出力", "xpack.fleet.settings.invalidYamlFormatErrorMessage": "無効なYAML形式：{reason}", - "xpack.fleet.settings.kibanaUrlDifferentPathOrProtocolError": "各URLのプロトコルとパスは同じでなければなりません", - "xpack.fleet.settings.kibanaUrlEmptyError": "1つ以上のURLが必要です。", - "xpack.fleet.settings.kibanaUrlError": "無効なURL", - "xpack.fleet.settings.kibanaUrlLabel": "Kibana URL", "xpack.fleet.settings.saveButtonLabel": "設定を保存", "xpack.fleet.settings.success.message": "設定が保存されました", "xpack.fleet.setupPage.apiKeyServiceLink": "APIキーサービス", "xpack.fleet.setupPage.elasticsearchApiKeyFlagText": "{apiKeyLink}.{apiKeyFlag}を{true}に設定します。", "xpack.fleet.setupPage.elasticsearchSecurityFlagText": "{esSecurityLink}.{securityFlag}を{true}に設定します。", "xpack.fleet.setupPage.elasticsearchSecurityLink": "Elasticsearchセキュリティ", - "xpack.fleet.setupPage.enableCentralManagement": "ユーザーを作成し、集中管理を有効にする", - "xpack.fleet.setupPage.enableText": "集中管理には、APIキーを作成し、log-*とmetrics-*に書き込むことができるElasticユーザーが必要です。", - "xpack.fleet.setupPage.enableTitle": "ElasticElasticエージェントの集中管理を有効にする", - "xpack.fleet.setupPage.encryptionKeyFlagText": "{encryptionKeyLink}.{keyFlag}を32文字以上の英数字に設定します。", "xpack.fleet.setupPage.gettingStartedLink": "はじめに", "xpack.fleet.setupPage.gettingStartedText": "詳細については、{link}ガイドをお読みください。", - "xpack.fleet.setupPage.kibanaEncryptionLink": "Kibana暗号化鍵", - "xpack.fleet.setupPage.kibanaSecurityLink": "Kibanaセキュリティ", "xpack.fleet.setupPage.missingRequirementsCalloutDescription": "Elasticエージェントの集中管理を使用するには、次のElasticsearchとKibanaセキュリティ機能を有効にする必要があります。", "xpack.fleet.setupPage.missingRequirementsCalloutTitle": "不足しているセキュリティ要件", "xpack.fleet.setupPage.missingRequirementsElasticsearchTitle": "Elasticsearchポリシーでは、次のことができます。", - "xpack.fleet.setupPage.missingRequirementsKibanaTitle": "Kibanaポリシーでは、次のことができます。", - "xpack.fleet.setupPage.tlsFlagText": "{kibanaSecurityLink}.{securityFlag}を{true}に設定します。開発目的では、危険な代替として{tlsFlag}を{true}に設定して、{tlsLink}を無効化できます。", - "xpack.fleet.setupPage.tlsLink": "TLS", "xpack.fleet.unenrollAgents.cancelButtonLabel": "キャンセル", "xpack.fleet.unenrollAgents.confirmMultipleButtonLabel": "{count}個のエージェントを登録解除", "xpack.fleet.unenrollAgents.confirmSingleButtonLabel": "エージェントの登録解除", @@ -22593,14 +22580,9 @@ "xpack.uiActionsEnhanced.drilldowns.urlDrilldownValidation.urlFormatErrorMessage": "無効な形式：{message}", "xpack.uiActionsEnhanced.drilldowns.urlDrilldownValidation.urlFormatGeneralErrorMessage": "無効なフォーマット。例：{exampleUrl}", "xpack.upgradeAssistant.appTitle": "{version} アップグレードアシスタント", - "xpack.upgradeAssistant.checkupTab.backUpCallout.calloutBody.calloutDetail": "{snapshotRestoreDocsButton} でデータをバックアップします。", - "xpack.upgradeAssistant.checkupTab.backUpCallout.calloutBody.snapshotRestoreDocsButtonLabel": "API のスナップショットと復元", - "xpack.upgradeAssistant.checkupTab.backUpCallout.calloutTitle": "今すぐインデックをバックアップ", "xpack.upgradeAssistant.checkupTab.changeFiltersShowMoreLabel": "より多く表示させるにはフィルターを変更します。", - "xpack.upgradeAssistant.checkupTab.clusterTabLabel": "クラスター", "xpack.upgradeAssistant.checkupTab.controls.collapseAllButtonLabel": "すべて縮小", "xpack.upgradeAssistant.checkupTab.controls.expandAllButtonLabel": "すべて拡張", - "xpack.upgradeAssistant.checkupTab.controls.filterBar.allButtonLabel": "すべて", "xpack.upgradeAssistant.checkupTab.controls.filterBar.criticalButtonLabel": "致命的", "xpack.upgradeAssistant.checkupTab.controls.filterErrorMessageLabel": "フィルター無効：{searchTermError}", "xpack.upgradeAssistant.checkupTab.controls.groupByBar.byIndexLabel": "インデックス別", @@ -22615,12 +22597,9 @@ "xpack.upgradeAssistant.checkupTab.deprecations.indexTable.indexColumnLabel": "インデックス", "xpack.upgradeAssistant.checkupTab.deprecations.warningActionTooltip": "アップグレード前にこの問題を解決することをお勧めしますが、必須ではありません。", "xpack.upgradeAssistant.checkupTab.deprecations.warningLabel": "警告", - "xpack.upgradeAssistant.checkupTab.indexLabel": "インデックス", - "xpack.upgradeAssistant.checkupTab.indicesTabLabel": "インデックス", "xpack.upgradeAssistant.checkupTab.noDeprecationsLabel": "説明がありません", "xpack.upgradeAssistant.checkupTab.noIssues.nextStepsDetail": "{overviewTabButton} で次のステップを確認してください。", "xpack.upgradeAssistant.checkupTab.noIssues.nextStepsDetail.overviewTabButtonLabel": "概要タブ", - "xpack.upgradeAssistant.checkupTab.noIssues.noIssuesLabel": "{strongCheckupLabel} の問題がありません。", "xpack.upgradeAssistant.checkupTab.noIssues.noIssuesTitle": "完璧です！", "xpack.upgradeAssistant.checkupTab.numDeprecationsShownLabel": "{total} 件中 {numShown} 件を表示中", "xpack.upgradeAssistant.checkupTab.reindexing.flyout.checklistStep.cancelButtonLabel": "キャンセル", @@ -22663,45 +22642,12 @@ "xpack.upgradeAssistant.checkupTab.reindexing.reindexButton.loadingLabel": "読み込み中…", "xpack.upgradeAssistant.checkupTab.reindexing.reindexButton.pausedLabel": "一時停止中", "xpack.upgradeAssistant.checkupTab.reindexing.reindexButton.reindexLabel": "再インデックス", - "xpack.upgradeAssistant.checkupTab.tabDetail": "これらの {strongCheckupLabel} 問題に対応する必要があります。Elasticsearch {nextEsVersion} へのアップグレード前に解決してください。", - "xpack.upgradeAssistant.forbiddenErrorCallout.calloutTitle": "このページを表示するための権限がありません。", - "xpack.upgradeAssistant.genericErrorCallout.calloutTitle": "チェックアップの結果を取得中にエラーが発生しました。", - "xpack.upgradeAssistant.overviewTab.overviewTabTitle": "概要", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.issuesRemainingStepTitle": "クラスターの問題を確認してください", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.noIssuesRemainingStepTitle": "クラスターの設定は準備完了です", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.noRemainingIssuesLabel": "廃止された設定は残っていません。", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.remainingIssuesDetail": "{numIssues} 件の問題が解決されました。", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.todo.clusterTabButtonLabel": "クラスタータブ", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.todo.todoDetail": "{clusterTabButton} に移動して廃止された設定を更新してください。", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.deprecationLogs.deprecationLogsDocButtonLabel": "廃止ログ", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.deprecationLogs.logsDetail": "{deprecationLogsDocButton} で、アプリケーションが {nextEsVersion} で利用できない機能を使用していないか確認してください。廃止ログを有効にする必要があるかもしれません。", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingLabel": "廃止ログを有効にしますか？", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.disabledLabel": "オフ", "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.enabledLabel": "オン", "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.errorLabel": "ログステータスを読み込めませんでした", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.stepTitle": "Elasticsearch の廃止ログを確認してください", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.issuesRemainingStepTitle": "インデックスの問題を確認してください", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.noIssuesRemainingStepTitle": "インデックスの設定は準備完了です", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.noRemainingIssuesLabel": "廃止された設定は残っていません。", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.remainingIssuesDetail": "{numIssues} 件の問題が解決されました。", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.todo.indicesTabButtonLabel": "インデックスタブ", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.todo.todoDetail": "{indicesTabButton} に移動して廃止された設定を更新してください。", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStep.stepTitle": "アップグレード開始", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStepCloud.stepDetail.goToCloudDashboardDetail": "Elastic Cloud ダッシュボードのデプロイセクションに移動し、アップグレードを開始します。", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStepOnPrem.stepDetail.followInstructionsDetail": "{instructionButton} に従い、アップグレードを開始します。", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStepOnPrem.stepDetail.instructionButtonLabel": "これらの手順", - "xpack.upgradeAssistant.overviewTab.steps.waitForReleaseStep.stepDetail": "リリースされ次第最新の {currentEsMajorVersion} バージョンにアップグレードし、ここに戻って {nextEsMajorVersion} へのアップグレードを行ってください。", - "xpack.upgradeAssistant.overviewTab.steps.waitForReleaseStep.stepTitle": "Elasticsearch {nextEsVersion} のリリース待ち", - "xpack.upgradeAssistant.overviewTab.tabDetail": "このアシスタントは、クラスターとインデックスの Elasticsearch への準備に役立ちます {nextEsVersion} 対処が必要な他の問題に関しては、Elasticsearch のログをご覧ください。", "xpack.upgradeAssistant.reindex.reindexPrivilegesErrorBatch": "「{indexName}」に再インデックスするための権限が不十分です。", - "xpack.upgradeAssistant.tabs.checkupTab.clusterLabel": "クラスター", "xpack.upgradeAssistant.tabs.incompleteCallout.calloutBody.breackingChangesDocButtonLabel": "廃止と互換性を破る変更", "xpack.upgradeAssistant.tabs.incompleteCallout.calloutBody.calloutDetail": "Elasticsearch {nextEsVersion} の {breakingChangesDocButton} の完全なリストは、最終の {currentEsVersion} マイナーリリースで確認できます。この警告は、リストがすべて解決されると消えます。", "xpack.upgradeAssistant.tabs.incompleteCallout.calloutTitle": "リストの問題がすべて解決されていない可能性があります。", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradeCompleteDescription": "すべての Elasticsearch ノードがアップグレードされました。Kibana をアップデートする準備ができました。", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradeCompleteTitle": "クラスターがアップグレードされました", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradingDescription": "1 つまたは複数の Elasticsearch ノードに、 Kibana よりも新しいバージョンの Elasticsearch があります。すべてのノードがアップグレードされた後で Kibana をアップグレードしてください。", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradingTitle": "クラスターをアップグレード中です", "xpack.uptime.addDataButtonLabel": "データの追加", "xpack.uptime.alerts.anomaly.criteriaExpression.ariaLabel": "選択したモニターの条件を表示する式。", "xpack.uptime.alerts.anomaly.criteriaExpression.description": "監視するとき", @@ -23133,7 +23079,6 @@ "xpack.uptime.synthetics.waterfall.resource.externalLink": "新しいタブでリソースを開く", "xpack.uptime.synthetics.waterfall.searchBox.placeholder": "ネットワーク要求をフィルター", "xpack.uptime.synthetics.waterfall.sidebar.filterMatchesScreenReaderLabel": "リソースがフィルターと一致します", - "xpack.uptime.synthetics.waterfallChart.labels.metadata.bytesDownloadedCompressed": "ダウンロードバイト数 (圧縮) ", "xpack.uptime.synthetics.waterfallChart.labels.metadata.certificateExpiryDate": "有効期限：", "xpack.uptime.synthetics.waterfallChart.labels.metadata.certificateIssueDate": "有効期間の開始", "xpack.uptime.synthetics.waterfallChart.labels.metadata.certificateIssuer": "発行者", @@ -23539,4 +23484,4 @@ "xpack.watcher.watchEdit.thresholdWatchExpression.aggType.fieldIsRequiredValidationMessage": "フィールドを選択してください。", "xpack.watcher.watcherDescription": "アラートの作成、管理、監視によりデータへの変更を検知します。" } -} +} \ No newline at end of file diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index 97317818f10c..c9c653e33b90 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -8762,30 +8762,17 @@ "xpack.fleet.settings.flyoutTitle": "Fleet 设置", "xpack.fleet.settings.globalOutputTitle": "全局输出", "xpack.fleet.settings.invalidYamlFormatErrorMessage": "YAML 无效：{reason}", - "xpack.fleet.settings.kibanaUrlDifferentPathOrProtocolError": "对于每个 URL，协议和路径必须相同", - "xpack.fleet.settings.kibanaUrlEmptyError": "至少需要一个 URL", - "xpack.fleet.settings.kibanaUrlError": "URL 无效", - "xpack.fleet.settings.kibanaUrlLabel": "Kibana URL", "xpack.fleet.settings.saveButtonLabel": "保存设置", "xpack.fleet.settings.success.message": "设置已保存", "xpack.fleet.setupPage.apiKeyServiceLink": "API 密钥服务", "xpack.fleet.setupPage.elasticsearchApiKeyFlagText": "{apiKeyLink}。将 {apiKeyFlag} 设置为 {true}。", "xpack.fleet.setupPage.elasticsearchSecurityFlagText": "{esSecurityLink}。将 {securityFlag} 设置为 {true}。", "xpack.fleet.setupPage.elasticsearchSecurityLink": "Elasticsearch 安全", - "xpack.fleet.setupPage.enableCentralManagement": "创建用户并启用集中管理", - "xpack.fleet.setupPage.enableText": "集中管理需要可以创建 API 密钥并写入到 logs-* 和 metrics-* 的 Elastic 用户。", - "xpack.fleet.setupPage.enableTitle": "对 Elastic 代理启用集中管理", - "xpack.fleet.setupPage.encryptionKeyFlagText": "{encryptionKeyLink}。将 {keyFlag} 设置为至少 32 个字符的字母数字值。", "xpack.fleet.setupPage.gettingStartedLink": "入门", "xpack.fleet.setupPage.gettingStartedText": "有关更多信息，请阅读我们的{link}指南。", - "xpack.fleet.setupPage.kibanaEncryptionLink": "Kibana 加密密钥", - "xpack.fleet.setupPage.kibanaSecurityLink": "Kibana 安全性", "xpack.fleet.setupPage.missingRequirementsCalloutDescription": "要对 Elastic 代理使用集中管理，请启用下面的 Elasticsearch 和 Kibana 安全功能。", "xpack.fleet.setupPage.missingRequirementsCalloutTitle": "缺失安全性要求", "xpack.fleet.setupPage.missingRequirementsElasticsearchTitle": "在 Elasticsearch 策略中，启用：", - "xpack.fleet.setupPage.missingRequirementsKibanaTitle": "在 Kibana 策略中，启用：", - "xpack.fleet.setupPage.tlsFlagText": "{kibanaSecurityLink}。将 {securityFlag} 设置为 {true}。出于开发目的，作为非安全的备用方案可以通过将 {tlsFlag} 设置为 {true} 来禁用 {tlsLink}。", - "xpack.fleet.setupPage.tlsLink": "TLS", "xpack.fleet.unenrollAgents.cancelButtonLabel": "取消", "xpack.fleet.unenrollAgents.confirmMultipleButtonLabel": "取消注册 {count} 个代理", "xpack.fleet.unenrollAgents.confirmSingleButtonLabel": "取消注册代理", @@ -22950,14 +22937,9 @@ "xpack.uiActionsEnhanced.drilldowns.urlDrilldownValidation.urlFormatErrorMessage": "格式无效：{message}", "xpack.uiActionsEnhanced.drilldowns.urlDrilldownValidation.urlFormatGeneralErrorMessage": "格式无效。例如：{exampleUrl}", "xpack.upgradeAssistant.appTitle": "{version} 升级助手", - "xpack.upgradeAssistant.checkupTab.backUpCallout.calloutBody.calloutDetail": "使用 {snapshotRestoreDocsButton} 备份您的数据。", - "xpack.upgradeAssistant.checkupTab.backUpCallout.calloutBody.snapshotRestoreDocsButtonLabel": "快照和还原 API", - "xpack.upgradeAssistant.checkupTab.backUpCallout.calloutTitle": "立即备份索引", "xpack.upgradeAssistant.checkupTab.changeFiltersShowMoreLabel": "更改筛选以显示更多内容。", - "xpack.upgradeAssistant.checkupTab.clusterTabLabel": "集群", "xpack.upgradeAssistant.checkupTab.controls.collapseAllButtonLabel": "折叠全部", "xpack.upgradeAssistant.checkupTab.controls.expandAllButtonLabel": "展开全部", - "xpack.upgradeAssistant.checkupTab.controls.filterBar.allButtonLabel": "全部", "xpack.upgradeAssistant.checkupTab.controls.filterBar.criticalButtonLabel": "紧急", "xpack.upgradeAssistant.checkupTab.controls.filterErrorMessageLabel": "筛选无效：{searchTermError}", "xpack.upgradeAssistant.checkupTab.controls.groupByBar.byIndexLabel": "按索引", @@ -22972,13 +22954,10 @@ "xpack.upgradeAssistant.checkupTab.deprecations.indexTable.indexColumnLabel": "索引", "xpack.upgradeAssistant.checkupTab.deprecations.warningActionTooltip": "建议在升级之前先解决此问题，但这不是必需的。", "xpack.upgradeAssistant.checkupTab.deprecations.warningLabel": "警告", - "xpack.upgradeAssistant.checkupTab.indexLabel": "索引", "xpack.upgradeAssistant.checkupTab.indicesBadgeLabel": "{numIndices, plural, other { 个索引}}", - "xpack.upgradeAssistant.checkupTab.indicesTabLabel": "索引", "xpack.upgradeAssistant.checkupTab.noDeprecationsLabel": "无弃用内容", "xpack.upgradeAssistant.checkupTab.noIssues.nextStepsDetail": "选中 {overviewTabButton} 以执行后续步骤。", "xpack.upgradeAssistant.checkupTab.noIssues.nextStepsDetail.overviewTabButtonLabel": "“概述”选项卡", - "xpack.upgradeAssistant.checkupTab.noIssues.noIssuesLabel": "您没有 {strongCheckupLabel} 问题。", "xpack.upgradeAssistant.checkupTab.noIssues.noIssuesTitle": "全部清除！", "xpack.upgradeAssistant.checkupTab.numDeprecationsShownLabel": "显示 {numShown} 个，共 {total} 个", "xpack.upgradeAssistant.checkupTab.reindexing.flyout.checklistStep.cancelButtonLabel": "取消", @@ -23021,45 +23000,12 @@ "xpack.upgradeAssistant.checkupTab.reindexing.reindexButton.loadingLabel": "正在加载……", "xpack.upgradeAssistant.checkupTab.reindexing.reindexButton.pausedLabel": "已暂停", "xpack.upgradeAssistant.checkupTab.reindexing.reindexButton.reindexLabel": "重新索引", - "xpack.upgradeAssistant.checkupTab.tabDetail": "您需要注意这些 {strongCheckupLabel} 问题。在升级到 Elasticsearch {nextEsVersion} 之前先解决它们。", - "xpack.upgradeAssistant.forbiddenErrorCallout.calloutTitle": "您没有足够的权限来查看此页。", - "xpack.upgradeAssistant.genericErrorCallout.calloutTitle": "检索检查结果时出错。", - "xpack.upgradeAssistant.overviewTab.overviewTabTitle": "概览", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.issuesRemainingStepTitle": "检查集群是否存在问题", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.noIssuesRemainingStepTitle": "您的集群设置已就绪", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.noRemainingIssuesLabel": "没有其余已弃用设置。", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.remainingIssuesDetail": "必须解决 {numIssues} 个问题。", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.todo.clusterTabButtonLabel": "“集群”选项卡", - "xpack.upgradeAssistant.overviewTab.steps.clusterStep.todo.todoDetail": "转到 {clusterTabButton} 并更新已弃用的设置。", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.deprecationLogs.deprecationLogsDocButtonLabel": "弃用日志", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.deprecationLogs.logsDetail": "请参阅{deprecationLogsDocButton}，了解您的应用程序是否使用未在 {nextEsVersion} 中提供的功能。您可能需要启用弃用日志。", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingLabel": "是否启用弃用日志？", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.disabledLabel": "关闭", "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.enabledLabel": "开启", "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.errorLabel": "无法加载日志状态", - "xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.stepTitle": "查看 Elasticsearch 弃用日志", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.issuesRemainingStepTitle": "检查索引是否存在问题", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.noIssuesRemainingStepTitle": "您的索引设置已就绪", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.noRemainingIssuesLabel": "没有其余已弃用设置。", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.remainingIssuesDetail": "必须解决 {numIssues} 个问题。", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.todo.indicesTabButtonLabel": "“索引”选项卡", - "xpack.upgradeAssistant.overviewTab.steps.indicesStep.todo.todoDetail": "转到 {indicesTabButton} 并更新已弃用的设置。", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStep.stepTitle": "开始升级", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStepCloud.stepDetail.goToCloudDashboardDetail": "转到 Elastic Cloud 仪表板上的“部署”部分开始升级。", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStepOnPrem.stepDetail.followInstructionsDetail": "按照 {instructionButton} 开始升级。", - "xpack.upgradeAssistant.overviewTab.steps.startUpgradeStepOnPrem.stepDetail.instructionButtonLabel": "以下说明", - "xpack.upgradeAssistant.overviewTab.steps.waitForReleaseStep.stepDetail": "版本发布后，请升级到最新的 {currentEsMajorVersion} 版本，然后返回此处，继续升级到 {nextEsMajorVersion}。", - "xpack.upgradeAssistant.overviewTab.steps.waitForReleaseStep.stepTitle": "等待 Elasticsearch {nextEsVersion} 发布版", - "xpack.upgradeAssistant.overviewTab.tabDetail": "此助理将帮助您为 Elasticsearch {nextEsVersion} 准备集群和索引。有关需要注意的其他问题，请参阅 Elasticsearch 日志。", "xpack.upgradeAssistant.reindex.reindexPrivilegesErrorBatch": "您没有足够的权限重新索引“{indexName}”。", - "xpack.upgradeAssistant.tabs.checkupTab.clusterLabel": "集群", "xpack.upgradeAssistant.tabs.incompleteCallout.calloutBody.breackingChangesDocButtonLabel": "弃用内容和重大更改", "xpack.upgradeAssistant.tabs.incompleteCallout.calloutBody.calloutDetail": "Elasticsearch {nextEsVersion} 中的 {breakingChangesDocButton} 完整列表将在最终的 {currentEsVersion} 次要版本中提供。完成列表后，此警告将消失。", "xpack.upgradeAssistant.tabs.incompleteCallout.calloutTitle": "问题列表可能不完整", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradeCompleteDescription": "所有 Elasticsearch 节点已升级。可以现在升级 Kibana。", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradeCompleteTitle": "您的集群已升级", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradingDescription": "一个或多个 Elasticsearch 节点的 Elasticsearch 版本比 Kibana 版本新。所有节点升级后，请升级 Kibana。", - "xpack.upgradeAssistant.tabs.upgradingInterstitial.upgradingTitle": "您的集群正在升级", "xpack.uptime.addDataButtonLabel": "添加数据", "xpack.uptime.alerts.anomaly.criteriaExpression.ariaLabel": "显示选定监测的条件的表达式。", "xpack.uptime.alerts.anomaly.criteriaExpression.description": "当监测", @@ -23491,7 +23437,6 @@ "xpack.uptime.synthetics.waterfall.resource.externalLink": "在新选项卡中打开资源", "xpack.uptime.synthetics.waterfall.searchBox.placeholder": "筛选网络请求", "xpack.uptime.synthetics.waterfall.sidebar.filterMatchesScreenReaderLabel": "资源匹配筛选", - "xpack.uptime.synthetics.waterfallChart.labels.metadata.bytesDownloadedCompressed": "已下载字节 (压缩) ", "xpack.uptime.synthetics.waterfallChart.labels.metadata.certificateExpiryDate": "失效日期", "xpack.uptime.synthetics.waterfallChart.labels.metadata.certificateIssueDate": "有效起始日期", "xpack.uptime.synthetics.waterfallChart.labels.metadata.certificateIssuer": "颁发者", @@ -23907,4 +23852,4 @@ "xpack.watcher.watchEdit.thresholdWatchExpression.aggType.fieldIsRequiredValidationMessage": "此字段必填。", "xpack.watcher.watcherDescription": "通过创建、管理和监测警报来检测数据中的更改。" } -} +} \ No newline at end of file diff --git a/x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_query.ts b/x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_query.ts index 98212f1dc6aa..ad044f4570ea 100644 --- a/x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_query.ts +++ b/x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_query.ts @@ -7,6 +7,7 @@ import type { estypes } from '@elastic/elasticsearch'; import { Logger, ElasticsearchClient } from 'kibana/server'; +import { getEsErrorMessage } from '../../../../alerting/server'; import { DEFAULT_GROUPS } from '../index'; import { getDateRangeInfo } from './date_range_info'; @@ -137,7 +138,7 @@ export async function timeSeriesQuery( esResult = (await esClient.search(esQuery, { ignore: [404] })).body; } catch (err) { // console.log('time_series_query.ts error\n', JSON.stringify(err, null, 4)); - logger.warn(`${logPrefix} error: ${err.message}`); + logger.warn(`${logPrefix} error: ${getEsErrorMessage(err)}`); return { results: [] }; } diff --git a/x-pack/plugins/upgrade_assistant/kibana.json b/x-pack/plugins/upgrade_assistant/kibana.json index eda624dc4224..d9f4917fa0a6 100644 --- a/x-pack/plugins/upgrade_assistant/kibana.json +++ b/x-pack/plugins/upgrade_assistant/kibana.json @@ -6,5 +6,5 @@ "configPath": ["xpack", "upgrade_assistant"], "requiredPlugins": ["management", "licensing", "features"], "optionalPlugins": ["cloud", "usageCollection"], - "requiredBundles": ["esUiShared"] + "requiredBundles": ["esUiShared", "kibanaReact"] } diff --git a/x-pack/plugins/upgrade_assistant/public/application/app.tsx b/x-pack/plugins/upgrade_assistant/public/application/app.tsx index 1276198a528d..7be723e335e8 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/app.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/app.tsx @@ -6,19 +6,48 @@ */ import React from 'react'; -import { I18nStart } from 'src/core/public'; -import { AppContextProvider, ContextValue } from './app_context'; -import { PageContent } from './components/page_content'; +import { Router, Switch, Route, Redirect } from 'react-router-dom'; +import { I18nStart, ScopedHistory } from 'src/core/public'; +import { AppContextProvider, ContextValue, useAppContext } from './app_context'; +import { ComingSoonPrompt } from './components/coming_soon_prompt'; +import { EsDeprecationsContent } from './components/es_deprecations'; +import { DeprecationsOverview } from './components/overview'; export interface AppDependencies extends ContextValue { i18n: I18nStart; + history: ScopedHistory; } -export const RootComponent = ({ i18n, ...contextValue }: AppDependencies) => { +const App: React.FunctionComponent = () => { + const { isReadOnlyMode } = useAppContext(); + + // Read-only mode will be enabled up until the last minor before the next major release + if (isReadOnlyMode) { + return ; + } + + return ( + + + + + + ); +}; + +export const AppWithRouter = ({ history }: { history: ScopedHistory }) => { + return ( + + + + ); +}; + +export const RootComponent = ({ i18n, history, ...contextValue }: AppDependencies) => { return ( - + ); diff --git a/x-pack/plugins/upgrade_assistant/public/application/app_context.tsx b/x-pack/plugins/upgrade_assistant/public/application/app_context.tsx index 2b49d1a5bca1..18df47d4cbd4 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/app_context.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/app_context.tsx @@ -5,9 +5,10 @@ * 2.0. */ -import { DocLinksStart, HttpSetup, NotificationsStart } from 'src/core/public'; +import { CoreStart, DocLinksStart, HttpSetup, NotificationsStart } from 'src/core/public'; import React, { createContext, useContext } from 'react'; import { ApiService } from './lib/api'; +import { BreadcrumbService } from './lib/breadcrumbs'; export interface KibanaVersionContext { currentMajor: number; @@ -23,6 +24,8 @@ export interface ContextValue { notifications: NotificationsStart; isReadOnlyMode: boolean; api: ApiService; + breadcrumbs: BreadcrumbService; + getUrlForApp: CoreStart['application']['getUrlForApp']; } export const AppContext = createContext({} as any); diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/error_banner.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/error_banner.tsx deleted file mode 100644 index 72e6c5c0702a..000000000000 --- a/x-pack/plugins/upgrade_assistant/public/application/components/error_banner.tsx +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React from 'react'; - -import { EuiCallOut } from '@elastic/eui'; -import { FormattedMessage } from '@kbn/i18n/react'; - -import { UpgradeAssistantTabProps } from './types'; - -export const LoadingErrorBanner: React.FunctionComponent< - Pick -> = ({ loadingError }) => { - if (loadingError?.statusCode === 403) { - return ( - - } - color="danger" - iconType="cross" - data-test-subj="permissionsError" - /> - ); - } - - return ( - - } - color="danger" - iconType="cross" - data-test-subj="upgradeStatusError" - > - {loadingError ? loadingError.message : null} - - ); -}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/__snapshots__/filter_bar.test.tsx.snap b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/__snapshots__/filter_bar.test.tsx.snap index da9153f4a6c8..b88886b36416 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/__snapshots__/filter_bar.test.tsx.snap +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/__snapshots__/filter_bar.test.tsx.snap @@ -6,20 +6,22 @@ exports[`FilterBar renders 1`] = ` > - all + critical - critical + warning diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_tab.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_tab.tsx deleted file mode 100644 index a5ae341f1e42..000000000000 --- a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_tab.tsx +++ /dev/null @@ -1,222 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { find } from 'lodash'; -import React, { FunctionComponent, useState } from 'react'; - -import { - EuiCallOut, - EuiEmptyPrompt, - EuiLink, - EuiPageContent, - EuiPageContentBody, - EuiSpacer, - EuiText, -} from '@elastic/eui'; -import { FormattedMessage } from '@kbn/i18n/react'; - -import { LoadingErrorBanner } from '../error_banner'; -import { useAppContext } from '../../app_context'; -import { GroupByOption, LevelFilterOption, UpgradeAssistantTabProps } from '../types'; -import { CheckupControls } from './controls'; -import { GroupedDeprecations } from './deprecations/grouped'; - -export interface CheckupTabProps extends UpgradeAssistantTabProps { - checkupLabel: string; - showBackupWarning?: boolean; -} - -/** - * Displays a list of deprecations that filterable and groupable. Can be used for cluster, - * nodes, or indices checkups. - */ -export const DeprecationTab: FunctionComponent = ({ - alertBanner, - checkupLabel, - deprecations, - loadingError, - isLoading, - refreshCheckupData, - setSelectedTabIndex, - showBackupWarning = false, -}) => { - const [currentFilter, setCurrentFilter] = useState(LevelFilterOption.all); - const [search, setSearch] = useState(''); - const [currentGroupBy, setCurrentGroupBy] = useState(GroupByOption.message); - - const { docLinks, kibanaVersionInfo } = useAppContext(); - - const { DOC_LINK_VERSION, ELASTIC_WEBSITE_URL } = docLinks; - const esDocBasePath = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}`; - - const { nextMajor } = kibanaVersionInfo; - - const changeFilter = (filter: LevelFilterOption) => { - setCurrentFilter(filter); - }; - - const changeSearch = (newSearch: string) => { - setSearch(newSearch); - }; - - const changeGroupBy = (groupBy: GroupByOption) => { - setCurrentGroupBy(groupBy); - }; - - const availableGroupByOptions = () => { - if (!deprecations) { - return []; - } - - return Object.keys(GroupByOption).filter((opt) => find(deprecations, opt)) as GroupByOption[]; - }; - - const renderCheckupData = () => { - return ( - - ); - }; - - return ( - <> - - -

- {checkupLabel}, - nextEsVersion: `${nextMajor}.x`, - }} - /> -

- - - - - {alertBanner && ( - <> - {alertBanner} - - - )} - - {showBackupWarning && ( - <> - - } - color="warning" - iconType="help" - > -

- - - - ), - }} - /> -

- - - - )} - - - - {loadingError ? ( - - ) : deprecations && deprecations.length > 0 ? ( -
- - - {renderCheckupData()} -
- ) : ( - - - - } - body={ - <> -

- {checkupLabel}, - }} - /> -

-

- setSelectedTabIndex(0)}> - - - ), - }} - /> -

- - } - /> - )} - - - - ); -}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_tab_content.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_tab_content.tsx new file mode 100644 index 000000000000..9e8678fea0eb --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_tab_content.tsx @@ -0,0 +1,138 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { find } from 'lodash'; +import React, { FunctionComponent, useState } from 'react'; + +import { EuiEmptyPrompt, EuiLink, EuiSpacer } from '@elastic/eui'; +import { FormattedMessage } from '@kbn/i18n/react'; +import { i18n } from '@kbn/i18n'; + +import { SectionLoading } from '../../../shared_imports'; +import { GroupByOption, LevelFilterOption, UpgradeAssistantTabProps } from '../types'; +import { CheckupControls } from './controls'; +import { GroupedDeprecations } from './deprecations/grouped'; +import { EsDeprecationErrors } from './es_deprecation_errors'; + +const i18nTexts = { + isLoading: i18n.translate('xpack.upgradeAssistant.esDeprecations.loadingText', { + defaultMessage: 'Loading deprecations…', + }), +}; + +export interface CheckupTabProps extends UpgradeAssistantTabProps { + checkupLabel: string; +} + +/** + * Displays a list of deprecations that are filterable and groupable. Can be used for cluster, + * nodes, or indices deprecations. + */ +export const DeprecationTabContent: FunctionComponent = ({ + checkupLabel, + deprecations, + error, + isLoading, + refreshCheckupData, + navigateToOverviewPage, +}) => { + const [currentFilter, setCurrentFilter] = useState(LevelFilterOption.all); + const [search, setSearch] = useState(''); + const [currentGroupBy, setCurrentGroupBy] = useState(GroupByOption.message); + + const availableGroupByOptions = () => { + if (!deprecations) { + return []; + } + + return Object.keys(GroupByOption).filter((opt) => find(deprecations, opt)) as GroupByOption[]; + }; + + if (deprecations && deprecations.length === 0) { + return ( + + + + } + body={ + <> +

+ +

+

+ + + + ), + }} + /> +

+ + } + /> + ); + } + + let content: React.ReactNode; + + if (isLoading) { + content = {i18nTexts.isLoading}; + } else if (deprecations?.length) { + content = ( +
+ + + + + +
+ ); + } else if (error) { + content = ; + } + + return ( +
+ + + {content} +
+ ); +}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecation_errors.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecation_errors.tsx new file mode 100644 index 000000000000..239433808c5a --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecation_errors.tsx @@ -0,0 +1,50 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { EuiCallOut } from '@elastic/eui'; + +import { ResponseError } from '../../lib/api'; +import { getEsDeprecationError } from '../../lib/es_deprecation_errors'; +interface Props { + error: ResponseError; +} + +export const EsDeprecationErrors: React.FunctionComponent = ({ error }) => { + const { code: errorType, message } = getEsDeprecationError(error); + + switch (errorType) { + case 'unauthorized_error': + return ( + + ); + case 'partially_upgraded_error': + return ( + + ); + case 'upgraded_error': + return ; + case 'request_error': + default: + return ( + + {error.message} + + ); + } +}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecations.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecations.tsx new file mode 100644 index 000000000000..0da4a4877a7e --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecations.tsx @@ -0,0 +1,212 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useMemo, useEffect, useState } from 'react'; +import { withRouter, RouteComponentProps } from 'react-router-dom'; + +import { + EuiButton, + EuiButtonEmpty, + EuiPageBody, + EuiPageHeader, + EuiTabbedContent, + EuiTabbedContentTab, + EuiPageContent, + EuiPageContentBody, + EuiToolTip, + EuiNotificationBadge, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +import { useAppContext } from '../../app_context'; +import { UpgradeAssistantTabProps, EsTabs, TelemetryState } from '../types'; +import { DeprecationTabContent } from './deprecation_tab_content'; + +const i18nTexts = { + pageTitle: i18n.translate('xpack.upgradeAssistant.esDeprecations.pageTitle', { + defaultMessage: 'Elasticsearch', + }), + pageDescription: i18n.translate('xpack.upgradeAssistant.esDeprecations.pageDescription', { + defaultMessage: + 'Review the deprecated cluster and index settings. You must resolve any critical issues before upgrading.', + }), + docLinkText: i18n.translate('xpack.upgradeAssistant.esDeprecations.docLinkText', { + defaultMessage: 'Documentation', + }), + backupDataButton: { + label: i18n.translate('xpack.upgradeAssistant.esDeprecations.backupDataButtonLabel', { + defaultMessage: 'Back up your data', + }), + tooltipText: i18n.translate('xpack.upgradeAssistant.esDeprecations.backupDataTooltipText', { + defaultMessage: 'Take a snapshot before you make any changes.', + }), + }, + clusterTab: { + tabName: i18n.translate('xpack.upgradeAssistant.esDeprecations.clusterTabLabel', { + defaultMessage: 'Cluster', + }), + deprecationType: i18n.translate('xpack.upgradeAssistant.esDeprecations.clusterLabel', { + defaultMessage: 'cluster', + }), + }, + indicesTab: { + tabName: i18n.translate('xpack.upgradeAssistant.esDeprecations.indicesTabLabel', { + defaultMessage: 'Indices', + }), + deprecationType: i18n.translate('xpack.upgradeAssistant.esDeprecations.indexLabel', { + defaultMessage: 'index', + }), + }, +}; + +interface MatchParams { + tabName: EsTabs; +} + +export const EsDeprecationsContent = withRouter( + ({ + match: { + params: { tabName }, + }, + history, + }: RouteComponentProps) => { + const [telemetryState, setTelemetryState] = useState(TelemetryState.Complete); + + const { api, breadcrumbs, getUrlForApp, docLinks } = useAppContext(); + + const { data: checkupData, isLoading, error, resendRequest } = api.useLoadUpgradeStatus(); + + const onTabClick = (selectedTab: EuiTabbedContentTab) => { + history.push(`/es_deprecations/${selectedTab.id}`); + }; + + const tabs = useMemo(() => { + const commonTabProps: UpgradeAssistantTabProps = { + error, + isLoading, + refreshCheckupData: resendRequest, + navigateToOverviewPage: () => history.push('/overview'), + }; + + return [ + { + id: 'cluster', + 'data-test-subj': 'upgradeAssistantClusterTab', + name: ( + + {i18nTexts.clusterTab.tabName} + {checkupData && checkupData.cluster.length > 0 && ( + <> + {' '} + {checkupData.cluster.length} + + )} + + ), + content: ( + + ), + }, + { + id: 'indices', + 'data-test-subj': 'upgradeAssistantIndicesTab', + name: ( + + {i18nTexts.indicesTab.tabName} + {checkupData && checkupData.indices.length > 0 && ( + <> + {' '} + {checkupData.indices.length} + + )} + + ), + content: ( + + ), + }, + ]; + }, [checkupData, error, history, isLoading, resendRequest]); + + useEffect(() => { + breadcrumbs.setBreadcrumbs('esDeprecations'); + }, [breadcrumbs]); + + useEffect(() => { + if (isLoading === false) { + setTelemetryState(TelemetryState.Running); + + async function sendTelemetryData() { + await api.sendTelemetryData({ + [tabName]: true, + }); + setTelemetryState(TelemetryState.Complete); + } + + sendTelemetryData(); + } + }, [api, tabName, isLoading]); + + return ( + + + + {i18nTexts.docLinkText} + , + ]} + > + + + {i18nTexts.backupDataButton.label} + + + + + + tab.id === tabName)} + /> + + + + ); + } +); diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.test.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.test.tsx index feac88cf4a52..4888efda97bd 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.test.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.test.tsx @@ -17,7 +17,7 @@ const defaultProps = { { level: LevelFilterOption.critical }, { level: LevelFilterOption.critical }, ] as DeprecationInfo[], - currentFilter: LevelFilterOption.critical, + currentFilter: LevelFilterOption.all, onFilterChange: jest.fn(), }; @@ -28,7 +28,7 @@ describe('FilterBar', () => { test('clicking button calls onFilterChange', () => { const wrapper = mount(); - wrapper.find('button.euiFilterButton-hasActiveFilters').simulate('click'); + wrapper.find('button[data-test-subj="criticalLevelFilter"]').simulate('click'); expect(defaultProps.onFilterChange).toHaveBeenCalledTimes(1); expect(defaultProps.onFilterChange.mock.calls[0][0]).toEqual(LevelFilterOption.critical); }); diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.tsx index 7ef3ae2fc933..848ac3b14a81 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/filter_bar.tsx @@ -15,17 +15,18 @@ import { DeprecationInfo } from '../../../../common/types'; import { LevelFilterOption } from '../types'; const LocalizedOptions: { [option: string]: string } = { - all: i18n.translate('xpack.upgradeAssistant.checkupTab.controls.filterBar.allButtonLabel', { - defaultMessage: 'all', - }), + warning: i18n.translate( + 'xpack.upgradeAssistant.checkupTab.controls.filterBar.warningButtonLabel', + { + defaultMessage: 'warning', + } + ), critical: i18n.translate( 'xpack.upgradeAssistant.checkupTab.controls.filterBar.criticalButtonLabel', { defaultMessage: 'critical' } ), }; -const allFilterOptions = Object.keys(LevelFilterOption) as LevelFilterOption[]; - interface FilterBarProps { allDeprecations?: DeprecationInfo[]; currentFilter: LevelFilterOption; @@ -43,23 +44,40 @@ export const FilterBar: React.FunctionComponent = ({ return counts; }, {} as { [level: string]: number }); - const allCount = allDeprecations.length; - return ( - {allFilterOptions.map((option) => ( - - {LocalizedOptions[option]} - - ))} + { + onFilterChange( + currentFilter !== LevelFilterOption.critical + ? LevelFilterOption.critical + : LevelFilterOption.all + ); + }} + hasActiveFilters={currentFilter === LevelFilterOption.critical} + numFilters={levelCounts[LevelFilterOption.critical] || undefined} + data-test-subj="criticalLevelFilter" + > + {LocalizedOptions[LevelFilterOption.critical]} + + { + onFilterChange( + currentFilter !== LevelFilterOption.warning + ? LevelFilterOption.warning + : LevelFilterOption.all + ); + }} + hasActiveFilters={currentFilter === LevelFilterOption.warning} + numFilters={levelCounts[LevelFilterOption.warning] || undefined} + data-test-subj="warningLevelFilter" + > + {LocalizedOptions[LevelFilterOption.warning]} + ); diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/index.ts b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/index.ts index 8b7435b94b2c..0e69259adc60 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/index.ts +++ b/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/index.ts @@ -5,4 +5,4 @@ * 2.0. */ -export { DeprecationTab } from './deprecation_tab'; +export { EsDeprecationsContent } from './es_deprecations'; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/overview/deprecation_logging_toggle.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/overview/deprecation_logging_toggle.tsx index 5ed46c25ecf1..6be7793f0bd4 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/overview/deprecation_logging_toggle.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/components/overview/deprecation_logging_toggle.tsx @@ -13,8 +13,35 @@ import { i18n } from '@kbn/i18n'; import { useAppContext } from '../../app_context'; import { ResponseError } from '../../lib/api'; +const i18nTexts = { + toggleErrorLabel: i18n.translate( + 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.errorLabel', + { + defaultMessage: 'Could not load logging state', + } + ), + toggleLabel: i18n.translate( + 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.enabledLabel', + { + defaultMessage: 'Enable deprecation logging', + } + ), + enabledMessage: i18n.translate( + 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.enabledToastMessage', + { + defaultMessage: 'Log deprecated actions.', + } + ), + disabledMessage: i18n.translate( + 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.disabledToastMessage', + { + defaultMessage: 'Do not log deprecated actions.', + } + ), +}; + export const DeprecationLoggingToggle: React.FunctionComponent = () => { - const { api } = useAppContext(); + const { api, notifications } = useAppContext(); const [isEnabled, setIsEnabled] = useState(true); const [isLoading, setIsLoading] = useState(false); @@ -44,27 +71,10 @@ export const DeprecationLoggingToggle: React.FunctionComponent = () => { const renderLoggingState = () => { if (error) { - return i18n.translate( - 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.errorLabel', - { - defaultMessage: 'Could not load logging state', - } - ); - } else if (isEnabled) { - return i18n.translate( - 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.enabledLabel', - { - defaultMessage: 'On', - } - ); - } else { - return i18n.translate( - 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.enableDeprecationLoggingToggleSwitch.disabledLabel', - { - defaultMessage: 'Off', - } - ); + return i18nTexts.toggleErrorLabel; } + + return i18nTexts.toggleLabel; }; const toggleLogging = async () => { @@ -82,6 +92,9 @@ export const DeprecationLoggingToggle: React.FunctionComponent = () => { setError(updateError); } else if (data) { setIsEnabled(data.isEnabled); + notifications.toasts.addSuccess( + data.isEnabled ? i18nTexts.enabledMessage : i18nTexts.disabledMessage + ); } }; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/overview/es_stats.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/overview/es_stats.tsx new file mode 100644 index 000000000000..51a66bdd3539 --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/components/overview/es_stats.tsx @@ -0,0 +1,129 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FunctionComponent } from 'react'; + +import { + EuiLink, + EuiPanel, + EuiStat, + EuiTitle, + EuiSpacer, + EuiFlexGroup, + EuiFlexItem, + EuiIconTip, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +import { RouteComponentProps } from 'react-router-dom'; +import { reactRouterNavigate } from '../../../../../../../src/plugins/kibana_react/public'; +import { useAppContext } from '../../app_context'; +import { EsStatsErrors } from './es_stats_error'; + +const i18nTexts = { + statsTitle: i18n.translate('xpack.upgradeAssistant.esDeprecationStats.statsTitle', { + defaultMessage: 'Elasticsearch', + }), + totalDeprecationsTitle: i18n.translate( + 'xpack.upgradeAssistant.esDeprecationStats.totalDeprecationsTitle', + { + defaultMessage: 'Deprecations', + } + ), + criticalDeprecationsTitle: i18n.translate( + 'xpack.upgradeAssistant.esDeprecationStats.criticalDeprecationsTitle', + { + defaultMessage: 'Critical', + } + ), + viewDeprecationsLink: i18n.translate( + 'xpack.upgradeAssistant.esDeprecationStats.viewDeprecationsLinkText', + { + defaultMessage: 'View deprecations', + } + ), + getTotalDeprecationsTooltip: (clusterCount: number, indexCount: number) => + i18n.translate('xpack.upgradeAssistant.esDeprecationStats.totalDeprecationsTooltip', { + defaultMessage: + 'This cluster is using {clusterCount} deprecated cluster settings and {indexCount} deprecated index settings', + values: { + clusterCount, + indexCount, + }, + }), +}; + +interface Props { + history: RouteComponentProps['history']; +} + +export const ESDeprecationStats: FunctionComponent = ({ history }) => { + const { api } = useAppContext(); + + const { data: esDeprecations, isLoading, error } = api.useLoadUpgradeStatus(); + + const allDeprecations = esDeprecations?.cluster?.concat(esDeprecations?.indices) ?? []; + const criticalDeprecations = allDeprecations.filter( + (deprecation) => deprecation.level === 'critical' + ); + + return ( + + + + +

{i18nTexts.statsTitle}

+ + + + + {i18nTexts.viewDeprecationsLink} + + + + + + + + + + {i18nTexts.totalDeprecationsTitle}{' '} + + + } + isLoading={isLoading} + /> + + + + + {error && } + + + + + ); +}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/overview/es_stats_error.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/overview/es_stats_error.tsx new file mode 100644 index 000000000000..dda7d16599e0 --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/components/overview/es_stats_error.tsx @@ -0,0 +1,84 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { EuiIconTip, EuiSpacer } from '@elastic/eui'; +import { ResponseError } from '../../lib/api'; +import { getEsDeprecationError } from '../../lib/es_deprecation_errors'; + +interface Props { + error: ResponseError; +} + +export const EsStatsErrors: React.FunctionComponent = ({ error }) => { + let iconContent: React.ReactNode; + + const { code: errorType, message } = getEsDeprecationError(error); + + switch (errorType) { + case 'unauthorized_error': + iconContent = ( + + ); + break; + case 'partially_upgraded_error': + iconContent = ( + + ); + break; + case 'upgraded_error': + iconContent = ( + + ); + break; + case 'request_error': + default: + iconContent = ( + + ); + } + + return ( + <> + + {iconContent} + + ); +}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/overview/index.ts b/x-pack/plugins/upgrade_assistant/public/application/components/overview/index.ts index c43c1415f6f7..a64d7b0d4491 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/overview/index.ts +++ b/x-pack/plugins/upgrade_assistant/public/application/components/overview/index.ts @@ -5,4 +5,4 @@ * 2.0. */ -export { OverviewTab } from './overview'; +export { DeprecationsOverview } from './overview'; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/overview/overview.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/overview/overview.tsx index 01677e7394a8..0784fbc10280 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/overview/overview.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/components/overview/overview.tsx @@ -5,70 +5,133 @@ * 2.0. */ -import React, { FunctionComponent } from 'react'; +import React, { FunctionComponent, useEffect } from 'react'; import { - EuiFlexGroup, - EuiFlexItem, - EuiLoadingSpinner, EuiPageContent, EuiPageContentBody, - EuiSpacer, EuiText, + EuiPageHeader, + EuiPageBody, + EuiButtonEmpty, + EuiFlexItem, + EuiFlexGroup, + EuiSpacer, + EuiLink, + EuiFormRow, } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n/react'; +import { RouteComponentProps } from 'react-router-dom'; import { useAppContext } from '../../app_context'; -import { LoadingErrorBanner } from '../error_banner'; -import { UpgradeAssistantTabProps } from '../types'; -import { Steps } from './steps'; +import { LatestMinorBanner } from '../latest_minor_banner'; +import { ESDeprecationStats } from './es_stats'; +import { DeprecationLoggingToggle } from './deprecation_logging_toggle'; -export const OverviewTab: FunctionComponent = (props) => { - const { kibanaVersionInfo } = useAppContext(); +const i18nTexts = { + pageTitle: i18n.translate('xpack.upgradeAssistant.pageTitle', { + defaultMessage: 'Upgrade Assistant', + }), + getPageDescription: (nextMajor: string) => + i18n.translate('xpack.upgradeAssistant.pageDescription', { + defaultMessage: + 'Prepare to upgrade by identifying deprecated settings and updating your configuration. Enable deprecation logging to see if your are using deprecated features that will not be available after you upgrade to Elastic {nextMajor}.', + values: { + nextMajor, + }, + }), + getDeprecationLoggingLabel: (href: string) => ( + + {i18n.translate('xpack.upgradeAssistant.deprecationLoggingDescription.learnMoreLink', { + defaultMessage: 'Learn more.', + })} + + ), + }} + /> + ), + docLink: i18n.translate('xpack.upgradeAssistant.documentationLinkText', { + defaultMessage: 'Documentation', + }), +}; + +interface Props { + history: RouteComponentProps['history']; +} + +export const DeprecationsOverview: FunctionComponent = ({ history }) => { + const { kibanaVersionInfo, breadcrumbs, docLinks, api } = useAppContext(); const { nextMajor } = kibanaVersionInfo; + useEffect(() => { + async function sendTelemetryData() { + await api.sendTelemetryData({ + overview: true, + }); + } + + sendTelemetryData(); + }, [api]); + + useEffect(() => { + breadcrumbs.setBreadcrumbs('overview'); + }, [breadcrumbs]); + return ( - <> - - - -

- -

- - - - - {props.alertBanner && ( - <> - {props.alertBanner} - - - - )} - - + + + + {i18nTexts.docLink} + , + ]} + /> + - {props.isLoading && ( - - - - - - )} + <> + +

{i18nTexts.getPageDescription(`${nextMajor}.x`)}

+ + + - {props.checkupData && } + {/* Remove this in last minor of the current major (e.g., 7.15) */} + - {props.loadingError && } + + + + + + + + + + + + + + - + ); }; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/overview/steps.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/overview/steps.tsx deleted file mode 100644 index 095960ae9356..000000000000 --- a/x-pack/plugins/upgrade_assistant/public/application/components/overview/steps.tsx +++ /dev/null @@ -1,293 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { Fragment, FunctionComponent } from 'react'; - -import { - EuiFormRow, - EuiLink, - EuiNotificationBadge, - EuiSpacer, - // @ts-ignore - EuiStat, - EuiSteps, - EuiText, -} from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { FormattedMessage } from '@kbn/i18n/react'; - -import { useAppContext } from '../../app_context'; -import { UpgradeAssistantTabProps } from '../types'; -import { DeprecationLoggingToggle } from './deprecation_logging_toggle'; - -// Leaving these here even if unused so they are picked up for i18n static analysis -// Keep this until last minor release (when next major is also released). -const WAIT_FOR_RELEASE_STEP = (majorVersion: number, nextMajorVersion: number) => ({ - title: i18n.translate('xpack.upgradeAssistant.overviewTab.steps.waitForReleaseStep.stepTitle', { - defaultMessage: 'Wait for the Elasticsearch {nextEsVersion} release', - values: { - nextEsVersion: `${nextMajorVersion}.0`, - }, - }), - 'data-test-subj': 'waitForReleaseStep', - children: ( - <> - -

- -

- - - ), -}); - -// Swap in this step for the one above it on the last minor release. -// @ts-ignore -const START_UPGRADE_STEP = (isCloudEnabled: boolean, esDocBasePath: string) => ({ - title: i18n.translate('xpack.upgradeAssistant.overviewTab.steps.startUpgradeStep.stepTitle', { - defaultMessage: 'Start your upgrade', - }), - 'data-test-subj': 'startUpgradeStep', - children: ( - - -

- {isCloudEnabled ? ( - - ) : ( - - - - ), - }} - /> - )} -

- - - ), -}); - -export const Steps: FunctionComponent = ({ - checkupData, - setSelectedTabIndex, -}) => { - const checkupDataTyped = (checkupData! as unknown) as { [checkupType: string]: any[] }; - const countByType = Object.keys(checkupDataTyped).reduce((counts, checkupType) => { - counts[checkupType] = checkupDataTyped[checkupType].length; - return counts; - }, {} as { [checkupType: string]: number }); - - // Uncomment when START_UPGRADE_STEP is in use! - const { kibanaVersionInfo, docLinks /* , isCloudEnabled */ } = useAppContext(); - - const { DOC_LINK_VERSION, ELASTIC_WEBSITE_URL } = docLinks; - const esDocBasePath = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}`; - - const { currentMajor, nextMajor } = kibanaVersionInfo; - - return ( - - {countByType.cluster ? ( - -

- setSelectedTabIndex(1)}> - - - ), - }} - /> -

-

- {countByType.cluster} - ), - }} - /> -

- - ) : ( -

- -

- )} - - ), - }, - { - title: countByType.indices - ? i18n.translate( - 'xpack.upgradeAssistant.overviewTab.steps.indicesStep.issuesRemainingStepTitle', - { - defaultMessage: 'Check for issues with your indices', - } - ) - : i18n.translate( - 'xpack.upgradeAssistant.overviewTab.steps.indicesStep.noIssuesRemainingStepTitle', - { - defaultMessage: 'Your index settings are ready', - } - ), - status: countByType.indices ? 'warning' : 'complete', - 'data-test-subj': 'indicesIssuesStep', - children: ( - - {countByType.indices ? ( - -

- setSelectedTabIndex(2)}> - - - ), - }} - /> -

-

- {countByType.indices} - ), - }} - /> -

- - ) : ( -

- -

- )} - - ), - }, - { - title: i18n.translate( - 'xpack.upgradeAssistant.overviewTab.steps.deprecationLogsStep.stepTitle', - { - defaultMessage: 'Review the Elasticsearch deprecation logs', - } - ), - 'data-test-subj': 'deprecationLoggingStep', - children: ( - - -

- - - - ), - nextEsVersion: `${nextMajor}.0`, - }} - /> -

- - - - - - - - - ), - }, - - // Swap in START_UPGRADE_STEP on the last minor release. - WAIT_FOR_RELEASE_STEP(currentMajor, nextMajor), - // START_UPGRADE_STEP(isCloudEnabled, esDocBasePath), - ]} - /> - ); -}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/page_content.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/page_content.tsx deleted file mode 100644 index db515f0c123a..000000000000 --- a/x-pack/plugins/upgrade_assistant/public/application/components/page_content.tsx +++ /dev/null @@ -1,44 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React from 'react'; -import { EuiPageHeader, EuiPageHeaderSection, EuiTitle } from '@elastic/eui'; -import { FormattedMessage } from '@kbn/i18n/react'; - -import { useAppContext } from '../app_context'; -import { ComingSoonPrompt } from './coming_soon_prompt'; -import { UpgradeAssistantTabs } from './tabs'; - -export const PageContent: React.FunctionComponent = () => { - const { kibanaVersionInfo, isReadOnlyMode } = useAppContext(); - const { nextMajor } = kibanaVersionInfo; - - // Read-only mode will be enabled up until the last minor before the next major release - if (isReadOnlyMode) { - return ; - } - - return ( - <> - - - -

- -

- - - - - - - ); -}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/tabs.tsx b/x-pack/plugins/upgrade_assistant/public/application/components/tabs.tsx deleted file mode 100644 index 231d9705bd0d..000000000000 --- a/x-pack/plugins/upgrade_assistant/public/application/components/tabs.tsx +++ /dev/null @@ -1,184 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { findIndex } from 'lodash'; -import React, { useEffect, useState, useMemo } from 'react'; - -import { - EuiEmptyPrompt, - EuiPageContent, - EuiPageContentBody, - EuiTabbedContent, - EuiTabbedContentTab, -} from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { FormattedMessage } from '@kbn/i18n/react'; - -import { LatestMinorBanner } from './latest_minor_banner'; -import { DeprecationTab } from './es_deprecations'; -import { OverviewTab } from './overview'; -import { TelemetryState, UpgradeAssistantTabProps } from './types'; -import { useAppContext } from '../app_context'; - -export const UpgradeAssistantTabs: React.FunctionComponent = () => { - const [selectedTabIndex, setSelectedTabIndex] = useState(0); - const [telemetryState, setTelemetryState] = useState(TelemetryState.Complete); - - const { api } = useAppContext(); - - const { data: checkupData, isLoading, error, resendRequest } = api.useLoadUpgradeStatus(); - - const tabs = useMemo(() => { - const commonTabProps: UpgradeAssistantTabProps = { - loadingError: error, - isLoading, - refreshCheckupData: resendRequest, - setSelectedTabIndex, - // Remove this in last minor of the current major (e.g., 7.15) - alertBanner: , - }; - - return [ - { - id: 'overview', - 'data-test-subj': 'upgradeAssistantOverviewTab', - name: i18n.translate('xpack.upgradeAssistant.overviewTab.overviewTabTitle', { - defaultMessage: 'Overview', - }), - content: , - }, - { - id: 'cluster', - 'data-test-subj': 'upgradeAssistantClusterTab', - name: i18n.translate('xpack.upgradeAssistant.checkupTab.clusterTabLabel', { - defaultMessage: 'Cluster', - }), - content: ( - - ), - }, - { - id: 'indices', - 'data-test-subj': 'upgradeAssistantIndicesTab', - name: i18n.translate('xpack.upgradeAssistant.checkupTab.indicesTabLabel', { - defaultMessage: 'Indices', - }), - content: ( - - ), - }, - ]; - }, [checkupData, error, isLoading, resendRequest]); - - const tabName = tabs[selectedTabIndex].id; - - useEffect(() => { - if (isLoading === false) { - setTelemetryState(TelemetryState.Running); - - async function sendTelemetryData() { - await api.sendTelemetryData({ - [tabName]: true, - }); - setTelemetryState(TelemetryState.Complete); - } - - sendTelemetryData(); - } - }, [api, selectedTabIndex, tabName, isLoading]); - - const onTabClick = (selectedTab: EuiTabbedContentTab) => { - const newSelectedTabIndex = findIndex(tabs, { id: selectedTab.id }); - if (selectedTabIndex === -1) { - throw new Error('Clicked tab did not exist in tabs array'); - } - setSelectedTabIndex(newSelectedTabIndex); - }; - - if (error?.statusCode === 426 && error.attributes?.allNodesUpgraded === false) { - return ( - - - - - - } - body={ -

- -

- } - /> - - - ); - } else if (error?.statusCode === 426 && error.attributes?.allNodesUpgraded === true) { - return ( - - - - - - } - body={ -

- -

- } - /> - - - ); - } - - return ( - - ); -}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/components/types.ts b/x-pack/plugins/upgrade_assistant/public/application/components/types.ts index 8be2fe3e0b0a..d82b779110a8 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/components/types.ts +++ b/x-pack/plugins/upgrade_assistant/public/application/components/types.ts @@ -15,9 +15,9 @@ export interface UpgradeAssistantTabProps { checkupData?: UpgradeAssistantStatus | null; deprecations?: EnrichedDeprecationInfo[]; refreshCheckupData: () => void; - loadingError: ResponseError | null; + error: ResponseError | null; isLoading: boolean; - setSelectedTabIndex: (tabIndex: number) => void; + navigateToOverviewPage: () => void; } // eslint-disable-next-line react/prefer-stateless-function @@ -35,6 +35,7 @@ export enum LoadingState { export enum LevelFilterOption { all = 'all', critical = 'critical', + warning = 'warning', } export enum GroupByOption { @@ -47,3 +48,5 @@ export enum TelemetryState { Running, Complete, } + +export type EsTabs = 'cluster' | 'indices'; diff --git a/x-pack/plugins/upgrade_assistant/public/application/lib/breadcrumbs.ts b/x-pack/plugins/upgrade_assistant/public/application/lib/breadcrumbs.ts new file mode 100644 index 000000000000..3f2ee4fa3365 --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/lib/breadcrumbs.ts @@ -0,0 +1,66 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { ManagementAppMountParams } from '../../../../../../src/plugins/management/public'; + +type SetBreadcrumbs = ManagementAppMountParams['setBreadcrumbs']; + +const i18nTexts = { + breadcrumbs: { + overview: i18n.translate('xpack.upgradeAssistant.breadcrumb.overviewLabel', { + defaultMessage: 'Upgrade Assistant', + }), + esDeprecations: i18n.translate('xpack.upgradeAssistant.breadcrumb.esDeprecationsLabel', { + defaultMessage: 'Elasticsearch deprecations', + }), + }, +}; + +export class BreadcrumbService { + private breadcrumbs: { + [key: string]: Array<{ + text: string; + href?: string; + }>; + } = { + overview: [ + { + text: i18nTexts.breadcrumbs.overview, + }, + ], + esDeprecations: [ + { + text: i18nTexts.breadcrumbs.overview, + href: '/', + }, + { + text: i18nTexts.breadcrumbs.esDeprecations, + }, + ], + }; + + private setBreadcrumbsHandler?: SetBreadcrumbs; + + public setup(setBreadcrumbsHandler: SetBreadcrumbs): void { + this.setBreadcrumbsHandler = setBreadcrumbsHandler; + } + + public setBreadcrumbs(type: 'overview' | 'esDeprecations'): void { + if (!this.setBreadcrumbsHandler) { + throw new Error('Breadcrumb service has not been initialized'); + } + + const newBreadcrumbs = this.breadcrumbs[type] + ? [...this.breadcrumbs[type]] + : [...this.breadcrumbs.home]; + + this.setBreadcrumbsHandler(newBreadcrumbs); + } +} + +export const breadcrumbService = new BreadcrumbService(); diff --git a/x-pack/plugins/upgrade_assistant/public/application/lib/es_deprecation_errors.ts b/x-pack/plugins/upgrade_assistant/public/application/lib/es_deprecation_errors.ts new file mode 100644 index 000000000000..4220f0eef8d4 --- /dev/null +++ b/x-pack/plugins/upgrade_assistant/public/application/lib/es_deprecation_errors.ts @@ -0,0 +1,59 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { ResponseError } from './api'; + +const i18nTexts = { + permissionsError: i18n.translate( + 'xpack.upgradeAssistant.esDeprecationErrors.permissionsErrorMessage', + { + defaultMessage: 'You are not authorized to view Elasticsearch deprecations.', + } + ), + partiallyUpgradedWarning: i18n.translate( + 'xpack.upgradeAssistant.esDeprecationErrors.partiallyUpgradedWarningMessage', + { + defaultMessage: + 'Upgrade Kibana to the same version as your Elasticsearch cluster. One or more nodes in the cluster is running a different version than Kibana.', + } + ), + upgradedMessage: i18n.translate( + 'xpack.upgradeAssistant.esDeprecationErrors.upgradedWarningMessage', + { + defaultMessage: + 'Your configuration is up to date. Kibana and all Elasticsearch nodes are running the same version.', + } + ), + loadingError: i18n.translate('xpack.upgradeAssistant.esDeprecationErrors.loadingErrorMessage', { + defaultMessage: 'Could not retrieve Elasticsearch deprecations.', + }), +}; + +export const getEsDeprecationError = (error: ResponseError) => { + if (error.statusCode === 403) { + return { + code: 'unauthorized_error', + message: i18nTexts.permissionsError, + }; + } else if (error?.statusCode === 426 && error.attributes?.allNodesUpgraded === false) { + return { + code: 'partially_upgraded_error', + message: i18nTexts.partiallyUpgradedWarning, + }; + } else if (error?.statusCode === 426 && error.attributes?.allNodesUpgraded === true) { + return { + code: 'upgraded_error', + message: i18nTexts.upgradedMessage, + }; + } else { + return { + code: 'request_error', + message: i18nTexts.loadingError, + }; + } +}; diff --git a/x-pack/plugins/upgrade_assistant/public/application/mount_management_section.ts b/x-pack/plugins/upgrade_assistant/public/application/mount_management_section.ts index 681beefdfd00..575c85bb33ec 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/mount_management_section.ts +++ b/x-pack/plugins/upgrade_assistant/public/application/mount_management_section.ts @@ -11,6 +11,7 @@ import { UA_READONLY_MODE } from '../../common/constants'; import { renderApp } from './render_app'; import { KibanaVersionContext } from './app_context'; import { apiService } from './lib/api'; +import { breadcrumbService } from './lib/breadcrumbs'; export async function mountManagementSection( coreSetup: CoreSetup, @@ -18,13 +19,15 @@ export async function mountManagementSection( params: ManagementAppMountParams, kibanaVersionInfo: KibanaVersionContext ) { - const [{ i18n, docLinks, notifications }] = await coreSetup.getStartServices(); + const [{ i18n, docLinks, notifications, application }] = await coreSetup.getStartServices(); + const { element, history, setBreadcrumbs } = params; const { http } = coreSetup; apiService.setup(http); + breadcrumbService.setup(setBreadcrumbs); return renderApp({ - element: params.element, + element, isCloudEnabled, http, i18n, @@ -32,6 +35,9 @@ export async function mountManagementSection( kibanaVersionInfo, notifications, isReadOnlyMode: UA_READONLY_MODE, + history, api: apiService, + breadcrumbs: breadcrumbService, + getUrlForApp: application.getUrlForApp, }); } diff --git a/x-pack/plugins/upgrade_assistant/public/application/render_app.tsx b/x-pack/plugins/upgrade_assistant/public/application/render_app.tsx index a393ae433c5a..248e6961a74e 100644 --- a/x-pack/plugins/upgrade_assistant/public/application/render_app.tsx +++ b/x-pack/plugins/upgrade_assistant/public/application/render_app.tsx @@ -8,11 +8,9 @@ import React from 'react'; import { render, unmountComponentAtNode } from 'react-dom'; import { AppDependencies, RootComponent } from './app'; -import { ApiService } from './lib/api'; interface BootDependencies extends AppDependencies { element: HTMLElement; - api: ApiService; } export const renderApp = (deps: BootDependencies) => { diff --git a/x-pack/plugins/upgrade_assistant/public/shared_imports.ts b/x-pack/plugins/upgrade_assistant/public/shared_imports.ts index 6d3984fac68a..9007fdc5db04 100644 --- a/x-pack/plugins/upgrade_assistant/public/shared_imports.ts +++ b/x-pack/plugins/upgrade_assistant/public/shared_imports.ts @@ -11,4 +11,5 @@ export { SendRequestResponse, useRequest, UseRequestConfig, + SectionLoading, } from '../../../../src/plugins/es_ui_shared/public/'; diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts b/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts index 5ab5c88cce4b..a59aa009a912 100644 --- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts +++ b/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts @@ -6,10 +6,14 @@ */ import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest'; -import { PageContent } from '../../public/application/components/page_content'; +import { EsDeprecationsContent } from '../../public/application/components/es_deprecations'; import { WithAppDependencies } from './setup_environment'; const testBedConfig: TestBedConfig = { + memoryRouter: { + initialEntries: ['/es_deprecations/indices'], + componentRoutePath: '/es_deprecations/:tabName', + }, doMountAsync: true, }; @@ -46,7 +50,10 @@ const createActions = (testBed: TestBed) => { }; export const setup = async (overrides?: Record): Promise => { - const initTestBed = registerTestBed(WithAppDependencies(PageContent, overrides), testBedConfig); + const initTestBed = registerTestBed( + WithAppDependencies(EsDeprecationsContent, overrides), + testBedConfig + ); const testBed = await initTestBed(); return { @@ -60,6 +67,9 @@ export type IndicesTestSubjects = | 'removeIndexSettingsButton' | 'deprecationsContainer' | 'permissionsError' - | 'upgradeStatusError' + | 'requestError' + | 'indexCount' + | 'upgradedCallout' + | 'partiallyUpgradedWarning' | 'noDeprecationsPrompt' | string; diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts b/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts index 22d00290842f..161364f6d45c 100644 --- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts +++ b/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts @@ -6,27 +6,40 @@ */ import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest'; -import { PageContent } from '../../public/application/components/page_content'; +import { DeprecationsOverview } from '../../public/application/components/overview'; import { WithAppDependencies } from './setup_environment'; const testBedConfig: TestBedConfig = { + memoryRouter: { + initialEntries: [`/overview`], + componentRoutePath: '/overview', + }, doMountAsync: true, }; export type OverviewTestBed = TestBed; -export const setup = async (overrides?: any): Promise => { - const initTestBed = registerTestBed(WithAppDependencies(PageContent, overrides), testBedConfig); +export const setup = async (overrides?: Record): Promise => { + const initTestBed = registerTestBed( + WithAppDependencies(DeprecationsOverview, overrides), + testBedConfig + ); const testBed = await initTestBed(); return testBed; }; export type OverviewTestSubjects = - | 'comingSoonPrompt' - | 'upgradeAssistantPageContent' + | 'overviewPageContent' + | 'esStatsPanel' + | 'esStatsPanel.totalDeprecations' + | 'esStatsPanel.criticalDeprecations' + | 'deprecationLoggingFormRow' + | 'requestErrorIconTip' + | 'partiallyUpgradedErrorIconTip' + | 'upgradedErrorIconTip' + | 'unauthorizedErrorIconTip' | 'upgradedPrompt' | 'partiallyUpgradedPrompt' | 'upgradeAssistantDeprecationToggle' - | 'deprecationLoggingStep' | 'upgradeStatusError'; diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx b/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx index fb0afef8cf58..7ee6114cd86a 100644 --- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx +++ b/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx @@ -17,14 +17,15 @@ import { mockKibanaSemverVersion, UA_READONLY_MODE } from '../../common/constant import { AppContextProvider } from '../../public/application/app_context'; import { init as initHttpRequests } from './http_requests'; import { apiService } from '../../public/application/lib/api'; +import { breadcrumbService } from '../../public/application/lib/breadcrumbs'; const mockHttpClient = axios.create({ adapter: axiosXhrAdapter }); -export const WithAppDependencies = ( - Comp: React.FunctionComponent>, - overrides: Record = {} -) => (props: Record) => { +export const WithAppDependencies = (Comp: any, overrides: Record = {}) => ( + props: Record +) => { apiService.setup((mockHttpClient as unknown) as HttpSetup); + breadcrumbService.setup(() => ''); const contextValue = { http: (mockHttpClient as unknown) as HttpSetup, @@ -38,6 +39,8 @@ export const WithAppDependencies = ( isReadOnlyMode: UA_READONLY_MODE, notifications: notificationServiceMock.createStartContract(), api: apiService, + breadcrumbs: breadcrumbService, + getUrlForApp: () => '', }; return ( diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts b/x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts index 01d95f117827..6363e57903c2 100644 --- a/x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts +++ b/x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts @@ -124,14 +124,7 @@ describe('Indices tab', () => { testBed = await setupIndicesPage({ isReadOnlyMode: false }); }); - const { actions, component } = testBed; - - component.update(); - - // Navigate to the indices tab - await act(async () => { - actions.clickTab('indices'); - }); + const { component } = testBed; component.update(); }); @@ -139,7 +132,7 @@ describe('Indices tab', () => { test('renders prompt', () => { const { exists, find } = testBed; expect(exists('noDeprecationsPrompt')).toBe(true); - expect(find('noDeprecationsPrompt').text()).toContain('All clear!'); + expect(find('noDeprecationsPrompt').text()).toContain('Ready to upgrade!'); }); }); @@ -163,7 +156,59 @@ describe('Indices tab', () => { expect(exists('permissionsError')).toBe(true); expect(find('permissionsError').text()).toContain( - 'You do not have sufficient privileges to view this page.' + 'You are not authorized to view Elasticsearch deprecations.' + ); + }); + + test('handles upgrade error', async () => { + const error = { + statusCode: 426, + error: 'Upgrade required', + message: 'There are some nodes running a different version of Elasticsearch', + attributes: { + allNodesUpgraded: true, + }, + }; + + httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); + + await act(async () => { + testBed = await setupIndicesPage({ isReadOnlyMode: false }); + }); + + const { component, exists, find } = testBed; + + component.update(); + + expect(exists('upgradedCallout')).toBe(true); + expect(find('upgradedCallout').text()).toContain( + 'Your configuration is up to date. Kibana and all Elasticsearch nodes are running the same version.' + ); + }); + + test('handles partially upgrade error', async () => { + const error = { + statusCode: 426, + error: 'Upgrade required', + message: 'There are some nodes running a different version of Elasticsearch', + attributes: { + allNodesUpgraded: false, + }, + }; + + httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); + + await act(async () => { + testBed = await setupIndicesPage({ isReadOnlyMode: false }); + }); + + const { component, exists, find } = testBed; + + component.update(); + + expect(exists('partiallyUpgradedWarning')).toBe(true); + expect(find('partiallyUpgradedWarning').text()).toContain( + 'Upgrade Kibana to the same version as your Elasticsearch cluster. One or more nodes in the cluster is running a different version than Kibana.' ); }); @@ -184,9 +229,9 @@ describe('Indices tab', () => { component.update(); - expect(exists('upgradeStatusError')).toBe(true); - expect(find('upgradeStatusError').text()).toContain( - 'An error occurred while retrieving the checkup results.' + expect(exists('requestError')).toBe(true); + expect(find('requestError').text()).toContain( + 'Could not retrieve Elasticsearch deprecations.' ); }); }); diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts b/x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts index 139c4ecb5a75..cdbbd0a36cbd 100644 --- a/x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts +++ b/x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts @@ -11,25 +11,9 @@ import { OverviewTestBed, setupOverviewPage, setupEnvironment } from './helpers' describe('Overview page', () => { let testBed: OverviewTestBed; + const { server, httpRequestsMockHelpers } = setupEnvironment(); beforeEach(async () => { - await act(async () => { - testBed = await setupOverviewPage(); - }); - }); - - describe('Coming soon prompt', () => { - // Default behavior up until the last minor before the next major release - test('renders the coming soon prompt by default', () => { - const { exists } = testBed; - - expect(exists('comingSoonPrompt')).toBe(true); - }); - }); - - describe('Overview content', () => { - const { server, httpRequestsMockHelpers } = setupEnvironment(); - const upgradeStatusMockResponse = { readyForUpgrade: false, cluster: [], @@ -39,148 +23,163 @@ describe('Overview page', () => { httpRequestsMockHelpers.setLoadStatusResponse(upgradeStatusMockResponse); httpRequestsMockHelpers.setLoadDeprecationLoggingResponse({ isEnabled: true }); - beforeEach(async () => { - await act(async () => { - // Override the default context value to verify tab content renders as expected - // This will be the default behavior on the last minor before the next major release (e.g., v7.15) - testBed = await setupOverviewPage({ isReadOnlyMode: false }); - }); - - testBed.component.update(); - }); - - afterAll(() => { - server.restore(); + await act(async () => { + testBed = await setupOverviewPage(); }); - test('renders the overview tab', () => { - const { exists } = testBed; + const { component } = testBed; + component.update(); + }); - expect(exists('comingSoonPrompt')).toBe(false); - expect(exists('upgradeAssistantPageContent')).toBe(true); - }); + afterAll(() => { + server.restore(); + }); - describe('Deprecation logging', () => { - test('toggles deprecation logging', async () => { - const { form, find, component } = testBed; + test('renders the overview page', () => { + const { exists, find } = testBed; - httpRequestsMockHelpers.setUpdateDeprecationLoggingResponse({ isEnabled: false }); + expect(exists('overviewPageContent')).toBe(true); + // Verify ES stats + expect(exists('esStatsPanel')).toBe(true); + expect(find('esStatsPanel.totalDeprecations').text()).toContain('0'); + expect(find('esStatsPanel.criticalDeprecations').text()).toContain('0'); + }); - expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(true); - expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(false); - expect(find('deprecationLoggingStep').find('.euiSwitch__label').text()).toContain('On'); + describe('Deprecation logging', () => { + test('toggles deprecation logging', async () => { + const { form, find, component } = testBed; - await act(async () => { - form.toggleEuiSwitch('upgradeAssistantDeprecationToggle'); - }); + httpRequestsMockHelpers.setUpdateDeprecationLoggingResponse({ isEnabled: false }); - component.update(); + expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(true); + expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(false); - expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(false); - expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(false); - expect(find('deprecationLoggingStep').find('.euiSwitch__label').text()).toContain('Off'); + await act(async () => { + form.toggleEuiSwitch('upgradeAssistantDeprecationToggle'); }); - test('handles network error', async () => { - const error = { - statusCode: 500, - error: 'Internal server error', - message: 'Internal server error', - }; + component.update(); - const { form, find, component } = testBed; + expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(false); + expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(false); + }); - httpRequestsMockHelpers.setUpdateDeprecationLoggingResponse(undefined, error); + test('handles network error', async () => { + const error = { + statusCode: 500, + error: 'Internal server error', + message: 'Internal server error', + }; - expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(true); - expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(false); - expect(find('deprecationLoggingStep').find('.euiSwitch__label').text()).toContain('On'); + const { form, find, component } = testBed; - await act(async () => { - form.toggleEuiSwitch('upgradeAssistantDeprecationToggle'); - }); + httpRequestsMockHelpers.setUpdateDeprecationLoggingResponse(undefined, error); - component.update(); + expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(true); + expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(false); + expect(find('deprecationLoggingFormRow').find('.euiSwitch__label').text()).toContain( + 'Enable deprecation logging' + ); - expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(true); - expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(true); - expect(find('deprecationLoggingStep').find('.euiSwitch__label').text()).toContain( - 'Could not load logging state' - ); + await act(async () => { + form.toggleEuiSwitch('upgradeAssistantDeprecationToggle'); }); + + component.update(); + + expect(find('upgradeAssistantDeprecationToggle').props()['aria-checked']).toBe(true); + expect(find('upgradeAssistantDeprecationToggle').props().disabled).toBe(true); + expect(find('deprecationLoggingFormRow').find('.euiSwitch__label').text()).toContain( + 'Could not load logging state' + ); }); + }); + + describe('Error handling', () => { + test('handles network failure', async () => { + const error = { + statusCode: 500, + error: 'Internal server error', + message: 'Internal server error', + }; + + httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); + + await act(async () => { + testBed = await setupOverviewPage(); + }); - describe('Error handling', () => { - test('handles network failure', async () => { - const error = { - statusCode: 500, - error: 'Internal server error', - message: 'Internal server error', - }; + const { component, exists } = testBed; - httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); + component.update(); - await act(async () => { - testBed = await setupOverviewPage({ isReadOnlyMode: false }); - }); + expect(exists('requestErrorIconTip')).toBe(true); + }); - const { component, exists, find } = testBed; + test('handles unauthorized error', async () => { + const error = { + statusCode: 403, + error: 'Forbidden', + message: 'Forbidden', + }; - component.update(); + httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); - expect(exists('upgradeStatusError')).toBe(true); - expect(find('upgradeStatusError').text()).toContain( - 'An error occurred while retrieving the checkup results.' - ); + await act(async () => { + testBed = await setupOverviewPage(); }); - test('handles partially upgraded error', async () => { - const error = { - statusCode: 426, - error: 'Upgrade required', - message: 'There are some nodes running a different version of Elasticsearch', - attributes: { - allNodesUpgraded: false, - }, - }; + const { component, exists } = testBed; - httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); + component.update(); - await act(async () => { - testBed = await setupOverviewPage({ isReadOnlyMode: false }); - }); + expect(exists('unauthorizedErrorIconTip')).toBe(true); + }); - const { component, exists, find } = testBed; + test('handles partially upgraded error', async () => { + const error = { + statusCode: 426, + error: 'Upgrade required', + message: 'There are some nodes running a different version of Elasticsearch', + attributes: { + allNodesUpgraded: false, + }, + }; - component.update(); + httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); - expect(exists('partiallyUpgradedPrompt')).toBe(true); - expect(find('partiallyUpgradedPrompt').text()).toContain('Your cluster is upgrading'); + await act(async () => { + testBed = await setupOverviewPage({ isReadOnlyMode: false }); }); - test('handles upgrade error', async () => { - const error = { - statusCode: 426, - error: 'Upgrade required', - message: 'There are some nodes running a different version of Elasticsearch', - attributes: { - allNodesUpgraded: true, - }, - }; + const { component, exists } = testBed; - httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); + component.update(); - await act(async () => { - testBed = await setupOverviewPage({ isReadOnlyMode: false }); - }); + expect(exists('partiallyUpgradedErrorIconTip')).toBe(true); + }); - const { component, exists, find } = testBed; + test('handles upgrade error', async () => { + const error = { + statusCode: 426, + error: 'Upgrade required', + message: 'There are some nodes running a different version of Elasticsearch', + attributes: { + allNodesUpgraded: true, + }, + }; - component.update(); + httpRequestsMockHelpers.setLoadStatusResponse(undefined, error); - expect(exists('upgradedPrompt')).toBe(true); - expect(find('upgradedPrompt').text()).toContain('Your cluster has been upgraded'); + await act(async () => { + testBed = await setupOverviewPage({ isReadOnlyMode: false }); }); + + const { component, exists } = testBed; + + component.update(); + + expect(exists('upgradedErrorIconTip')).toBe(true); }); }); }); diff --git a/x-pack/plugins/uptime/common/runtime_types/network_events.ts b/x-pack/plugins/uptime/common/runtime_types/network_events.ts index e896a165916f..d24014aec8ea 100644 --- a/x-pack/plugins/uptime/common/runtime_types/network_events.ts +++ b/x-pack/plugins/uptime/common/runtime_types/network_events.ts @@ -35,7 +35,6 @@ const NetworkEventType = t.intersection([ url: t.string, }), t.partial({ - bytesDownloadedCompressed: t.number, certificates: CertificateDataType, ip: t.string, method: t.string, @@ -44,6 +43,8 @@ const NetworkEventType = t.intersection([ responseHeaders: t.record(t.string, t.string), requestHeaders: t.record(t.string, t.string), timings: NetworkTimingsType, + transferSize: t.number, + resourceSize: t.number, }), ]); diff --git a/x-pack/plugins/uptime/public/components/monitor/status_details/availability_reporting/__snapshots__/location_status_tags.test.tsx.snap b/x-pack/plugins/uptime/public/components/monitor/status_details/availability_reporting/__snapshots__/location_status_tags.test.tsx.snap index 8e2a4b1bd177..44a2021cce61 100644 --- a/x-pack/plugins/uptime/public/components/monitor/status_details/availability_reporting/__snapshots__/location_status_tags.test.tsx.snap +++ b/x-pack/plugins/uptime/public/components/monitor/status_details/availability_reporting/__snapshots__/location_status_tags.test.tsx.snap @@ -996,7 +996,7 @@ exports[`LocationStatusTags component renders when there are many location 1`] = aria-controls="generated-id" aria-current="true" aria-label="Page 1 of 2" - class="euiButtonEmpty euiButtonEmpty--text euiButtonEmpty--xSmall euiButtonEmpty-isDisabled euiPaginationButton euiPaginationButton-isActive euiPaginationButton--hideOnMobile" + class="euiButtonEmpty euiButtonEmpty--text euiButtonEmpty--small euiButtonEmpty-isDisabled euiPaginationButton euiPaginationButton-isActive euiPaginationButton--hideOnMobile" data-test-subj="pagination-button-0" disabled="" type="button" @@ -1018,7 +1018,7 @@ exports[`LocationStatusTags component renders when there are many location 1`] = { Object { "certificates": undefined, "details": Array [ + Object { + "name": "Status", + "value": undefined, + }, Object { "name": "Content type", "value": "text/javascript", @@ -573,7 +578,11 @@ describe('getSeriesAndDomain', () => { "value": undefined, }, Object { - "name": "Bytes downloaded (compressed)", + "name": "Resource size", + "value": undefined, + }, + Object { + "name": "Transfer size", "value": undefined, }, Object { @@ -640,6 +649,7 @@ describe('getSeriesAndDomain', () => { }); it.each([ + [FriendlyFlyoutLabels[Metadata.Status], '200'], [FriendlyFlyoutLabels[Metadata.MimeType], 'text/css'], [FriendlyFlyoutLabels[Metadata.RequestStart], '0.000 ms'], [FriendlyTimingLabels[Timings.Dns], '3.560 ms'], @@ -647,7 +657,8 @@ describe('getSeriesAndDomain', () => { [FriendlyTimingLabels[Timings.Ssl], '55.387 ms'], [FriendlyTimingLabels[Timings.Wait], '34.578 ms'], [FriendlyTimingLabels[Timings.Receive], '0.552 ms'], - [FriendlyFlyoutLabels[Metadata.BytesDownloadedCompressed], '1.000 KB'], + [FriendlyFlyoutLabels[Metadata.TransferSize], '1.000 KB'], + [FriendlyFlyoutLabels[Metadata.ResourceSize], '1.000 KB'], [FriendlyFlyoutLabels[Metadata.IP], '104.18.8.22'], ])('handles metadata details formatting', (name, value) => { const { metadata } = getSeriesAndDomain(networkItems); diff --git a/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts b/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts index 23d9b2d8563a..f497bf1ea7b3 100644 --- a/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts +++ b/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts @@ -239,13 +239,15 @@ const formatMetadata = ({ requestStart: number; }) => { const { - bytesDownloadedCompressed, certificates, ip, mimeType, requestHeaders, responseHeaders, url, + resourceSize, + transferSize, + status, } = item; const { dns, connect, ssl, wait, receive, total } = item.timings || {}; const contentDownloaded = receive && receive > 0 ? receive : total; @@ -277,6 +279,7 @@ const formatMetadata = ({ ] : undefined, details: [ + { name: FriendlyFlyoutLabels[Metadata.Status], value: status ? `${status}` : undefined }, { name: FriendlyFlyoutLabels[Metadata.MimeType], value: mimeType }, { name: FriendlyFlyoutLabels[Metadata.RequestStart], @@ -306,9 +309,16 @@ const formatMetadata = ({ }), }, { - name: FriendlyFlyoutLabels[Metadata.BytesDownloadedCompressed], + name: FriendlyFlyoutLabels[Metadata.ResourceSize], value: getFriendlyMetadataValue({ - value: bytesDownloadedCompressed ? bytesDownloadedCompressed / 1000 : undefined, + value: resourceSize ? resourceSize / 1000 : undefined, + postFix: 'KB', + }), + }, + { + name: FriendlyFlyoutLabels[Metadata.TransferSize], + value: getFriendlyMetadataValue({ + value: transferSize ? transferSize / 1000 : undefined, postFix: 'KB', }), }, diff --git a/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/types.ts b/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/types.ts index cedf9c667d0f..e356297fdae3 100644 --- a/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/types.ts +++ b/x-pack/plugins/uptime/public/components/monitor/synthetics/step_detail/waterfall/types.ts @@ -19,7 +19,9 @@ export enum Timings { } export enum Metadata { - BytesDownloadedCompressed = 'bytesDownloadedCompressed', + Status = 'status', + ResourceSize = 'resourceSize', + TransferSize = 'transferSize', CertificateIssuer = 'certificateIssuer', CertificateIssueDate = 'certificateIssueDate', CertificateExpiryDate = 'certificateExpiryDate', @@ -63,6 +65,12 @@ export const FriendlyTimingLabels = { }; export const FriendlyFlyoutLabels = { + [Metadata.Status]: i18n.translate( + 'xpack.uptime.synthetics.waterfallChart.labels.metadata.status', + { + defaultMessage: 'Status', + } + ), [Metadata.MimeType]: i18n.translate( 'xpack.uptime.synthetics.waterfallChart.labels.metadata.contentType', { @@ -75,10 +83,16 @@ export const FriendlyFlyoutLabels = { defaultMessage: 'Request start', } ), - [Metadata.BytesDownloadedCompressed]: i18n.translate( - 'xpack.uptime.synthetics.waterfallChart.labels.metadata.bytesDownloadedCompressed', + [Metadata.ResourceSize]: i18n.translate( + 'xpack.uptime.synthetics.waterfallChart.labels.metadata.resourceSize', + { + defaultMessage: 'Resource size', + } + ), + [Metadata.TransferSize]: i18n.translate( + 'xpack.uptime.synthetics.waterfallChart.labels.metadata.transferSize', { - defaultMessage: 'Bytes downloaded (compressed)', + defaultMessage: 'Transfer size', } ), [Metadata.CertificateIssuer]: i18n.translate( diff --git a/x-pack/plugins/uptime/server/lib/requests/get_network_events.test.ts b/x-pack/plugins/uptime/server/lib/requests/get_network_events.test.ts index d806606abcb1..b7f417168fd3 100644 --- a/x-pack/plugins/uptime/server/lib/requests/get_network_events.test.ts +++ b/x-pack/plugins/uptime/server/lib/requests/get_network_events.test.ts @@ -66,6 +66,8 @@ describe('getNetworkEvents', () => { }, is_navigation_request: false, timestamp: 1607942799183375, + transfer_size: 1000, + resource_size: 1000, }, }, http: { @@ -242,7 +244,6 @@ describe('getNetworkEvents', () => { Object { "events": Array [ Object { - "bytesDownloadedCompressed": 337, "certificates": Object { "issuer": "DigiCert TLS RSA SHA256 2020 CA1", "subjectName": "syndication.twitter.com", @@ -258,6 +259,7 @@ describe('getNetworkEvents', () => { "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/88.0.4324.0 Safari/537.36", }, "requestSentTime": 3287154.973, + "resourceSize": 1000, "responseHeaders": Object { "cache_control": "no-cache, no-store, must-revalidate, pre-check=0, post-check=0", "content_encoding": "gzip", @@ -292,6 +294,7 @@ describe('getNetworkEvents', () => { "total": 143.27800000000934, "wait": 141.81299999972907, }, + "transferSize": 1000, "url": "www.test.com", }, ], diff --git a/x-pack/plugins/uptime/server/lib/requests/get_network_events.ts b/x-pack/plugins/uptime/server/lib/requests/get_network_events.ts index 2741062cc403..2f45f633ba97 100644 --- a/x-pack/plugins/uptime/server/lib/requests/get_network_events.ts +++ b/x-pack/plugins/uptime/server/lib/requests/get_network_events.ts @@ -58,7 +58,8 @@ export const getNetworkEvents: UMElasticsearchQueryFn< requestSentTime, loadEndTime, timings: event._source.synthetics.payload.timings, - bytesDownloadedCompressed: event._source.http?.response?.encoded_data_length, + transferSize: event._source.synthetics.payload.transfer_size, + resourceSize: event._source.synthetics.payload.resource_size, certificates: securityDetails ? { issuer: securityDetails.issuer?.common_name, diff --git a/x-pack/scripts/functional_tests.js b/x-pack/scripts/functional_tests.js index 1f6fe310bfa7..450cbc224eb4 100644 --- a/x-pack/scripts/functional_tests.js +++ b/x-pack/scripts/functional_tests.js @@ -12,6 +12,8 @@ const alwaysImportedTests = [ require.resolve('../test/plugin_functional/config.ts'), require.resolve('../test/functional_with_es_ssl/config.ts'), require.resolve('../test/functional/config_security_basic.ts'), + require.resolve('../test/reporting_functional/reporting_and_security.config.ts'), + require.resolve('../test/reporting_functional/reporting_without_security.config.ts'), require.resolve('../test/security_functional/login_selector.config.ts'), require.resolve('../test/security_functional/oidc.config.ts'), require.resolve('../test/security_functional/saml.config.ts'), diff --git a/x-pack/test/accessibility/apps/dashboard_edit_panel.ts b/x-pack/test/accessibility/apps/dashboard_edit_panel.ts index 466eab6b6b33..c318c2d1c26a 100644 --- a/x-pack/test/accessibility/apps/dashboard_edit_panel.ts +++ b/x-pack/test/accessibility/apps/dashboard_edit_panel.ts @@ -20,8 +20,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const PANEL_TITLE = 'Visualization PieChart'; - // FLAKY: https://github.com/elastic/kibana/issues/92114 - describe.skip('Dashboard Edit Panel', () => { + describe('Dashboard Edit Panel', () => { before(async () => { await esArchiver.load('dashboard/drilldowns'); await esArchiver.loadIfNeeded('logstash_functional'); diff --git a/x-pack/test/accessibility/apps/upgrade_assistant.ts b/x-pack/test/accessibility/apps/upgrade_assistant.ts index 96b3e6673de7..8d2774c000b2 100644 --- a/x-pack/test/accessibility/apps/upgrade_assistant.ts +++ b/x-pack/test/accessibility/apps/upgrade_assistant.ts @@ -13,39 +13,39 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const testSubjects = getService('testSubjects'); const retry = getService('retry'); - describe('Upgrade Assistant Home', () => { + describe('Upgrade Assistant', () => { before(async () => { await PageObjects.upgradeAssistant.navigateToPage(); }); - it('Overview page', async () => { - await retry.waitFor('Upgrade Assistant overview page to be visible', async () => { + it('Coming soon prompt', async () => { + await retry.waitFor('Upgrade Assistant coming soon prompt to be visible', async () => { return testSubjects.exists('comingSoonPrompt'); }); await a11y.testAppSnapshot(); }); // These tests will be skipped until the last minor of the next major release - describe.skip('tabs', () => { - it('Overview Tab', async () => { - await retry.waitFor('Upgrade Assistant overview tab to be visible', async () => { - return testSubjects.exists('upgradeAssistantOverviewTabDetail'); + describe.skip('Upgrade Assistant content', () => { + it('Overview page', async () => { + await retry.waitFor('Upgrade Assistant overview page to be visible', async () => { + return testSubjects.exists('overviewPageContent'); }); await a11y.testAppSnapshot(); }); - it('Cluster Tab', async () => { - await testSubjects.click('upgradeAssistantClusterTab'); + it('Elasticsearch cluster tab', async () => { + await testSubjects.click('esDeprecationsLink'); await retry.waitFor('Upgrade Assistant Cluster tab to be visible', async () => { - return testSubjects.exists('upgradeAssistantClusterTabDetail'); + return testSubjects.exists('clusterTabContent'); }); await a11y.testAppSnapshot(); }); - it('Indices Tab', async () => { + it('Elasticsearch indices tab', async () => { await testSubjects.click('upgradeAssistantIndicesTab'); - await retry.waitFor('Upgrade Assistant Cluster tab to be visible', async () => { - return testSubjects.exists('upgradeAssistantIndexTabDetail'); + await retry.waitFor('Upgrade Assistant Indices tab to be visible', async () => { + return testSubjects.exists('indexTabContent'); }); await a11y.testAppSnapshot(); }); diff --git a/x-pack/test/api_integration/apis/maps/get_grid_tile.js b/x-pack/test/api_integration/apis/maps/get_grid_tile.js index 6e75c00f5007..c929a1af7b15 100644 --- a/x-pack/test/api_integration/apis/maps/get_grid_tile.js +++ b/x-pack/test/api_integration/apis/maps/get_grid_tile.js @@ -20,11 +20,8 @@ export default function ({ getService }) { it('should return vector tile containing cluster features', async () => { const resp = await supertest .get( - `/api/maps/mvt/getGridTile\ -?x=2\ -&y=3\ -&z=3\ -&geometryFieldName=geo.coordinates\ + `/api/maps/mvt/getGridTile/3/2/3.pbf\ +?geometryFieldName=geo.coordinates\ &index=logstash-*\ &requestBody=(_source:(excludes:!()),aggs:(gridSplit:(aggs:(avg_of_bytes:(avg:(field:bytes)),gridCentroid:(geo_centroid:(field:geo.coordinates))),geotile_grid:(bounds:!n,field:geo.coordinates,precision:!n,shard_size:65535,size:65535))),fields:!((field:%27@timestamp%27,format:date_time),(field:%27relatedContent.article:modified_time%27,format:date_time),(field:%27relatedContent.article:published_time%27,format:date_time),(field:utc_time,format:date_time)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(hour_of_day:(script:(lang:painless,source:%27doc[!%27@timestamp!%27].value.getHour()%27))),size:0,stored_fields:!(%27*%27))\ &requestType=point\ @@ -48,11 +45,8 @@ export default function ({ getService }) { it('should return vector tile containing grid features', async () => { const resp = await supertest .get( - `/api/maps/mvt/getGridTile\ -?x=2\ -&y=3\ -&z=3\ -&geometryFieldName=geo.coordinates\ + `/api/maps/mvt/getGridTile/3/2/3.pbf\ +?geometryFieldName=geo.coordinates\ &index=logstash-*\ &requestBody=(_source:(excludes:!()),aggs:(gridSplit:(aggs:(avg_of_bytes:(avg:(field:bytes)),gridCentroid:(geo_centroid:(field:geo.coordinates))),geotile_grid:(bounds:!n,field:geo.coordinates,precision:!n,shard_size:65535,size:65535))),fields:!((field:%27@timestamp%27,format:date_time),(field:%27relatedContent.article:modified_time%27,format:date_time),(field:%27relatedContent.article:published_time%27,format:date_time),(field:utc_time,format:date_time)),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(hour_of_day:(script:(lang:painless,source:%27doc[!%27@timestamp!%27].value.getHour()%27))),size:0,stored_fields:!(%27*%27))\ &requestType=grid\ diff --git a/x-pack/test/api_integration/apis/maps/get_tile.js b/x-pack/test/api_integration/apis/maps/get_tile.js index 8ece77a5096f..f75d43cf0cee 100644 --- a/x-pack/test/api_integration/apis/maps/get_tile.js +++ b/x-pack/test/api_integration/apis/maps/get_tile.js @@ -17,11 +17,8 @@ export default function ({ getService }) { it('should return vector tile containing document', async () => { const resp = await supertest .get( - `/api/maps/mvt/getTile\ -?x=1\ -&y=1\ -&z=2\ -&geometryFieldName=geo.coordinates\ + `/api/maps/mvt/getTile/2/1/1.pbf\ +?geometryFieldName=geo.coordinates\ &index=logstash-*\ &requestBody=(_source:!f,docvalue_fields:!(bytes,geo.coordinates,machine.os.raw),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10000,stored_fields:!(bytes,geo.coordinates,machine.os.raw))\ &geoFieldType=geo_point` @@ -51,11 +48,8 @@ export default function ({ getService }) { const resp = await supertest // requestBody sets size=1 to force count exceeded .get( - `/api/maps/mvt/getTile\ -?x=1\ -&y=1\ -&z=2\ -&geometryFieldName=geo.coordinates\ + `/api/maps/mvt/getTile/2/1/1.pbf\ +?geometryFieldName=geo.coordinates\ &index=logstash-*\ &requestBody=(_source:!f,docvalue_fields:!(bytes,geo.coordinates,machine.os.raw),query:(bool:(filter:!((match_all:()),(range:(%27@timestamp%27:(format:strict_date_optional_time,gte:%272015-09-20T00:00:00.000Z%27,lte:%272015-09-20T01:00:00.000Z%27)))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:1,stored_fields:!(bytes,geo.coordinates,machine.os.raw))\ &geoFieldType=geo_point` diff --git a/x-pack/test/api_integration/apis/metrics_ui/log_sources.ts b/x-pack/test/api_integration/apis/metrics_ui/log_sources.ts index a0ece1e6ab00..0cde7263a245 100644 --- a/x-pack/test/api_integration/apis/metrics_ui/log_sources.ts +++ b/x-pack/test/api_integration/apis/metrics_ui/log_sources.ts @@ -36,7 +36,10 @@ export default function ({ getService }: FtrProviderContext) { expect(origin).to.be('fallback'); expect(configuration.name).to.be('Default'); - expect(configuration.logAlias).to.be('logs-*,filebeat-*,kibana_sample_data_logs*'); + expect(configuration.logIndices).to.eql({ + type: 'index_name', + indexName: 'logs-*,filebeat-*,kibana_sample_data_logs*', + }); expect(configuration.fields.timestamp).to.be('@timestamp'); expect(configuration.fields.tiebreaker).to.be('_doc'); expect(configuration.logColumns[0]).to.have.key('timestampColumn'); @@ -51,7 +54,10 @@ export default function ({ getService }: FtrProviderContext) { .createUpdateLogSourceConfigurationAgent('default', { name: 'NAME', description: 'DESCRIPTION', - logAlias: 'filebeat-**', + logIndices: { + type: 'index_pattern', + indexPatternId: 'kip-id', + }, fields: { tiebreaker: 'TIEBREAKER', timestamp: 'TIMESTAMP', @@ -73,7 +79,10 @@ export default function ({ getService }: FtrProviderContext) { expect(configuration.name).to.be('NAME'); expect(origin).to.be('stored'); - expect(configuration.logAlias).to.be('filebeat-**'); + expect(configuration.logIndices).to.eql({ + type: 'index_pattern', + indexPatternId: 'kip-id', + }); expect(configuration.fields.timestamp).to.be('TIMESTAMP'); expect(configuration.fields.tiebreaker).to.be('TIEBREAKER'); expect(configuration.logColumns).to.have.length(1); @@ -98,7 +107,10 @@ export default function ({ getService }: FtrProviderContext) { expect(configuration.name).to.be('Default'); expect(origin).to.be('stored'); - expect(configuration.logAlias).to.be('logs-*,filebeat-*,kibana_sample_data_logs*'); + expect(configuration.logIndices).eql({ + type: 'index_name', + indexName: 'logs-*,filebeat-*,kibana_sample_data_logs*', + }); expect(configuration.fields.timestamp).to.be('@timestamp'); expect(configuration.fields.tiebreaker).to.be('_doc'); expect(configuration.logColumns).to.have.length(3); @@ -126,7 +138,10 @@ export default function ({ getService }: FtrProviderContext) { .createUpdateLogSourceConfigurationAgent('default', { name: 'NAME', description: 'DESCRIPTION', - logAlias: 'filebeat-**', + logIndices: { + type: 'index_pattern', + indexPatternId: 'kip-id', + }, fields: { tiebreaker: 'TIEBREAKER', timestamp: 'TIMESTAMP', @@ -147,7 +162,10 @@ export default function ({ getService }: FtrProviderContext) { expect(configuration.name).to.be('NAME'); expect(origin).to.be('stored'); - expect(configuration.logAlias).to.be('filebeat-**'); + expect(configuration.logIndices).to.eql({ + type: 'index_pattern', + indexPatternId: 'kip-id', + }); expect(configuration.fields.timestamp).to.be('TIMESTAMP'); expect(configuration.fields.tiebreaker).to.be('TIEBREAKER'); expect(configuration.logColumns).to.have.length(1); @@ -167,7 +185,10 @@ export default function ({ getService }: FtrProviderContext) { expect(configuration.name).to.be('NAME'); expect(origin).to.be('stored'); - expect(configuration.logAlias).to.be('logs-*,filebeat-*,kibana_sample_data_logs*'); + expect(configuration.logIndices).to.eql({ + type: 'index_name', + indexName: 'logs-*,filebeat-*,kibana_sample_data_logs*', + }); expect(configuration.fields.timestamp).to.be('@timestamp'); expect(configuration.fields.tiebreaker).to.be('_doc'); expect(configuration.logColumns).to.have.length(3); diff --git a/x-pack/test/api_integration/apis/ml/modules/get_module.ts b/x-pack/test/api_integration/apis/ml/modules/get_module.ts index aade37237454..59aa6102b54e 100644 --- a/x-pack/test/api_integration/apis/ml/modules/get_module.ts +++ b/x-pack/test/api_integration/apis/ml/modules/get_module.ts @@ -11,6 +11,8 @@ import { FtrProviderContext } from '../../../ftr_provider_context'; import { USER } from '../../../../functional/services/ml/security_common'; import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api'; +import { isPopulatedObject } from '../../../../../plugins/ml/common/util/object_utils'; + const moduleIds = [ 'apache_ecs', 'apm_jsbase', @@ -70,6 +72,32 @@ export default ({ getService }: FtrProviderContext) => { const rspBody = await executeGetModuleRequest(moduleId, USER.ML_POWERUSER, 200); expect(rspBody).to.be.an(Object); + expect(rspBody).to.have.property('id').a('string'); + expect(rspBody).to.have.property('title').a('string'); + expect(rspBody).to.have.property('description').a('string'); + expect(rspBody).to.have.property('type').a('string'); + if (isPopulatedObject(rspBody, ['logoFile'])) { + expect(rspBody).to.have.property('logoFile').a('string'); + } + if (isPopulatedObject(rspBody, ['logo'])) { + expect(rspBody).to.have.property('logo').an(Object); + } + if (isPopulatedObject(rspBody, ['defaultIndexPattern'])) { + expect(rspBody).to.have.property('defaultIndexPattern').a('string'); + } + if (isPopulatedObject(rspBody, ['query'])) { + expect(rspBody).to.have.property('query').an(Object); + } + if (isPopulatedObject(rspBody, ['jobs'])) { + expect(rspBody).to.have.property('jobs').an(Object); + } + if (isPopulatedObject(rspBody, ['datafeeds'])) { + expect(rspBody).to.have.property('datafeeds').an(Object); + } + if (isPopulatedObject(rspBody, ['kibana'])) { + expect(rspBody).to.have.property('kibana').an(Object); + } + expect(rspBody.id).to.eql(moduleId); }); } diff --git a/x-pack/test/api_integration/apis/security_solution/index.js b/x-pack/test/api_integration/apis/security_solution/index.js index 56d52763c879..57fc71254985 100644 --- a/x-pack/test/api_integration/apis/security_solution/index.js +++ b/x-pack/test/api_integration/apis/security_solution/index.js @@ -12,6 +12,7 @@ export default function ({ loadTestFile }) { loadTestFile(require.resolve('./host_details')); loadTestFile(require.resolve('./kpi_network')); loadTestFile(require.resolve('./kpi_hosts')); + loadTestFile(require.resolve('./matrix_dns_histogram')); loadTestFile(require.resolve('./network_details')); loadTestFile(require.resolve('./network_dns')); loadTestFile(require.resolve('./network_top_n_flow')); diff --git a/x-pack/test/api_integration/apis/security_solution/matrix_dns_histogram.ts b/x-pack/test/api_integration/apis/security_solution/matrix_dns_histogram.ts new file mode 100644 index 000000000000..69beb65dec67 --- /dev/null +++ b/x-pack/test/api_integration/apis/security_solution/matrix_dns_histogram.ts @@ -0,0 +1,106 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import request from 'superagent'; + +import { + MatrixHistogramQuery, + MatrixHistogramType, +} from '../../../../plugins/security_solution/common/search_strategy'; + +import { FtrProviderContext } from '../../ftr_provider_context'; + +/** + * Function copied from here: + * test/api_integration/apis/search/bsearch.ts + * + * Splits the JSON lines from bsearch + */ +export const parseBfetchResponse = (resp: request.Response): Array> => { + return resp.text + .trim() + .split('\n') + .map((item) => JSON.parse(item)); +}; + +export default function ({ getService }: FtrProviderContext) { + const esArchiver = getService('esArchiver'); + const supertest = getService('supertest'); + const retry = getService('retry'); + + describe('Matrix DNS Histogram', () => { + describe('Large data set', () => { + before(() => esArchiver.load('security_solution/matrix_dns_histogram/large_dns_query')); + after(() => esArchiver.unload('security_solution/matrix_dns_histogram/large_dns_query')); + + const FROM = '2000-01-01T00:00:00.000Z'; + const TO = '3000-01-01T00:00:00.000Z'; + + it('Make sure that we get dns data without getting bucket errors when querying large volume of data', async () => { + const { body: networkDns } = await supertest + .post('/internal/search/securitySolutionSearchStrategy/') + .set('kbn-xsrf', 'true') + .send({ + defaultIndex: ['large_volume_dns_data'], + docValueFields: [], + factoryQueryType: MatrixHistogramQuery, + histogramType: MatrixHistogramType.dns, + filterQuery: + '{"bool":{"must":[],"filter":[{"match_all":{}}],"should":[],"must_not":[]}}', + isPtrIncluded: false, + timerange: { + interval: '12h', + to: TO, + from: FROM, + }, + }) + .expect(200); + + if (networkDns.isRunning === true) { + await retry.waitForWithTimeout('bsearch to give us results', 5000, async () => { + const resp = await supertest + .post('/internal/bsearch') + .set('kbn-xsrf', 'true') + .send({ + batch: [ + { + request: { + id: networkDns.id, + defaultIndex: ['large_volume_dns_data'], + docValueFields: [], + factoryQueryType: MatrixHistogramQuery, + histogramType: MatrixHistogramType.dns, + filterQuery: + '{"bool":{"must":[],"filter":[{"match_all":{}}],"should":[],"must_not":[]}}', + isPtrIncluded: false, + timerange: { + interval: '12h', + to: TO, + from: FROM, + }, + }, + options: { + strategy: 'securitySolutionSearchStrategy', + }, + }, + ], + }); + const parsedResponse = parseBfetchResponse(resp); + expect(parsedResponse[0].result.rawResponse.aggregations.dns_count.value).to.equal( + 6604 + ); + return true; + }); + } else { + expect(networkDns.isRunning).to.equal(false); + expect(networkDns.rawResponse.aggregations.dns_count.value).to.equal(6604); + } + }); + }); + }); +} diff --git a/x-pack/test/api_integration/apis/transform/transforms_nodes.ts b/x-pack/test/api_integration/apis/transform/transforms_nodes.ts index 593a1fb8fb72..ca9ab8e8a728 100644 --- a/x-pack/test/api_integration/apis/transform/transforms_nodes.ts +++ b/x-pack/test/api_integration/apis/transform/transforms_nodes.ts @@ -20,14 +20,14 @@ export default ({ getService }: FtrProviderContext) => { const expected = { apiTransformTransformsNodes: { - count: 1, + minCount: 1, }, }; function assertTransformsNodesResponseBody(body: GetTransformNodesResponseSchema) { expect(isGetTransformNodesResponseSchema(body)).to.eql(true); - expect(body.count).to.eql(expected.apiTransformTransformsNodes.count); + expect(body.count).to.not.be.lessThan(expected.apiTransformTransformsNodes.minCount); } describe('/api/transform/transforms/_nodes', function () { diff --git a/x-pack/test/fleet_api_integration/apis/agents/reassign.ts b/x-pack/test/fleet_api_integration/apis/agents/reassign.ts index 5737794eefea..47bafd57ea3a 100644 --- a/x-pack/test/fleet_api_integration/apis/agents/reassign.ts +++ b/x-pack/test/fleet_api_integration/apis/agents/reassign.ts @@ -21,6 +21,7 @@ export default function (providerContext: FtrProviderContext) { beforeEach(async () => { await esArchiver.unload('fleet/empty_fleet_server'); await esArchiver.load('fleet/agents'); + await getService('supertest').post(`/api/fleet/setup`).set('kbn-xsrf', 'xxx').send(); }); setupFleetAndAgents(providerContext); afterEach(async () => { @@ -181,7 +182,7 @@ export default function (providerContext: FtrProviderContext) { .post(`/api/fleet/agents/bulk_reassign`) .set('kbn-xsrf', 'xxx') .send({ - agents: 'fleet-agents.active: true', + agents: 'active: true', policy_id: 'policy2', }) .expect(200); diff --git a/x-pack/test/fleet_api_integration/apis/agents/unenroll.ts b/x-pack/test/fleet_api_integration/apis/agents/unenroll.ts index d7e16b7e7224..60a588090048 100644 --- a/x-pack/test/fleet_api_integration/apis/agents/unenroll.ts +++ b/x-pack/test/fleet_api_integration/apis/agents/unenroll.ts @@ -29,6 +29,7 @@ export default function (providerContext: FtrProviderContext) { beforeEach(async () => { await esArchiver.unload('fleet/empty_fleet_server'); await esArchiver.load('fleet/agents'); + await getService('supertest').post(`/api/fleet/setup`).set('kbn-xsrf', 'xxx').send(); const { body: accessAPIKeyBody } = await esClient.security.createApiKey({ body: { name: `test access api key: ${uuid.v4()}`, @@ -94,12 +95,12 @@ export default function (providerContext: FtrProviderContext) { await supertest.post(`/api/fleet/agents/agent1/unenroll`).set('kbn-xsrf', 'xxx').expect(200); }); - it('/agents/{agent_id}/unenroll { force: true } should invalidate related API keys', async () => { + it('/agents/{agent_id}/unenroll { revoke: true } should invalidate related API keys', async () => { await supertest .post(`/api/fleet/agents/agent1/unenroll`) .set('kbn-xsrf', 'xxx') .send({ - force: true, + revoke: true, }) .expect(200); @@ -116,7 +117,7 @@ export default function (providerContext: FtrProviderContext) { expect(outputAPIKeys[0].invalidated).eql(true); }); - it('/agents/{agent_id}/bulk_unenroll should not allow unenroll from managed policy', async () => { + it('/agents/bulk_unenroll should not allow unenroll from managed policy', async () => { // set policy to managed await supertest .put(`/api/fleet/agent_policies/policy1`) @@ -157,7 +158,7 @@ export default function (providerContext: FtrProviderContext) { expect(agent2data.body.item.active).to.eql(true); }); - it('/agents/{agent_id}/bulk_unenroll should allow to unenroll multiple agents by id from an unmanaged policy', async () => { + it('/agents/bulk_unenroll should allow to unenroll multiple agents by id from an unmanaged policy', async () => { // set policy to unmanaged await supertest .put(`/api/fleet/agent_policies/policy1`) @@ -187,13 +188,13 @@ export default function (providerContext: FtrProviderContext) { expect(agent2data.body.item.active).to.eql(true); }); - it('/agents/{agent_id}/bulk_unenroll should allow to unenroll multiple agents by kuery', async () => { + it('/agents/bulk_unenroll should allow to unenroll multiple agents by kuery', async () => { await supertest .post(`/api/fleet/agents/bulk_unenroll`) .set('kbn-xsrf', 'xxx') .send({ - agents: 'fleet-agents.active: true', - force: true, + agents: 'active: true', + revoke: true, }) .expect(200); diff --git a/x-pack/test/fleet_api_integration/apis/agents/upgrade.ts b/x-pack/test/fleet_api_integration/apis/agents/upgrade.ts index 008614f07551..545399134c79 100644 --- a/x-pack/test/fleet_api_integration/apis/agents/upgrade.ts +++ b/x-pack/test/fleet_api_integration/apis/agents/upgrade.ts @@ -167,7 +167,7 @@ export default function (providerContext: FtrProviderContext) { it('should respond 400 if trying to upgrade an agent that is unenrolling', async () => { const kibanaVersion = await kibanaServer.version.get(); await supertest.post(`/api/fleet/agents/agent1/unenroll`).set('kbn-xsrf', 'xxx').send({ - force: true, + revoke: true, }); await supertest .post(`/api/fleet/agents/agent1/upgrade`) @@ -331,7 +331,7 @@ export default function (providerContext: FtrProviderContext) { it('should not upgrade an unenrolling agent during bulk_upgrade', async () => { const kibanaVersion = await kibanaServer.version.get(); await supertest.post(`/api/fleet/agents/agent1/unenroll`).set('kbn-xsrf', 'xxx').send({ - force: true, + revoke: true, }); await es.update({ id: 'agent1', diff --git a/x-pack/test/fleet_api_integration/apis/enrollment_api_keys/crud.ts b/x-pack/test/fleet_api_integration/apis/enrollment_api_keys/crud.ts index d9946bb174f5..5f38a6e050f4 100644 --- a/x-pack/test/fleet_api_integration/apis/enrollment_api_keys/crud.ts +++ b/x-pack/test/fleet_api_integration/apis/enrollment_api_keys/crud.ts @@ -37,7 +37,7 @@ export default function (providerContext: FtrProviderContext) { .get(`/api/fleet/enrollment-api-keys`) .expect(200); - expect(apiResponse.total).to.be(4); + expect(apiResponse.total).to.be(3); expect(apiResponse.list[0]).to.have.keys('id', 'api_key_id', 'name'); }); }); diff --git a/x-pack/test/fleet_api_integration/apis/fleet_setup.ts b/x-pack/test/fleet_api_integration/apis/fleet_setup.ts index 4c16a4fbd1cf..762a9f5302ce 100644 --- a/x-pack/test/fleet_api_integration/apis/fleet_setup.ts +++ b/x-pack/test/fleet_api_integration/apis/fleet_setup.ts @@ -64,59 +64,6 @@ export default function (providerContext: FtrProviderContext) { } }); - it('should update the fleet_enroll role with new index permissions if one does already exist', async () => { - try { - await es.security.putRole({ - name: 'fleet_enroll', - body: { - cluster: ['monitor', 'manage_api_key'], - indices: [ - { - names: ['logs-*', 'metrics-*', 'traces-*'], - privileges: ['create_doc', 'indices:admin/auto_create'], - allow_restricted_indices: false, - }, - ], - applications: [], - run_as: [], - metadata: {}, - // @ts-expect-error @elastic/elasticsearch PutRoleRequest.body doesn't declare transient_metadata property - transient_metadata: { enabled: true }, - }, - }); - } catch (e) { - if (e.meta?.statusCode !== 404) { - throw e; - } - } - - const { body: apiResponse } = await supertest - .post(`/api/fleet/setup`) - .set('kbn-xsrf', 'xxxx') - .expect(200); - - expect(apiResponse.isInitialized).to.be(true); - - const { body: roleResponse } = await es.security.getRole({ - name: 'fleet_enroll', - }); - expect(roleResponse).to.have.key('fleet_enroll'); - expect(roleResponse.fleet_enroll).to.eql({ - cluster: ['monitor', 'manage_api_key'], - indices: [ - { - names: ['logs-*', 'metrics-*', 'traces-*', '.logs-endpoint.diagnostic.collection-*'], - privileges: ['auto_configure', 'create_doc'], - allow_restricted_indices: false, - }, - ], - applications: [], - run_as: [], - metadata: {}, - transient_metadata: { enabled: true }, - }); - }); - it('should install default packages', async () => { await supertest.post(`/api/fleet/setup`).set('kbn-xsrf', 'xxxx').expect(200); diff --git a/x-pack/test/functional/apps/maps/import_geojson/add_layer_import_panel.js b/x-pack/test/functional/apps/maps/import_geojson/add_layer_import_panel.js index 5af0a2c6d1ed..7bdaa3898aa4 100644 --- a/x-pack/test/functional/apps/maps/import_geojson/add_layer_import_panel.js +++ b/x-pack/test/functional/apps/maps/import_geojson/add_layer_import_panel.js @@ -17,11 +17,7 @@ export default function ({ getPageObjects, getService }) { describe('GeoJSON import layer panel', () => { before(async () => { - await security.testUser.setRoles([ - 'global_maps_all', - 'geoall_data_writer', - 'global_index_pattern_management_all', - ]); + await security.testUser.setRoles(['global_maps_all', 'global_index_pattern_management_all']); await PageObjects.maps.openNewMap(); }); diff --git a/x-pack/test/functional/apps/maps/mvt_scaling.js b/x-pack/test/functional/apps/maps/mvt_scaling.js index 83467ed72658..d0e2ddd0ae9f 100644 --- a/x-pack/test/functional/apps/maps/mvt_scaling.js +++ b/x-pack/test/functional/apps/maps/mvt_scaling.js @@ -29,9 +29,11 @@ export default function ({ getPageObjects, getService }) { const mapboxStyle = await PageObjects.maps.getMapboxStyle(); //Source should be correct - expect(mapboxStyle.sources[VECTOR_SOURCE_ID].tiles[0]).to.equal( - '/api/maps/mvt/getTile?x={x}&y={y}&z={z}&geometryFieldName=geometry&index=geo_shapes*&requestBody=(_source:!(geometry),docvalue_fields:!(prop1),query:(bool:(filter:!((match_all:())),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10001,stored_fields:!(geometry,prop1))&geoFieldType=geo_shape' - ); + expect( + mapboxStyle.sources[VECTOR_SOURCE_ID].tiles[0].startsWith( + `/api/maps/mvt/getTile/{z}/{x}/{y}.pbf?geometryFieldName=geometry&index=geo_shapes*&requestBody=(_source:!(geometry),docvalue_fields:!(prop1),query:(bool:(filter:!((match_all:())),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(),size:10001,stored_fields:!(geometry,prop1))&geoFieldType=geo_shape` + ) + ).to.equal(true); //Should correctly load meta for style-rule (sigma is set to 1, opacity to 1) const fillLayer = mapboxStyle.layers.find((layer) => layer.id === VECTOR_SOURCE_ID + '_fill'); diff --git a/x-pack/test/functional/apps/maps/mvt_super_fine.js b/x-pack/test/functional/apps/maps/mvt_super_fine.js index 0f18ac8ac72e..8608b62dee8f 100644 --- a/x-pack/test/functional/apps/maps/mvt_super_fine.js +++ b/x-pack/test/functional/apps/maps/mvt_super_fine.js @@ -32,9 +32,11 @@ export default function ({ getPageObjects, getService }) { const mapboxStyle = await PageObjects.maps.getMapboxStyle(); //Source should be correct - expect(mapboxStyle.sources[MB_VECTOR_SOURCE_ID].tiles[0]).to.equal( - "/api/maps/mvt/getGridTile?x={x}&y={y}&z={z}&geometryFieldName=geo.coordinates&index=logstash-*&requestBody=(_source:(excludes:!()),aggs:(gridSplit:(aggs:(gridCentroid:(geo_centroid:(field:geo.coordinates)),max_of_bytes:(max:(field:bytes))),geotile_grid:(bounds:!n,field:geo.coordinates,precision:!n,shard_size:65535,size:65535))),fields:!((field:'@timestamp',format:date_time),(field:'relatedContent.article:modified_time',format:date_time),(field:'relatedContent.article:published_time',format:date_time),(field:utc_time,format:date_time)),query:(bool:(filter:!((match_all:()),(range:('@timestamp':(format:strict_date_optional_time,gte:'2015-09-20T00:00:00.000Z',lte:'2015-09-20T01:00:00.000Z')))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(hour_of_day:(script:(lang:painless,source:'doc[!'@timestamp!'].value.getHour()'))),size:0,stored_fields:!('*'))&requestType=grid&geoFieldType=geo_point" - ); + expect( + mapboxStyle.sources[MB_VECTOR_SOURCE_ID].tiles[0].startsWith( + `/api/maps/mvt/getGridTile/{z}/{x}/{y}.pbf?geometryFieldName=geo.coordinates&index=logstash-*&requestBody=(_source:(excludes:!()),aggs:(gridSplit:(aggs:(gridCentroid:(geo_centroid:(field:geo.coordinates)),max_of_bytes:(max:(field:bytes))),geotile_grid:(bounds:!n,field:geo.coordinates,precision:!n,shard_size:65535,size:65535))),fields:!((field:'@timestamp',format:date_time),(field:'relatedContent.article:modified_time',format:date_time),(field:'relatedContent.article:published_time',format:date_time),(field:utc_time,format:date_time)),query:(bool:(filter:!((match_all:()),(range:('@timestamp':(format:strict_date_optional_time,gte:'2015-09-20T00:00:00.000Z',lte:'2015-09-20T01:00:00.000Z')))),must:!(),must_not:!(),should:!())),runtime_mappings:(),script_fields:(hour_of_day:(script:(lang:painless,source:'doc[!'@timestamp!'].value.getHour()'))),size:0,stored_fields:!('*'))&requestType=grid&geoFieldType=geo_point` + ) + ).to.equal(true); //Should correctly load meta for style-rule (sigma is set to 1, opacity to 1) const fillLayer = mapboxStyle.layers.find( diff --git a/x-pack/test/functional/apps/maps/sample_data.js b/x-pack/test/functional/apps/maps/sample_data.js index 0c0af2affe50..10e760fa9d94 100644 --- a/x-pack/test/functional/apps/maps/sample_data.js +++ b/x-pack/test/functional/apps/maps/sample_data.js @@ -13,12 +13,22 @@ export default function ({ getPageObjects, getService, updateBaselines }) { const screenshot = getService('screenshots'); const testSubjects = getService('testSubjects'); const kibanaServer = getService('kibanaServer'); + const security = getService('security'); // Only update the baseline images from Jenkins session images after comparing them // These tests might fail locally because of scaling factors and resolution. describe('maps loaded from sample data', () => { before(async () => { + //installing the sample data with test user with super user role and then switching roles with limited privileges + await security.testUser.setRoles(['superuser'], false); + await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { + useActualUrl: true, + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + await PageObjects.home.addSampleDataSet('ecommerce'); + await PageObjects.home.addSampleDataSet('flights'); + await PageObjects.home.addSampleDataSet('logs'); const SAMPLE_DATA_RANGE = `[ { "from": "now-30d", @@ -80,15 +90,23 @@ export default function ({ getPageObjects, getService, updateBaselines }) { await kibanaServer.uiSettings.update({ [UI_SETTINGS.TIMEPICKER_QUICK_RANGES]: SAMPLE_DATA_RANGE, }); + //running the rest of the tests with limited roles + await security.testUser.setRoles(['global_maps_all', 'kibana_sample_read'], false); + }); + + after(async () => { + await security.testUser.restoreDefaults(); + await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { + useActualUrl: true, + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + await PageObjects.home.removeSampleDataSet('ecommerce'); + await PageObjects.home.removeSampleDataSet('flights'); + await PageObjects.home.removeSampleDataSet('logs'); }); describe('ecommerce', () => { before(async () => { - await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { - useActualUrl: true, - }); - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.home.addSampleDataSet('ecommerce'); await PageObjects.maps.loadSavedMap('[eCommerce] Orders by Country'); await PageObjects.maps.toggleLayerVisibility('Road map'); await PageObjects.maps.toggleLayerVisibility('United Kingdom'); @@ -104,11 +122,6 @@ export default function ({ getPageObjects, getService, updateBaselines }) { after(async () => { await PageObjects.maps.existFullScreen(); - await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { - useActualUrl: true, - }); - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.home.removeSampleDataSet('ecommerce'); }); it('should load layers', async () => { @@ -122,11 +135,6 @@ export default function ({ getPageObjects, getService, updateBaselines }) { describe('flights', () => { before(async () => { - await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { - useActualUrl: true, - }); - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.home.addSampleDataSet('flights'); await PageObjects.maps.loadSavedMap('[Flights] Origin and Destination Flight Time'); await PageObjects.maps.toggleLayerVisibility('Road map'); await PageObjects.timePicker.setCommonlyUsedTime('sample_data range'); @@ -138,11 +146,6 @@ export default function ({ getPageObjects, getService, updateBaselines }) { after(async () => { await PageObjects.maps.existFullScreen(); - await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { - useActualUrl: true, - }); - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.home.removeSampleDataSet('flights'); }); it('should load saved object and display layers', async () => { @@ -156,11 +159,6 @@ export default function ({ getPageObjects, getService, updateBaselines }) { describe('web logs', () => { before(async () => { - await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { - useActualUrl: true, - }); - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.home.addSampleDataSet('logs'); await PageObjects.maps.loadSavedMap('[Logs] Total Requests and Bytes'); await PageObjects.maps.toggleLayerVisibility('Road map'); await PageObjects.maps.toggleLayerVisibility('Total Requests by Country'); @@ -173,11 +171,6 @@ export default function ({ getPageObjects, getService, updateBaselines }) { after(async () => { await PageObjects.maps.existFullScreen(); - await PageObjects.common.navigateToUrl('home', '/tutorial_directory/sampleData', { - useActualUrl: true, - }); - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.home.removeSampleDataSet('logs'); }); it('should load saved object and display layers', async () => { diff --git a/x-pack/test/functional/apps/ml/anomaly_detection/anomaly_explorer.ts b/x-pack/test/functional/apps/ml/anomaly_detection/anomaly_explorer.ts index c86a875be641..66d45c801b81 100644 --- a/x-pack/test/functional/apps/ml/anomaly_detection/anomaly_explorer.ts +++ b/x-pack/test/functional/apps/ml/anomaly_detection/anomaly_explorer.ts @@ -5,7 +5,6 @@ * 2.0. */ -import expect from '@kbn/expect'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { Job, Datafeed } from '../../../../../plugins/ml/common/types/anomaly_detection_jobs'; @@ -235,8 +234,7 @@ export default function ({ getService }: FtrProviderContext) { await ml.testExecution.logTestStep('updates pagination'); await ml.swimLane.setPageSize(viewBySwimLaneTestSubj, 5); - const axisLabels = await ml.swimLane.getAxisLabels(viewBySwimLaneTestSubj, 'y'); - expect(axisLabels.length).to.eql(5); + await ml.swimLane.assertAxisLabelCount(viewBySwimLaneTestSubj, 'y', 5); await ml.swimLane.selectPage(viewBySwimLaneTestSubj, 3); diff --git a/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/README.md b/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/README.md new file mode 100644 index 000000000000..809732554fbc --- /dev/null +++ b/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/README.md @@ -0,0 +1,32 @@ +Within this folder is input test data for tests specific to the matrix dns +search strategy and for either corner cases, bugs found on customer sites, or correctness. When possible the mappings should be small and concise but ECS compliant here for these +types of tests. If small, do not gzip them, if large then please do gzip them. + +Script that might be helpful if you have to maintain this test at some point to +generate a large set of values + +```sh +#!/bin/sh + +for i in {1..6600} +do + echo "{" + echo " \"type\": \"doc\"," + echo " \"value\": {" + echo " \"id\": \"$i\"," + echo " \"index\": \"large_volume_dns_data\"," + echo " \"source\": {" + echo " \"@timestamp\": \"2020-10-28T05:00:53.000Z\"," + echo " \"dns\": {" + echo " \"question\": {" + echo " \"registered_domain\": \"domain_$i\"," + echo " \"name\": \"domain_$i\"" + echo " }" + echo " }" + echo " }," + echo " \"type\": \"_doc\"" + echo " }" + echo "}" + echo "" +done +``` \ No newline at end of file diff --git a/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/large_dns_query/data.json.gz b/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/large_dns_query/data.json.gz new file mode 100644 index 000000000000..6c174e4e52dc Binary files /dev/null and b/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/large_dns_query/data.json.gz differ diff --git a/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/large_dns_query/mappings.json b/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/large_dns_query/mappings.json new file mode 100644 index 000000000000..6360204048e0 --- /dev/null +++ b/x-pack/test/functional/es_archives/security_solution/matrix_dns_histogram/large_dns_query/mappings.json @@ -0,0 +1,35 @@ +{ + "type": "index", + "value": { + "index": "large_volume_dns_data", + "mappings": { + "dynamic": "strict", + "properties": { + "@timestamp": { + "type": "date" + }, + "dns": { + "properties": { + "question": { + "properties": { + "name": { + "type": "keyword" + }, + "registered_domain": { + "type": "keyword" + } + } + } + } + } + } + }, + "settings": { + "refresh_interval": "5s", + "index": { + "number_of_replicas": "1", + "number_of_shards": "1" + } + } + } +} diff --git a/x-pack/test/functional/services/ml/swim_lane.ts b/x-pack/test/functional/services/ml/swim_lane.ts index 29918b83cd27..ac9568987286 100644 --- a/x-pack/test/functional/services/ml/swim_lane.ts +++ b/x-pack/test/functional/services/ml/swim_lane.ts @@ -17,6 +17,7 @@ export function SwimLaneProvider({ getService }: FtrProviderContext) { const elasticChart = getService('elasticChart'); const browser = getService('browser'); const testSubjects = getService('testSubjects'); + const retry = getService('retry'); /** * Y axis labels width + padding @@ -90,6 +91,16 @@ export function SwimLaneProvider({ getService }: FtrProviderContext) { ); }, + async assertAxisLabelCount(testSubj: string, axis: 'x' | 'y', expectedCount: number) { + await retry.tryForTime(5000, async () => { + const actualValues = await this.getAxisLabels(testSubj, axis); + expect(actualValues.length).to.eql( + expectedCount, + `Expected swim lane ${axis} label count to be ${expectedCount}, got ${actualValues}` + ); + }); + }, + async getCells(testSubj: string): Promise { const state = await this.getDebugState(testSubj); return state.heatmap.cells; diff --git a/x-pack/test/reporting_api_integration/ftr_provider_context.d.ts b/x-pack/test/reporting_api_integration/ftr_provider_context.d.ts index 809f464289ff..671866cad6ff 100644 --- a/x-pack/test/reporting_api_integration/ftr_provider_context.d.ts +++ b/x-pack/test/reporting_api_integration/ftr_provider_context.d.ts @@ -6,7 +6,6 @@ */ import { GenericFtrProviderContext } from '@kbn/test/types/ftr'; -import { pageObjects } from '../functional/page_objects'; // Reporting APIs depend on UI functionality import { services } from './services'; -export type FtrProviderContext = GenericFtrProviderContext; +export type FtrProviderContext = GenericFtrProviderContext; diff --git a/x-pack/test/reporting_api_integration/reporting_and_security.config.ts b/x-pack/test/reporting_api_integration/reporting_and_security.config.ts index ddd6fe046dd3..623799c84d86 100644 --- a/x-pack/test/reporting_api_integration/reporting_and_security.config.ts +++ b/x-pack/test/reporting_api_integration/reporting_and_security.config.ts @@ -5,16 +5,14 @@ * 2.0. */ -// @ts-expect-error https://github.com/elastic/kibana/issues/95679 -import { esTestConfig, kbnTestConfig, kibanaServerTestUser } from '@kbn/test'; import { FtrConfigProviderContext } from '@kbn/test/types/ftr'; -import { format as formatUrl } from 'url'; +import { resolve } from 'path'; import { ReportingAPIProvider } from './services'; export default async function ({ readConfigFile }: FtrConfigProviderContext) { const apiConfig = await readConfigFile(require.resolve('../api_integration/config')); - const functionalConfig = await readConfigFile(require.resolve('../functional/config')); // Reporting API tests need a fully working UI + // config for testing network policy const testPolicyRules = [ { allow: true, protocol: 'http:' }, { allow: false, host: 'via.placeholder.com' }, @@ -24,9 +22,9 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) { ]; return { - servers: apiConfig.get('servers'), + ...apiConfig.getAll(), junit: { reportName: 'X-Pack Reporting API Integration Tests' }, - testFiles: [require.resolve('./reporting_and_security')], + testFiles: [resolve(__dirname, './reporting_and_security')], services: { ...apiConfig.get('services'), reportingAPI: ReportingAPIProvider, @@ -34,22 +32,11 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) { kbnTestServer: { ...apiConfig.get('kbnTestServer'), serverArgs: [ - ...functionalConfig.get('kbnTestServer.serverArgs'), - - `--elasticsearch.hosts=${formatUrl(esTestConfig.getUrlParts())}`, - `--elasticsearch.password=${kibanaServerTestUser.password}`, - `--elasticsearch.username=${kibanaServerTestUser.username}`, - `--logging.json=false`, - `--server.maxPayloadBytes=1679958`, - `--server.port=${kbnTestConfig.getPort()}`, + ...apiConfig.get('kbnTestServer.serverArgs'), + `--xpack.reporting.capture.networkPolicy.rules=${JSON.stringify(testPolicyRules)}`, `--xpack.reporting.capture.maxAttempts=1`, `--xpack.reporting.csv.maxSizeBytes=6000`, - `--xpack.reporting.queue.pollInterval=3000`, - `--xpack.security.session.idleTimeout=3600000`, - `--xpack.reporting.capture.networkPolicy.rules=${JSON.stringify(testPolicyRules)}`, ], }, - esArchiver: apiConfig.get('esArchiver'), - esTestCluster: apiConfig.get('esTestCluster'), }; } diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/__snapshots__/csv_searchsource_immediate.snap b/x-pack/test/reporting_api_integration/reporting_and_security/__snapshots__/download_csv_dashboard.snap similarity index 100% rename from x-pack/test/reporting_api_integration/reporting_and_security/__snapshots__/csv_searchsource_immediate.snap rename to x-pack/test/reporting_api_integration/reporting_and_security/__snapshots__/download_csv_dashboard.snap diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts b/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts deleted file mode 100644 index f765046bce9b..000000000000 --- a/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { REPO_ROOT } from '@kbn/utils'; -import path from 'path'; - -export const OSS_KIBANA_ARCHIVE_PATH = path.resolve( - REPO_ROOT, - 'test/functional/fixtures/es_archiver/dashboard/current/kibana' -); -export const OSS_DATA_ARCHIVE_PATH = path.resolve( - REPO_ROOT, - 'test/functional/fixtures/es_archiver/dashboard/current/data' -); diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/csv_searchsource_immediate.ts b/x-pack/test/reporting_api_integration/reporting_and_security/download_csv_dashboard.ts similarity index 94% rename from x-pack/test/reporting_api_integration/reporting_and_security/csv_searchsource_immediate.ts rename to x-pack/test/reporting_api_integration/reporting_and_security/download_csv_dashboard.ts index f381bc1edd28..7f642f171b9f 100644 --- a/x-pack/test/reporting_api_integration/reporting_and_security/csv_searchsource_immediate.ts +++ b/x-pack/test/reporting_api_integration/reporting_and_security/download_csv_dashboard.ts @@ -38,15 +38,14 @@ export default function ({ getService }: FtrProviderContext) { 'dateFormat:tz': 'UTC', defaultIndex: 'logstash-*', }); + await reportingAPI.initEcommerce(); }); after(async () => { + await reportingAPI.teardownEcommerce(); await reportingAPI.deleteAllReports(); }); it('Exports CSV with almost all fields when using fieldsFromSource', async () => { - await esArchiver.load('reporting/ecommerce'); - await esArchiver.load('reporting/ecommerce_kibana'); - const { status: resStatus, text: resText, @@ -145,15 +144,9 @@ export default function ({ getService }: FtrProviderContext) { expect(resStatus).to.eql(200); expect(resType).to.eql('text/csv'); expectSnapshot(resText).toMatch(); - - await esArchiver.unload('reporting/ecommerce'); - await esArchiver.unload('reporting/ecommerce_kibana'); }); it('Exports CSV with all fields when using defaults', async () => { - await esArchiver.load('reporting/ecommerce'); - await esArchiver.load('reporting/ecommerce_kibana'); - const { status: resStatus, text: resText, @@ -192,15 +185,9 @@ export default function ({ getService }: FtrProviderContext) { expect(resStatus).to.eql(200); expect(resType).to.eql('text/csv'); expectSnapshot(resText).toMatch(); - - await esArchiver.unload('reporting/ecommerce'); - await esArchiver.unload('reporting/ecommerce_kibana'); }); it('Logs the error explanation if the search query returns an error', async () => { - await esArchiver.load('reporting/ecommerce'); - await esArchiver.load('reporting/ecommerce_kibana'); - const { status: resStatus, text: resText } = (await generateAPI.getCSVFromSearchSource( getMockJobParams({ searchSource: { @@ -234,9 +221,6 @@ export default function ({ getService }: FtrProviderContext) { )) as supertest.Response; expect(resStatus).to.eql(500); expectSnapshot(resText).toMatch(); - - await esArchiver.unload('reporting/ecommerce'); - await esArchiver.unload('reporting/ecommerce_kibana'); }); describe('date formatting', () => { @@ -434,6 +418,9 @@ export default function ({ getService }: FtrProviderContext) { }); describe('validation', () => { + after(async () => { + await reportingAPI.deleteAllReports(); + }); it('Return a 404', async () => { const { body } = (await generateAPI.getCSVFromSearchSource( getMockJobParams({ @@ -451,8 +438,7 @@ export default function ({ getService }: FtrProviderContext) { }); it(`Searches large amount of data, stops at Max Size Reached`, async () => { - await esArchiver.load('reporting/ecommerce'); - await esArchiver.load('reporting/ecommerce_kibana'); + await reportingAPI.initEcommerce(); const { status: resStatus, @@ -504,8 +490,7 @@ export default function ({ getService }: FtrProviderContext) { expect(resType).to.eql('text/csv'); expectSnapshot(resText).toMatch(); - await esArchiver.unload('reporting/ecommerce'); - await esArchiver.unload('reporting/ecommerce_kibana'); + await reportingAPI.teardownEcommerce(); }); }); }); diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/csv_job_params.ts b/x-pack/test/reporting_api_integration/reporting_and_security/generate_csv_discover.ts similarity index 97% rename from x-pack/test/reporting_api_integration/reporting_and_security/csv_job_params.ts rename to x-pack/test/reporting_api_integration/reporting_and_security/generate_csv_discover.ts index b3fa9ebe46f8..3370eb0bb398 100644 --- a/x-pack/test/reporting_api_integration/reporting_and_security/csv_job_params.ts +++ b/x-pack/test/reporting_api_integration/reporting_and_security/generate_csv_discover.ts @@ -7,7 +7,7 @@ import expect from '@kbn/expect'; import supertest from 'supertest'; -import { JOB_PARAMS_RISON_CSV_DEPRECATED } from '../fixtures'; +import { JOB_PARAMS_RISON_CSV_DEPRECATED } from '../services/fixtures'; import { FtrProviderContext } from '../ftr_provider_context'; // eslint-disable-next-line import/no-default-export diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/index.ts b/x-pack/test/reporting_api_integration/reporting_and_security/index.ts index b4e05e37d3fd..78873f2097e8 100644 --- a/x-pack/test/reporting_api_integration/reporting_and_security/index.ts +++ b/x-pack/test/reporting_api_integration/reporting_and_security/index.ts @@ -8,11 +8,20 @@ import { FtrProviderContext } from '../ftr_provider_context'; // eslint-disable-next-line import/no-default-export -export default function ({ loadTestFile }: FtrProviderContext) { +export default function ({ getService, loadTestFile }: FtrProviderContext) { describe('Reporting APIs', function () { this.tags('ciGroup2'); - loadTestFile(require.resolve('./csv_job_params')); - loadTestFile(require.resolve('./csv_searchsource_immediate')); + + before(async () => { + const reportingAPI = getService('reportingAPI'); + await reportingAPI.createDataAnalystRole(); + await reportingAPI.createDataAnalyst(); + await reportingAPI.createTestReportingUser(); + }); + + loadTestFile(require.resolve('./security_roles_privileges')); + loadTestFile(require.resolve('./download_csv_dashboard')); + loadTestFile(require.resolve('./generate_csv_discover')); loadTestFile(require.resolve('./network_policy')); loadTestFile(require.resolve('./spaces')); loadTestFile(require.resolve('./usage')); diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/security_roles_privileges.ts b/x-pack/test/reporting_api_integration/reporting_and_security/security_roles_privileges.ts new file mode 100644 index 000000000000..4dbf1b6fa5eb --- /dev/null +++ b/x-pack/test/reporting_api_integration/reporting_and_security/security_roles_privileges.ts @@ -0,0 +1,192 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import supertest from 'supertest'; +import { FtrProviderContext } from '../ftr_provider_context'; + +// eslint-disable-next-line import/no-default-export +export default function ({ getService }: FtrProviderContext) { + const reportingAPI = getService('reportingAPI'); + + describe('Security Roles and Privileges for Applications', () => { + before(async () => { + await reportingAPI.initEcommerce(); + }); + after(async () => { + await reportingAPI.teardownEcommerce(); + await reportingAPI.deleteAllReports(); + }); + + describe('Dashboard: CSV download file', () => { + it('does not allow user that does not have the role-based privilege', async () => { + const res = (await reportingAPI.downloadCsv( + reportingAPI.DATA_ANALYST_USERNAME, + reportingAPI.DATA_ANALYST_PASSWORD, + { + searchSource: { + query: { query: '', language: 'kuery' }, + index: '5193f870-d861-11e9-a311-0fa548c5f953', + filter: [], + }, + browserTimezone: 'UTC', + title: 'testfooyu78yt90-', + } as any + )) as supertest.Response; + expect(res.status).to.eql(403); + }); + + it('does allow user with the role privilege', async () => { + const res = (await reportingAPI.downloadCsv( + reportingAPI.REPORTING_USER_USERNAME, + reportingAPI.REPORTING_USER_PASSWORD, + { + searchSource: { + query: { query: '', language: 'kuery' }, + index: '5193f870-d861-11e9-a311-0fa548c5f953', + filter: [], + }, + browserTimezone: 'UTC', + title: 'testfooyu78yt90-', + } as any + )) as supertest.Response; + expect(res.status).to.eql(200); + }); + }); + + describe('Dashboard: Generate PDF report', () => { + it('does not allow user that does not have the role-based privilege', async () => { + const res = await reportingAPI.generatePdf( + reportingAPI.DATA_ANALYST_USERNAME, + reportingAPI.DATA_ANALYST_PASSWORD, + { + browserTimezone: 'UTC', + title: 'test PDF disallowed', + layout: { id: 'preserve' }, + relativeUrls: ['/fooyou'], + objectType: 'dashboard', + } + ); + expect(res.status).to.eql(403); + }); + + it('does allow user with the role-based privilege', async () => { + const res = await reportingAPI.generatePdf( + reportingAPI.REPORTING_USER_USERNAME, + reportingAPI.REPORTING_USER_PASSWORD, + { + browserTimezone: 'UTC', + title: 'test PDF allowed', + layout: { id: 'preserve' }, + relativeUrls: ['/fooyou'], + objectType: 'dashboard', + } + ); + expect(res.status).to.eql(200); + }); + }); + + describe('Visualize: Generate PDF report', () => { + it('does not allow user that does not have the role-based privilege', async () => { + const res = await reportingAPI.generatePdf( + reportingAPI.DATA_ANALYST_USERNAME, + reportingAPI.DATA_ANALYST_PASSWORD, + { + browserTimezone: 'UTC', + title: 'test PDF disallowed', + layout: { id: 'preserve' }, + relativeUrls: ['/fooyou'], + objectType: 'visualization', + } + ); + expect(res.status).to.eql(403); + }); + + it('does allow user with the role-based privilege', async () => { + const res = await reportingAPI.generatePdf( + reportingAPI.REPORTING_USER_USERNAME, + reportingAPI.REPORTING_USER_PASSWORD, + { + browserTimezone: 'UTC', + title: 'test PDF allowed', + layout: { id: 'preserve' }, + relativeUrls: ['/fooyou'], + objectType: 'visualization', + } + ); + expect(res.status).to.eql(200); + }); + }); + + describe('Canvas: Generate PDF report', () => { + it('does not allow user that does not have the role-based privilege', async () => { + const res = await reportingAPI.generatePdf( + reportingAPI.DATA_ANALYST_USERNAME, + reportingAPI.DATA_ANALYST_PASSWORD, + { + browserTimezone: 'UTC', + title: 'test PDF disallowed', + layout: { id: 'preserve' }, + relativeUrls: ['/fooyou'], + objectType: 'canvas', + } + ); + expect(res.status).to.eql(403); + }); + + it('does allow user with the role-based privilege', async () => { + const res = await reportingAPI.generatePdf( + reportingAPI.REPORTING_USER_USERNAME, + reportingAPI.REPORTING_USER_PASSWORD, + { + browserTimezone: 'UTC', + title: 'test PDF allowed', + layout: { id: 'preserve' }, + relativeUrls: ['/fooyou'], + objectType: 'canvas', + } + ); + expect(res.status).to.eql(200); + }); + }); + + describe('Discover: Generate CSV report', () => { + it('does not allow user that does not have the role-based privilege', async () => { + const res = await reportingAPI.generateCsv( + reportingAPI.DATA_ANALYST_USERNAME, + reportingAPI.DATA_ANALYST_PASSWORD, + { + browserTimezone: 'UTC', + searchSource: {}, + objectType: 'search', + title: 'test disallowed', + } + ); + expect(res.status).to.eql(403); + }); + + it('does allow user with the role-based privilege', async () => { + const res = await reportingAPI.generateCsv( + reportingAPI.REPORTING_USER_USERNAME, + reportingAPI.REPORTING_USER_PASSWORD, + { + browserTimezone: 'UTC', + title: 'allowed search', + objectType: 'search', + searchSource: { + version: true, + fields: [{ field: '*', include_unmapped: 'true' }], + index: '5193f870-d861-11e9-a311-0fa548c5f953', + } as any, + columns: [], + } + ); + expect(res.status).to.eql(200); + }); + }); + }); +} diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/usage.ts b/x-pack/test/reporting_api_integration/reporting_and_security/usage.ts index 2a6bf95023fb..a69534cfc4df 100644 --- a/x-pack/test/reporting_api_integration/reporting_and_security/usage.ts +++ b/x-pack/test/reporting_api_integration/reporting_and_security/usage.ts @@ -6,10 +6,20 @@ */ import expect from '@kbn/expect'; +import { REPO_ROOT } from '@kbn/utils'; +import path from 'path'; import { FtrProviderContext } from '../ftr_provider_context'; -import * as GenerationUrls from '../generation_urls'; -import { ReportingUsageStats } from '../services'; -import { OSS_DATA_ARCHIVE_PATH, OSS_KIBANA_ARCHIVE_PATH } from './constants'; +import * as GenerationUrls from '../services/generation_urls'; +import { ReportingUsageStats } from '../services/usage'; + +const OSS_KIBANA_ARCHIVE_PATH = path.resolve( + REPO_ROOT, + 'test/functional/fixtures/es_archiver/dashboard/current/kibana' +); +const OSS_DATA_ARCHIVE_PATH = path.resolve( + REPO_ROOT, + 'test/functional/fixtures/es_archiver/dashboard/current/data' +); interface UsageStats { reporting: ReportingUsageStats; @@ -20,6 +30,7 @@ export default function ({ getService }: FtrProviderContext) { const esArchiver = getService('esArchiver'); const kibanaServer = getService('kibanaServer'); const reportingAPI = getService('reportingAPI'); + const retry = getService('retry'); const usageAPI = getService('usageAPI'); describe('Usage', () => { @@ -46,7 +57,10 @@ export default function ({ getService }: FtrProviderContext) { let usage: UsageStats; before(async () => { - usage = (await usageAPI.getUsageStats()) as UsageStats; + await retry.try(async () => { + // use retry for stability - usage API could return 503 + usage = (await usageAPI.getUsageStats()) as UsageStats; + }); }); it('shows reporting as available and enabled', async () => { diff --git a/x-pack/test/reporting_api_integration/reporting_without_security.config.ts b/x-pack/test/reporting_api_integration/reporting_without_security.config.ts index 20f9ff1b1059..b962ab30876a 100644 --- a/x-pack/test/reporting_api_integration/reporting_without_security.config.ts +++ b/x-pack/test/reporting_api_integration/reporting_without_security.config.ts @@ -5,24 +5,15 @@ * 2.0. */ -// @ts-expect-error https://github.com/elastic/kibana/issues/95679 -import { esTestConfig, kbnTestConfig } from '@kbn/test'; import { FtrConfigProviderContext } from '@kbn/test/types/ftr'; -import { format as formatUrl } from 'url'; -import { pageObjects } from '../functional/page_objects'; // Reporting APIs depend on UI functionality -import { services } from './services'; export default async function ({ readConfigFile }: FtrConfigProviderContext) { - const apiConfig = await readConfigFile(require.resolve('../api_integration/config')); + const apiConfig = await readConfigFile(require.resolve('./reporting_and_security.config')); return { - apps: { reporting: { pathname: '/app/management/insightsAndAlerting/reporting' } }, - servers: apiConfig.get('servers'), - junit: { reportName: 'X-Pack Reporting Without Security API Integration Tests' }, + ...apiConfig.getAll(), + junit: { reportName: 'X-Pack Reporting API Integration Tests Without Security Enabled' }, testFiles: [require.resolve('./reporting_without_security')], - services, - pageObjects, - esArchiver: apiConfig.get('esArchiver'), esTestCluster: { ...apiConfig.get('esTestCluster'), serverArgs: [ @@ -33,15 +24,7 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) { }, kbnTestServer: { ...apiConfig.get('kbnTestServer'), - serverArgs: [ - `--elasticsearch.hosts=${formatUrl(esTestConfig.getUrlParts())}`, - `--logging.json=false`, - `--server.maxPayloadBytes=1679958`, - `--server.port=${kbnTestConfig.getPort()}`, - `--xpack.reporting.capture.maxAttempts=1`, - `--xpack.reporting.csv.maxSizeBytes=2850`, - `--xpack.security.enabled=false`, - ], + serverArgs: [...apiConfig.get('kbnTestServer.serverArgs'), `--xpack.security.enabled=false`], }, }; } diff --git a/x-pack/test/reporting_api_integration/reporting_without_security/index.ts b/x-pack/test/reporting_api_integration/reporting_without_security/index.ts index eb0a349df7d3..15960e45d4a6 100644 --- a/x-pack/test/reporting_api_integration/reporting_without_security/index.ts +++ b/x-pack/test/reporting_api_integration/reporting_without_security/index.ts @@ -9,9 +9,8 @@ import { FtrProviderContext } from '../ftr_provider_context'; // eslint-disable-next-line import/no-default-export export default function ({ loadTestFile }: FtrProviderContext) { - describe('Reporting APIs', function () { + describe('Reporting API Integration Tests with Security disabled', function () { this.tags('ciGroup13'); loadTestFile(require.resolve('./job_apis')); - loadTestFile(require.resolve('./management')); }); } diff --git a/x-pack/test/reporting_api_integration/reporting_without_security/job_apis.ts b/x-pack/test/reporting_api_integration/reporting_without_security/job_apis.ts index 8d827f02dfd1..194a3d6d1f5b 100644 --- a/x-pack/test/reporting_api_integration/reporting_without_security/job_apis.ts +++ b/x-pack/test/reporting_api_integration/reporting_without_security/job_apis.ts @@ -7,7 +7,7 @@ import expect from '@kbn/expect'; import { forOwn } from 'lodash'; -import { JOB_PARAMS_RISON_CSV_DEPRECATED } from '../fixtures'; +import { JOB_PARAMS_RISON_CSV_DEPRECATED } from '../services/fixtures'; import { FtrProviderContext } from '../ftr_provider_context'; // eslint-disable-next-line import/no-default-export @@ -16,7 +16,7 @@ export default function ({ getService }: FtrProviderContext) { const supertestNoAuth = getService('supertestWithoutAuth'); const reportingAPI = getService('reportingAPI'); - describe('Job Listing APIs, Without Security', () => { + describe('Job Listing APIs', () => { before(async () => { await esArchiver.load('reporting/logs'); await esArchiver.load('logstash_functional'); diff --git a/x-pack/test/reporting_api_integration/fixtures.ts b/x-pack/test/reporting_api_integration/services/fixtures.ts similarity index 100% rename from x-pack/test/reporting_api_integration/fixtures.ts rename to x-pack/test/reporting_api_integration/services/fixtures.ts diff --git a/x-pack/test/reporting_api_integration/generation_urls.ts b/x-pack/test/reporting_api_integration/services/generation_urls.ts similarity index 100% rename from x-pack/test/reporting_api_integration/generation_urls.ts rename to x-pack/test/reporting_api_integration/services/generation_urls.ts diff --git a/x-pack/test/reporting_api_integration/services/index.ts b/x-pack/test/reporting_api_integration/services/index.ts new file mode 100644 index 000000000000..c0c3da4dd6ba --- /dev/null +++ b/x-pack/test/reporting_api_integration/services/index.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { services as xpackServices } from '../../functional/services'; +import { services as apiIntegrationServices } from '../../api_integration/services'; +import { FtrProviderContext } from '../ftr_provider_context'; +import { createUsageServices } from './usage'; +import { createScenarios } from './scenarios'; + +export function ReportingAPIProvider(context: FtrProviderContext) { + return { + ...createScenarios(context), + ...createUsageServices(context), + }; +} + +export const services = { + ...xpackServices, + supertestWithoutAuth: apiIntegrationServices.supertestWithoutAuth, + usageAPI: apiIntegrationServices.usageAPI, + reportingAPI: ReportingAPIProvider, +}; diff --git a/x-pack/test/reporting_api_integration/services/scenarios.ts b/x-pack/test/reporting_api_integration/services/scenarios.ts new file mode 100644 index 000000000000..d13deac3578b --- /dev/null +++ b/x-pack/test/reporting_api_integration/services/scenarios.ts @@ -0,0 +1,154 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import rison, { RisonValue } from 'rison-node'; +import { JobParamsCSV } from '../../../plugins/reporting/server/export_types/csv_searchsource/types'; +import { JobParamsDownloadCSV } from '../../../plugins/reporting/server/export_types/csv_searchsource_immediate/types'; +import { JobParamsPNG } from '../../../plugins/reporting/server/export_types/png/types'; +import { JobParamsPDF } from '../../../plugins/reporting/server/export_types/printable_pdf/types'; +import { FtrProviderContext } from '../ftr_provider_context'; + +function removeWhitespace(str: string) { + return str.replace(/\s/g, ''); +} + +export function createScenarios({ getService }: Pick) { + const security = getService('security'); + const esArchiver = getService('esArchiver'); + const log = getService('log'); + const supertest = getService('supertest'); + const esSupertest = getService('esSupertest'); + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const retry = getService('retry'); + + const DATA_ANALYST_USERNAME = 'data_analyst'; + const DATA_ANALYST_PASSWORD = 'data_analyst-password'; + const REPORTING_USER_USERNAME = 'reporting_user'; + const REPORTING_USER_PASSWORD = 'reporting_user-password'; + + const initEcommerce = async () => { + await esArchiver.load('reporting/ecommerce'); + await esArchiver.load('reporting/ecommerce_kibana'); + }; + const teardownEcommerce = async () => { + await esArchiver.unload('reporting/ecommerce'); + await esArchiver.unload('reporting/ecommerce_kibana'); + await deleteAllReports(); + }; + + const createDataAnalystRole = async () => { + await security.role.create('data_analyst', { + metadata: {}, + elasticsearch: { + cluster: [], + indices: [ + { + names: ['ecommerce'], + privileges: ['read', 'view_index_metadata'], + allow_restricted_indices: false, + }, + ], + run_as: [], + }, + kibana: [{ base: ['read'], feature: {}, spaces: ['*'] }], + }); + }; + + const createDataAnalyst = async () => { + await security.user.create('data_analyst', { + password: 'data_analyst-password', + roles: ['data_analyst'], + full_name: 'Data Analyst User', + }); + }; + + const createTestReportingUser = async () => { + await security.user.create('reporting_user', { + password: 'reporting_user-password', + roles: ['data_analyst', 'reporting_user'], + full_name: 'Reporting User', + }); + }; + + const downloadCsv = async (username: string, password: string, job: JobParamsDownloadCSV) => { + return await supertestWithoutAuth + .post(`/api/reporting/v1/generate/immediate/csv_searchsource`) + .auth(username, password) + .set('kbn-xsrf', 'xxx') + .send(job); + }; + const generatePdf = async (username: string, password: string, job: JobParamsPDF) => { + const jobParams = rison.encode((job as object) as RisonValue); + return await supertestWithoutAuth + .post(`/api/reporting/generate/printablePdf`) + .auth(username, password) + .set('kbn-xsrf', 'xxx') + .send({ jobParams }); + }; + const generatePng = async (username: string, password: string, job: JobParamsPNG) => { + const jobParams = rison.encode((job as object) as RisonValue); + return await supertestWithoutAuth + .post(`/api/reporting/generate/png`) + .auth(username, password) + .set('kbn-xsrf', 'xxx') + .send({ jobParams }); + }; + const generateCsv = async (username: string, password: string, job: JobParamsCSV) => { + const jobParams = rison.encode((job as object) as RisonValue); + return await supertestWithoutAuth + .post(`/api/reporting/generate/csv_searchsource`) + .auth(username, password) + .set('kbn-xsrf', 'xxx') + .send({ jobParams }); + }; + + const postJob = async (apiPath: string): Promise => { + log.debug(`ReportingAPI.postJob(${apiPath})`); + const { body } = await supertest + .post(removeWhitespace(apiPath)) + .set('kbn-xsrf', 'xxx') + .expect(200); + return body.path; + }; + + const postJobJSON = async (apiPath: string, jobJSON: object = {}): Promise => { + log.debug(`ReportingAPI.postJobJSON((${apiPath}): ${JSON.stringify(jobJSON)})`); + const { body } = await supertest.post(apiPath).set('kbn-xsrf', 'xxx').send(jobJSON); + return body.path; + }; + + const deleteAllReports = async () => { + log.debug('ReportingAPI.deleteAllReports'); + + // ignores 409 errs and keeps retrying + await retry.tryForTime(5000, async () => { + await esSupertest + .post('/.reporting*/_delete_by_query') + .send({ query: { match_all: {} } }) + .expect(200); + }); + }; + + return { + initEcommerce, + teardownEcommerce, + DATA_ANALYST_USERNAME, + DATA_ANALYST_PASSWORD, + REPORTING_USER_USERNAME, + REPORTING_USER_PASSWORD, + createDataAnalystRole, + createDataAnalyst, + createTestReportingUser, + downloadCsv, + generatePdf, + generatePng, + generateCsv, + postJob, + postJobJSON, + deleteAllReports, + }; +} diff --git a/x-pack/test/reporting_api_integration/services.ts b/x-pack/test/reporting_api_integration/services/usage.ts similarity index 53% rename from x-pack/test/reporting_api_integration/services.ts rename to x-pack/test/reporting_api_integration/services/usage.ts index b451a6b65fc9..ababbbf03e4c 100644 --- a/x-pack/test/reporting_api_integration/services.ts +++ b/x-pack/test/reporting_api_integration/services/usage.ts @@ -6,10 +6,7 @@ */ import expect from '@kbn/expect'; -import { indexTimestamp } from '../../plugins/reporting/server/lib/store/index_timestamp'; -import { services as xpackServices } from '../functional/services'; -import { services as apiIntegrationServices } from '../api_integration/services'; -import { FtrProviderContext } from './ftr_provider_context'; +import { FtrProviderContext } from '../ftr_provider_context'; interface PDFAppCounts { app: { @@ -38,15 +35,9 @@ interface UsageStats { reporting: ReportingUsageStats; } -function removeWhitespace(str: string) { - return str.replace(/\s/g, ''); -} - -export function ReportingAPIProvider({ getService }: FtrProviderContext) { +export function createUsageServices({ getService }: FtrProviderContext) { const log = getService('log'); const supertest = getService('supertest'); - const esSupertest = getService('esSupertest'); - const retry = getService('retry'); return { async waitForJobToFinish(downloadReportPath: string) { @@ -84,69 +75,6 @@ export function ReportingAPIProvider({ getService }: FtrProviderContext) { ); }, - async postJob(apiPath: string): Promise { - log.debug(`ReportingAPI.postJob(${apiPath})`); - const { body } = await supertest - .post(removeWhitespace(apiPath)) - .set('kbn-xsrf', 'xxx') - .expect(200); - return body.path; - }, - - async postJobJSON(apiPath: string, jobJSON: object = {}): Promise { - log.debug(`ReportingAPI.postJobJSON((${apiPath}): ${JSON.stringify(jobJSON)})`); - const { body } = await supertest.post(apiPath).set('kbn-xsrf', 'xxx').send(jobJSON); - return body.path; - }, - - /** - * - * @return {Promise} A function to call to clean up the index alias that was added. - */ - async coerceReportsIntoExistingIndex(indexName: string) { - log.debug(`ReportingAPI.coerceReportsIntoExistingIndex(${indexName})`); - - // Adding an index alias coerces the report to be generated on an existing index which means any new - // index schema won't be applied. This is important if a point release updated the schema. Reports may still - // be inserted into an existing index before the new schema is applied. - const timestampForIndex = indexTimestamp('week', '.'); - await esSupertest - .post('/_aliases') - .send({ - actions: [ - { - add: { index: indexName, alias: `.reporting-${timestampForIndex}` }, - }, - ], - }) - .expect(200); - - return async () => { - await esSupertest - .post('/_aliases') - .send({ - actions: [ - { - remove: { index: indexName, alias: `.reporting-${timestampForIndex}` }, - }, - ], - }) - .expect(200); - }; - }, - - async deleteAllReports() { - log.debug('ReportingAPI.deleteAllReports'); - - // ignores 409 errs and keeps retrying - await retry.tryForTime(5000, async () => { - await esSupertest - .post('/.reporting*/_delete_by_query') - .send({ query: { match_all: {} } }) - .expect(200); - }); - }, - expectRecentPdfAppStats(stats: UsageStats, app: string, count: number) { expect(stats.reporting.last_7_days.printable_pdf.app[app]).to.be(count); }, @@ -180,10 +108,3 @@ export function ReportingAPIProvider({ getService }: FtrProviderContext) { }, }; } - -export const services = { - ...xpackServices, - supertestWithoutAuth: apiIntegrationServices.supertestWithoutAuth, - usageAPI: apiIntegrationServices.usageAPI, - reportingAPI: ReportingAPIProvider, -}; diff --git a/x-pack/test/reporting_functional/ftr_provider_context.d.ts b/x-pack/test/reporting_functional/ftr_provider_context.d.ts new file mode 100644 index 000000000000..58ebd7108613 --- /dev/null +++ b/x-pack/test/reporting_functional/ftr_provider_context.d.ts @@ -0,0 +1,12 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { GenericFtrProviderContext } from '@kbn/test/types/ftr'; +import { pageObjects } from '../functional/page_objects'; +import { services } from './services'; + +export type FtrProviderContext = GenericFtrProviderContext; diff --git a/x-pack/test/reporting_functional/reporting_and_security.config.ts b/x-pack/test/reporting_functional/reporting_and_security.config.ts new file mode 100644 index 000000000000..1f9ec5754e0b --- /dev/null +++ b/x-pack/test/reporting_functional/reporting_and_security.config.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrConfigProviderContext } from '@kbn/test/types/ftr'; +import { resolve } from 'path'; +import { ReportingAPIProvider } from '../reporting_api_integration/services'; +import { ReportingFunctionalProvider } from './services'; + +export default async function ({ readConfigFile }: FtrConfigProviderContext) { + const functionalConfig = await readConfigFile(require.resolve('../functional/config')); // Reporting API tests need a fully working UI + const apiConfig = await readConfigFile(require.resolve('../api_integration/config')); + + return { + ...apiConfig.getAll(), + ...functionalConfig.getAll(), + junit: { reportName: 'X-Pack Reporting Functional Tests' }, + testFiles: [resolve(__dirname, './reporting_and_security')], + kbnTestServer: { + ...functionalConfig.get('kbnTestServer'), + serverArgs: [ + ...functionalConfig.get('kbnTestServer.serverArgs'), + `--xpack.reporting.capture.maxAttempts=1`, + `--xpack.reporting.csv.maxSizeBytes=6000`, + ], + }, + services: { + ...apiConfig.get('services'), + ...functionalConfig.get('services'), + reportingAPI: ReportingAPIProvider, + reportingFunctional: ReportingFunctionalProvider, + }, + }; +} diff --git a/x-pack/test/reporting_functional/reporting_and_security/index.ts b/x-pack/test/reporting_functional/reporting_and_security/index.ts new file mode 100644 index 000000000000..f3e01453b0a5 --- /dev/null +++ b/x-pack/test/reporting_functional/reporting_and_security/index.ts @@ -0,0 +1,57 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +// eslint-disable-next-line import/no-default-export +export default function ({ getService, loadTestFile }: FtrProviderContext) { + const security = getService('security'); + const createDataAnalystRole = async () => { + await security.role.create('data_analyst', { + metadata: {}, + elasticsearch: { + cluster: [], + indices: [ + { + names: ['ecommerce'], + privileges: ['read', 'view_index_metadata'], + allow_restricted_indices: false, + }, + ], + run_as: [], + }, + kibana: [{ base: ['all'], feature: {}, spaces: ['*'] }], + }); + }; + const createDataAnalyst = async () => { + await security.user.create('data_analyst', { + password: 'data_analyst-password', + roles: ['data_analyst', 'kibana_user'], + full_name: 'a kibana user called data_a', + }); + }; + const createReportingUser = async () => { + await security.user.create('reporting_user', { + password: 'reporting_user-password', + roles: ['reporting_user', 'data_analyst', 'kibana_user'], + full_name: 'a reporting user', + }); + }; + + describe('Reporting Functional Tests with Role-based Security configuration enabled', function () { + this.tags('ciGroup2'); + + before(async () => { + await createDataAnalystRole(); + await createDataAnalyst(); + await createReportingUser(); + }); + + loadTestFile(require.resolve('./security_roles_privileges')); + loadTestFile(require.resolve('./management')); + }); +} diff --git a/x-pack/test/reporting_functional/reporting_and_security/management.ts b/x-pack/test/reporting_functional/reporting_and_security/management.ts new file mode 100644 index 000000000000..dba16c798d4f --- /dev/null +++ b/x-pack/test/reporting_functional/reporting_and_security/management.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +// eslint-disable-next-line import/no-default-export +export default ({ getService, getPageObjects }: FtrProviderContext) => { + const PageObjects = getPageObjects(['common', 'reporting', 'discover']); + + const testSubjects = getService('testSubjects'); + const reportingFunctional = getService('reportingFunctional'); + + describe('Access to Management > Reporting', () => { + before(async () => { + await reportingFunctional.initEcommerce(); + }); + after(async () => { + await reportingFunctional.teardownEcommerce(); + }); + + it('does not allow user that does not have reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await PageObjects.common.navigateToApp('reporting'); + await testSubjects.missingOrFail('reportJobListing'); + }); + + it('does allow user with reporting_user role', async () => { + await reportingFunctional.loginReportingUser(); + await PageObjects.common.navigateToApp('reporting'); + await testSubjects.existOrFail('reportJobListing'); + }); + }); +}; diff --git a/x-pack/test/reporting_functional/reporting_and_security/security_roles_privileges.ts b/x-pack/test/reporting_functional/reporting_and_security/security_roles_privileges.ts new file mode 100644 index 000000000000..76ccb0147785 --- /dev/null +++ b/x-pack/test/reporting_functional/reporting_and_security/security_roles_privileges.ts @@ -0,0 +1,109 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +const DASHBOARD_TITLE = 'Ecom Dashboard'; +const SAVEDSEARCH_TITLE = 'Ecommerce Data'; +const VIS_TITLE = 'e-commerce pie chart'; +const CANVAS_TITLE = 'The Very Cool Workpad for PDF Tests'; + +// eslint-disable-next-line import/no-default-export +export default function ({ getService }: FtrProviderContext) { + const reportingFunctional = getService('reportingFunctional'); + + describe('Security with `reporting_user` built-in role', () => { + before(async () => { + await reportingFunctional.initEcommerce(); + }); + after(async () => { + await reportingFunctional.teardownEcommerce(); + }); + + describe('Dashboard: Download CSV file', () => { + it('does not allow user that does not have reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await reportingFunctional.openSavedDashboard(DASHBOARD_TITLE); + await reportingFunctional.tryDashboardDownloadCsvFail('Ecommerce Data'); + }); + + it('does allow user with reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await reportingFunctional.openSavedDashboard(DASHBOARD_TITLE); + await reportingFunctional.tryDashboardDownloadCsvSuccess('Ecommerce Data'); + }); + }); + + describe('Dashboard: Generate Screenshot', () => { + it('does not allow user that does not have reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await reportingFunctional.openSavedDashboard(DASHBOARD_TITLE); + await reportingFunctional.tryGeneratePdfFail(); + }); + + it('does allow user with reporting_user role', async () => { + await reportingFunctional.loginReportingUser(); + await reportingFunctional.openSavedDashboard(DASHBOARD_TITLE); + await reportingFunctional.tryGeneratePdfSuccess(); + }); + }); + + describe('Discover: Generate CSV', () => { + it('does not allow user that does not have reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await reportingFunctional.openSavedSearch(SAVEDSEARCH_TITLE); + await reportingFunctional.tryDiscoverCsvFail(); + }); + + it('does allow user with reporting_user role', async () => { + await reportingFunctional.loginReportingUser(); + await reportingFunctional.openSavedSearch(SAVEDSEARCH_TITLE); + await reportingFunctional.tryDiscoverCsvSuccess(); + }); + }); + + describe('Canvas: Generate PDF', () => { + const esArchiver = getService('esArchiver'); + const reportingApi = getService('reportingAPI'); + before('initialize tests', async () => { + await esArchiver.load('canvas/reports'); + }); + + after('teardown tests', async () => { + await esArchiver.unload('canvas/reports'); + await reportingApi.deleteAllReports(); + await reportingFunctional.initEcommerce(); + }); + + it('does not allow user that does not have reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await reportingFunctional.openCanvasWorkpad(CANVAS_TITLE); + await reportingFunctional.tryGeneratePdfFail(); + }); + + it('does allow user with reporting_user role', async () => { + await reportingFunctional.loginReportingUser(); + await reportingFunctional.openCanvasWorkpad(CANVAS_TITLE); + await reportingFunctional.tryGeneratePdfSuccess(); + }); + }); + + describe('Visualize Editor: Generate Screenshot', () => { + it('does not allow user that does not have reporting_user role', async () => { + await reportingFunctional.loginDataAnalyst(); + await reportingFunctional.openSavedVisualization(VIS_TITLE); + await reportingFunctional.tryGeneratePdfFail(); + }); + + it('does allow user with reporting_user role', async () => { + await reportingFunctional.loginReportingUser(); + await reportingFunctional.openSavedVisualization(VIS_TITLE); + await reportingFunctional.tryGeneratePdfSuccess(); + }); + }); + }); +} diff --git a/x-pack/test/reporting_functional/reporting_without_security.config.ts b/x-pack/test/reporting_functional/reporting_without_security.config.ts new file mode 100644 index 000000000000..b88c61154395 --- /dev/null +++ b/x-pack/test/reporting_functional/reporting_without_security.config.ts @@ -0,0 +1,34 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrConfigProviderContext } from '@kbn/test/types/ftr'; +import { resolve } from 'path'; + +export default async function ({ readConfigFile }: FtrConfigProviderContext) { + const reportingConfig = await readConfigFile(require.resolve('./reporting_and_security.config')); + + return { + ...reportingConfig.getAll(), + junit: { reportName: 'X-Pack Reporting Functional Tests Without Security Enabled' }, + testFiles: [resolve(__dirname, './reporting_without_security')], + kbnTestServer: { + ...reportingConfig.get('kbnTestServer'), + serverArgs: [ + ...reportingConfig.get('kbnTestServer.serverArgs'), + `--xpack.security.enabled=false`, + ], + }, + esTestCluster: { + ...reportingConfig.get('esTestCluster'), + serverArgs: [ + ...reportingConfig.get('esTestCluster.serverArgs'), + 'node.name=UnsecuredClusterNode01', + 'xpack.security.enabled=false', + ], + }, + }; +} diff --git a/x-pack/test/reporting_functional/reporting_without_security/index.ts b/x-pack/test/reporting_functional/reporting_without_security/index.ts new file mode 100644 index 000000000000..d1801b7e3e2e --- /dev/null +++ b/x-pack/test/reporting_functional/reporting_without_security/index.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +// eslint-disable-next-line import/no-default-export +export default function ({ loadTestFile, getService }: FtrProviderContext) { + describe('Reporting Functional Tests with Security disabled', function () { + this.tags('ciGroup2'); + loadTestFile(require.resolve('./management')); + }); +} diff --git a/x-pack/test/reporting_api_integration/reporting_without_security/management.ts b/x-pack/test/reporting_functional/reporting_without_security/management.ts similarity index 96% rename from x-pack/test/reporting_api_integration/reporting_without_security/management.ts rename to x-pack/test/reporting_functional/reporting_without_security/management.ts index f6db20c75639..b116bb5fe201 100644 --- a/x-pack/test/reporting_api_integration/reporting_without_security/management.ts +++ b/x-pack/test/reporting_functional/reporting_without_security/management.ts @@ -6,7 +6,7 @@ */ import expect from '@kbn/expect'; -import { JOB_PARAMS_ECOM_MARKDOWN } from '../fixtures'; +import { JOB_PARAMS_ECOM_MARKDOWN } from '../../reporting_api_integration/services/fixtures'; import { FtrProviderContext } from '../ftr_provider_context'; // eslint-disable-next-line import/no-default-export diff --git a/x-pack/test/reporting_functional/services/index.ts b/x-pack/test/reporting_functional/services/index.ts new file mode 100644 index 000000000000..458ddc7c7342 --- /dev/null +++ b/x-pack/test/reporting_functional/services/index.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { services as apiServices } from '../../reporting_api_integration/services'; +import { FtrProviderContext } from '../ftr_provider_context'; +import { createScenarios } from './scenarios'; + +export function ReportingFunctionalProvider(context: FtrProviderContext) { + return createScenarios(context); +} + +export const services = { + ...apiServices, + reportingFunctional: ReportingFunctionalProvider, +}; diff --git a/x-pack/test/reporting_functional/services/scenarios.ts b/x-pack/test/reporting_functional/services/scenarios.ts new file mode 100644 index 000000000000..a1387127ffc0 --- /dev/null +++ b/x-pack/test/reporting_functional/services/scenarios.ts @@ -0,0 +1,165 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../ftr_provider_context'; +import { createScenarios as createAPIScenarios } from '../../reporting_api_integration/services/scenarios'; + +export function createScenarios( + context: Pick +) { + const { getService, getPageObjects } = context; + const log = getService('log'); + const testSubjects = getService('testSubjects'); + const dashboardPanelActions = getService('dashboardPanelActions'); + + const PageObjects = getPageObjects([ + 'reporting', + 'security', + 'common', + 'share', + 'visualize', + 'dashboard', + 'discover', + 'canvas', + ]); + const scenariosAPI = createAPIScenarios(context); + + const { + DATA_ANALYST_USERNAME, + DATA_ANALYST_PASSWORD, + REPORTING_USER_USERNAME, + REPORTING_USER_PASSWORD, + } = scenariosAPI; + + const loginDataAnalyst = async () => { + await PageObjects.security.forceLogout(); + await PageObjects.security.login(DATA_ANALYST_USERNAME, DATA_ANALYST_PASSWORD, { + expectSpaceSelector: false, + }); + }; + + const loginReportingUser = async () => { + await PageObjects.security.forceLogout(); + await PageObjects.security.login(REPORTING_USER_USERNAME, REPORTING_USER_PASSWORD, { + expectSpaceSelector: false, + }); + }; + + const openSavedVisualization = async (title: string) => { + log.debug(`Opening saved visualizatiton: ${title}`); + await PageObjects.common.navigateToApp('visualize'); + await PageObjects.visualize.openSavedVisualization(title); + }; + + const openSavedDashboard = async (title: string) => { + log.debug(`Opening saved dashboard: ${title}`); + await PageObjects.common.navigateToApp('dashboard'); + await PageObjects.dashboard.loadSavedDashboard(title); + }; + + const openSavedSearch = async (title: string) => { + log.debug(`Opening saved search: ${title}`); + await PageObjects.common.navigateToApp('discover'); + await PageObjects.discover.loadSavedSearch(title); + }; + + const openCanvasWorkpad = async (title: string) => { + log.debug(`Opening saved canvas workpad: ${title}`); + await PageObjects.common.navigateToApp('canvas'); + await PageObjects.canvas.loadFirstWorkpad(title); + }; + + const getSavedSearchPanel = async (savedSearchTitle: string) => { + return await testSubjects.find(`embeddablePanelHeading-${savedSearchTitle.replace(' ', '')}`); + }; + const tryDashboardDownloadCsvFail = async (savedSearchTitle: string) => { + const savedSearchPanel = await getSavedSearchPanel(savedSearchTitle); + await dashboardPanelActions.toggleContextMenu(savedSearchPanel); + await dashboardPanelActions.clickContextMenuMoreItem(); + const actionItemTestSubj = 'embeddablePanelAction-downloadCsvReport'; + await testSubjects.existOrFail(actionItemTestSubj); + /* wait for the full panel to display or else the test runner could click the wrong option! */ await testSubjects.click( + actionItemTestSubj + ); + await testSubjects.existOrFail('downloadCsvFail'); + }; + const tryDashboardDownloadCsvNotAvailable = async (savedSearchTitle: string) => { + const savedSearchPanel = await getSavedSearchPanel(savedSearchTitle); + await dashboardPanelActions.toggleContextMenu(savedSearchPanel); + await dashboardPanelActions.clickContextMenuMoreItem(); + await testSubjects.missingOrFail('embeddablePanelAction-downloadCsvReport'); + }; + const tryDashboardDownloadCsvSuccess = async (savedSearchTitle: string) => { + const savedSearchPanel = await getSavedSearchPanel(savedSearchTitle); + await dashboardPanelActions.toggleContextMenu(savedSearchPanel); + await dashboardPanelActions.clickContextMenuMoreItem(); + const actionItemTestSubj = 'embeddablePanelAction-downloadCsvReport'; + await testSubjects.existOrFail(actionItemTestSubj); + /* wait for the full panel to display or else the test runner could click the wrong option! */ await testSubjects.click( + actionItemTestSubj + ); + await testSubjects.existOrFail('csvDownloadStarted'); /* validate toast panel */ + }; + const tryDiscoverCsvFail = async () => { + await PageObjects.reporting.openCsvReportingPanel(); + await PageObjects.reporting.clickGenerateReportButton(); + const queueReportError = await PageObjects.reporting.getQueueReportError(); + expect(queueReportError).to.be(true); + }; + const tryDiscoverCsvNotAvailable = async () => { + await PageObjects.share.clickShareTopNavButton(); + await testSubjects.missingOrFail('sharePanel-CSVReports'); + }; + const tryDiscoverCsvSuccess = async () => { + await PageObjects.reporting.openCsvReportingPanel(); + expect(await PageObjects.reporting.canReportBeCreated()).to.be(true); + }; + const tryGeneratePdfFail = async () => { + await PageObjects.reporting.openPdfReportingPanel(); + await PageObjects.reporting.clickGenerateReportButton(); + const queueReportError = await PageObjects.reporting.getQueueReportError(); + expect(queueReportError).to.be(true); + }; + const tryGeneratePdfNotAvailable = async () => { + PageObjects.share.clickShareTopNavButton(); + await testSubjects.missingOrFail(`sharePanel-PDFReports`); + }; + const tryGeneratePdfSuccess = async () => { + await PageObjects.reporting.openPdfReportingPanel(); + expect(await PageObjects.reporting.canReportBeCreated()).to.be(true); + }; + const tryGeneratePngSuccess = async () => { + await PageObjects.reporting.openPngReportingPanel(); + expect(await PageObjects.reporting.canReportBeCreated()).to.be(true); + }; + const tryReportsNotAvailable = async () => { + await PageObjects.share.clickShareTopNavButton(); + await testSubjects.missingOrFail('sharePanel-Reports'); + }; + + return { + ...scenariosAPI, + openSavedVisualization, + openSavedDashboard, + openSavedSearch, + openCanvasWorkpad, + tryDashboardDownloadCsvFail, + tryDashboardDownloadCsvNotAvailable, + tryDashboardDownloadCsvSuccess, + tryDiscoverCsvFail, + tryDiscoverCsvNotAvailable, + tryDiscoverCsvSuccess, + tryGeneratePdfFail, + tryGeneratePdfNotAvailable, + tryGeneratePdfSuccess, + tryGeneratePngSuccess, + tryReportsNotAvailable, + loginDataAnalyst, + loginReportingUser, + }; +} diff --git a/yarn.lock b/yarn.lock index 693da02fddfd..c43641d668ae 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1417,10 +1417,10 @@ resolved "https://registry.yarnpkg.com/@elastic/eslint-plugin-eui/-/eslint-plugin-eui-0.0.2.tgz#56b9ef03984a05cc213772ae3713ea8ef47b0314" integrity sha512-IoxURM5zraoQ7C8f+mJb9HYSENiZGgRVcG4tLQxE61yHNNRDXtGDWTZh8N1KIHcsqN1CEPETjuzBXkJYF/fDiQ== -"@elastic/eui@31.10.0": - version "31.10.0" - resolved "https://registry.yarnpkg.com/@elastic/eui/-/eui-31.10.0.tgz#07c1ca88bc042d124e0a4d3bc38b05bb0c6dd697" - integrity sha512-OsFs3WyFNWM1Uvs0y/h1MA50Pnf1c9KBX8A7sBmcFbMRpbD033AKOzH67crK8xmqRHB3vD23Yc+IVQdB6SMEGg== +"@elastic/eui@32.0.4": + version "32.0.4" + resolved "https://registry.yarnpkg.com/@elastic/eui/-/eui-32.0.4.tgz#46c001abb162e494e2c11ea48def840b5520f1dc" + integrity sha512-NL+bzzxAB6t/BPwaXqELIAWT0wZMcHyciAq+dGS44n7ZYbGzlDgTf77hlvwUsdDhFPhpMyFHJ55rE6ZtqBX/+w== dependencies: "@types/chroma-js" "^2.0.0" "@types/lodash" "^4.14.160" @@ -1433,7 +1433,7 @@ chroma-js "^2.1.0" classnames "^2.2.6" highlight.js "^9.18.5" - lodash "^4.17.20" + lodash "^4.17.21" numeral "^2.0.6" prop-types "^15.6.0" react-ace "^7.0.5" @@ -1454,7 +1454,7 @@ tabbable "^3.0.0" text-diff "^1.0.1" unified "^9.2.0" - url-parse "^1.4.7" + url-parse "^1.5.0" uuid "^8.3.0" vfile "^4.2.0" @@ -2632,7 +2632,7 @@ version "0.0.0" uid "" -"@kbn/config-schema@link:packages/kbn-config-schema": +"@kbn/config-schema@link:bazel-bin/packages/kbn-config-schema/npm_module": version "0.0.0" uid "" @@ -2740,7 +2740,7 @@ version "0.0.0" uid "" -"@kbn/tinymath@link:packages/kbn-tinymath": +"@kbn/tinymath@link:bazel-bin/packages/kbn-tinymath/npm_module": version "0.0.0" uid "" @@ -2752,7 +2752,7 @@ version "0.0.0" uid "" -"@kbn/utility-types@link:packages/kbn-utility-types": +"@kbn/utility-types@link:bazel-bin/packages/kbn-utility-types/npm_module": version "0.0.0" uid "" @@ -15841,14 +15841,14 @@ hooker@~0.2.3: integrity sha1-uDT3I8xKJCqmWWNFnfbZhMXT2Vk= hosted-git-info@^2.1.4: - version "2.5.0" - resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.5.0.tgz#6d60e34b3abbc8313062c3b798ef8d901a07af3c" - integrity sha512-pNgbURSuab90KbTqvRPsseaTxOJCZBD0a7t+haSN33piP9cCM4l0CqdzAif2hUqm716UovKB2ROmiabGAKVXyg== + version "2.8.9" + resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.9.tgz#dffc0bf9a21c02209090f2aa69429e1414daf3f9" + integrity sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw== hosted-git-info@^3.0.6: - version "3.0.7" - resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-3.0.7.tgz#a30727385ea85acfcee94e0aad9e368c792e036c" - integrity sha512-fWqc0IcuXs+BmE9orLDyVykAG9GJtGLGuZAAqgcckPgv5xad4AcXGIv8galtQvlwutxSlaMcdw7BUtq2EIvqCQ== + version "3.0.8" + resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-3.0.8.tgz#6e35d4cc87af2c5f816e4cb9ce350ba87a3f370d" + integrity sha512-aXpmwoOhRBrw6X3j0h5RloK4x1OzsxMPyxqIHyNfSe2pypkVTZFpEiRoSipPEPlMrh0HW/XsjkJ5WgnCirpNUw== dependencies: lru-cache "^6.0.0" @@ -28665,7 +28665,7 @@ url-parse-lax@^3.0.0: dependencies: prepend-http "^2.0.0" -url-parse@^1.4.3, url-parse@^1.4.7: +url-parse@^1.4.3, url-parse@^1.5.0: version "1.5.1" resolved "https://registry.yarnpkg.com/url-parse/-/url-parse-1.5.1.tgz#d5fa9890af8a5e1f274a2c98376510f6425f6e3b" integrity sha512-HOfCOUJt7iSYzEx/UqgtwKRMC6EU91NFhsCHMv9oM03VJcVo2Qrp8T8kI9D7amFf1cu+/3CEhgb3rF9zL7k85Q==