github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

Track API stats as part of ci (#95733)

Browse source 
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Stacey Gammon 2021-04-15 11:36:10 -04:00 • committed by GitHub
parent ede8ed3f95
commit 503cfcf8c9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
111 changed files with 11797 additions and 9242 deletions
Download patch file Download diff file Expand all files Collapse all files

229
api_docs/actions.json
View file

@ -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<string, unknown>) => Params) | undefined"
"((params: Params, variables: Record<string, unknown>, 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",
"<Config, Secrets, Params, ExecutorResultData>"
]
}
@ -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<string, any>[]; }"
"{ readonly documents: Record<string, any>[]; 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": [
"<Params extends Record<string, unknown> = Record<string, unknown>>(actionTypeId: string, params: Params, variables: Record<string, unknown>) => Params"
"<Params extends Record<string, unknown> = Record<string, unknown>>(actionTypeId: string, actionId: string, params: Params, variables: Record<string, unknown>) => 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<string, unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
"lineNumber": 14
}
}
],
"signature": [
"(variables: Record<string, unknown>) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record<string, unknown>; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record<string, unknown>; }; 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<string, unknown>; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record<string, unknown>; }; 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\""

85
api_docs/alerting.json
View file

@ -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",
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
]
}
@ -620,13 +597,7 @@
},
"signature": [
"{ params?: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertTypeParamsValidator",
"text": "AlertTypeParamsValidator"
},
"AlertTypeParamsValidator",
"<Params> | undefined; } | undefined"
]
},
@ -697,13 +668,7 @@
"lineNumber": 128
},
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.ExecutorType",
"text": "ExecutorType"
},
"ExecutorType",
"<Params, State, InstanceState, InstanceContext, ",
{
"pluginId": "alerting",
@ -854,7 +819,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
"<Params>, \"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"
},
"<Params>, \"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: <Params extends Record<string, unknown> = never>({ data, options, }: ",
"<Params>, \"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: <Params extends Record<string, unknown> = never>({ data, options, }: ",
"CreateOptions",
"<Params>) => Promise<Pick<",
{
@ -1126,7 +1087,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params>({ options: { fields, ...options }, }?: { options?: ",
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params>({ options: { fields, ...options }, }?: { options?: ",
"FindOptions",
" | undefined; }) => Promise<",
{
@ -1180,7 +1141,7 @@
"lineNumber": 178
},
"signature": [
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"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
},

606
api_docs/apm.json
View file

@ -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"
},
"<object, unknown>, 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"
},
"<object, unknown>"
"<",
"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"
},
"<unknown, unknown, unknown, any>"
]
},
{
"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"
},
"<object, unknown>; 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<APMRouteHandlerResources, ",
"APMRouteCreateOptions",
", { \"POST /api/apm/index_pattern/static\": ",
"ServerRoute",
"<\"POST /api/apm/index_pattern/static\", undefined, APMRouteHandlerResources, { created: boolean; }, ",
"APMRouteCreateOptions",
">; } & { \"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<string, unknown>; 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"
},
"<unknown, unknown, unknown, any>; context: ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.ApmPluginRequestHandlerContext",
"text": "ApmPluginRequestHandlerContext"
},
"ApmPluginRequestHandlerContext",
"; }) => Promise<{ search<TParams extends ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMEventESSearchRequest",
"text": "APMEventESSearchRequest"
},
"APMEventESSearchRequest",
">(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<",
"InferSearchResponseOf",
"<TypeOfProcessorEvent<",
@ -754,8 +680,8 @@
}
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 48
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 47
},
"lifecycle": "setup",
"initialIsOpen": true

3
api_docs/apm.mdx
View file

@ -30,6 +30,9 @@ import apmObj from './apm.json';
### Classes
<DocDefinitionList data={apmObj.server.classes}/>
### Interfaces
<DocDefinitionList data={apmObj.server.interfaces}/>
### Enums
<DocDefinitionList data={apmObj.server.enums}/>

19
api_docs/apm_oss.json
View file

@ -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,

2
api_docs/banners.json
View file

@ -146,7 +146,7 @@
"lineNumber": 13
},
"signature": [
"\"disabled\" | \"header\""
"\"top\" | \"disabled\""
],
"initialIsOpen": false
}

25
api_docs/bfetch.json
View file

@ -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",
"<string>; }"
@ -104,13 +99,7 @@
},
"signature": [
"<Payload, Result extends object>(params: ",
{
"pluginId": "bfetch",
"scope": "public",
"docId": "kibBfetchPluginApi",
"section": "def-public.StreamingBatchedFunctionParams",
"text": "StreamingBatchedFunctionParams"
},
"StreamingBatchedFunctionParams",
"<Payload, Result>) => ",
{
"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,

20
api_docs/canvas.json
View file

@ -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"

8
api_docs/cases.json
View file

@ -31,13 +31,7 @@
},
"signature": [
"() => ",
{
"pluginId": "cases",
"scope": "server",
"docId": "kibCasesPluginApi",
"section": "def-server.CasesClient",
"text": "CasesClient"
}
"CasesClient"
]
}
],

71
api_docs/charts.json
View file

@ -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": [],

162
api_docs/cloud.json
View file

@ -17,20 +17,6 @@
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.resetPasswordUrl",
"type": "string",
"label": "resetPasswordUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 18
@ -41,9 +27,9 @@
},
{
"tags": [],
"id": "def-public.CloudConfigType.deploymentUrl",
"id": "def-public.CloudConfigType.cname",
"type": "string",
"label": "deploymentUrl",
"label": "cname",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
@ -55,9 +41,9 @@
},
{
"tags": [],
"id": "def-public.CloudConfigType.accountUrl",
"id": "def-public.CloudConfigType.base_url",
"type": "string",
"label": "accountUrl",
"label": "base_url",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
@ -66,11 +52,53 @@
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.profile_url",
"type": "string",
"label": "profile_url",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"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"
]
}
],
"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,69 @@
},
{
"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"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.baseUrl",
"type": "string",
"label": "baseUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 37
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.deploymentUrl",
"type": "string",
"label": "deploymentUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 38
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.profileUrl",
"type": "string",
"label": "profileUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"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"
@ -121,41 +205,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 34
"lineNumber": 41
}
},
{
"tags": [],
"id": "def-public.CloudSetup.resetPasswordUrl",
"type": "string",
"label": "resetPasswordUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 35
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.accountUrl",
"type": "string",
"label": "accountUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 36
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 31
"lineNumber": 34
},
"lifecycle": "setup",
"initialIsOpen": true

1090
api_docs/core.json
View file

File diff suppressed because it is too large Load diff

43
api_docs/core_application.json
View file

@ -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": [],

88
api_docs/core_chrome.json
View file

@ -123,6 +123,7 @@
],
"children": [
{
"id": "def-public.ChromeDocTitle.change.$1",
"type": "CompoundType",
"label": "newTitle",
"isRequired": true,
@ -254,10 +255,10 @@
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
"<",
"CommonEuiButtonEmptyProps",
", {}>, ",
"PropsForButton"
],
"description": [],
"tags": [
@ -332,10 +333,10 @@
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
"<",
"CommonEuiButtonEmptyProps",
", {}>, ",
"PropsForButton"
],
"description": [],
"tags": [
@ -394,10 +395,10 @@
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
"<",
"CommonEuiButtonEmptyProps",
", {}>, ",
"PropsForButton"
],
"description": [],
"tags": [
@ -456,10 +457,10 @@
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"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,

44
api_docs/core_http.json
View file

@ -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"
},
"<T>) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaResponse",
"text": "KibanaResponse"
},
"KibanaResponse",
"<T>"
],
"description": [

647
api_docs/core_saved_objects.json
View file

File diff suppressed because it is too large Load diff

260
api_docs/dashboard.json
View file

@ -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"
},
"<TEmbeddableInput, any, TEmbeddable, ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
"SavedObjectAttributes",
">, partial?: Partial<TEmbeddableInput>) => ",
{
"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"
},
"<TEmbeddableInput, any, TEmbeddable, ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
"SavedObjectAttributes",
">"
],
"description": [],
@ -264,6 +244,7 @@
}
},
{
"id": "def-public.DashboardContainer.createNewPanelState.$2",
"type": "Object",
"label": "partial",
"isRequired": true,
@ -290,13 +271,7 @@
"label": "showPlaceholderUntil",
"signature": [
"<TPlacementMethodArgs extends ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.IPanelPlacementArgs",
"text": "IPanelPlacementArgs"
},
"IPanelPlacementArgs",
">(newStateComplete: Promise<Partial<",
{
"pluginId": "embeddable",
@ -306,18 +281,13 @@
"text": "PanelState"
},
"<{ id: string; }>>>, placementMethod?: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.PanelPlacementMethod",
"text": "PanelPlacementMethod"
},
"PanelPlacementMethod",
"<TPlacementMethodArgs> | 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",
"<TPlacementMethodArgs> | 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<Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"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<Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"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": [],

11
api_docs/dashboard.mdx
View file

@ -34,6 +34,17 @@ import dashboardObj from './dashboard.json';
### Consts, variables and types
<DocDefinitionList data={dashboardObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[dashboardObj.server.setup]}/>
### Start
<DocDefinitionList data={[dashboardObj.server.start]}/>
### Functions
<DocDefinitionList data={dashboardObj.server.functions}/>
## Common
### Functions

16
api_docs/dashboard_enhanced.json
View file

@ -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": [],

4
api_docs/dashboard_mode.json
View file

@ -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,

1521
api_docs/data.json
View file

File diff suppressed because it is too large Load diff

116
api_docs/data_enhanced.json
View file

@ -79,8 +79,10 @@
"section": "def-server.Plugin",
"text": "Plugin"
},
"<void, void, SetupDependencies, ",
"StartDependencies",
"<void, void, ",
"DataEnhancedSetupDependencies",
", ",
"DataEnhancedStartDependencies",
">"
],
"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<string, unknown> | undefined"
@ -737,7 +741,7 @@
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 51
"lineNumber": 58
},
"signature": [
"Record<string, unknown> | undefined"
@ -753,7 +757,7 @@
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 55
"lineNumber": 62
},
"signature": [
"Record<string, ",
@ -777,7 +781,7 @@
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 60
"lineNumber": 67
}
},
{
@ -790,7 +794,7 @@
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 64
"lineNumber": 71
},
"signature": [
"string | undefined"
@ -804,7 +808,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 65
"lineNumber": 72
},
"signature": [
"string | undefined"
@ -818,7 +822,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 66
"lineNumber": 73
},
"signature": [
"string | undefined"

290
api_docs/data_field_formats.json
View file

@ -138,6 +138,7 @@
"type": "Function",
"children": [
{
"id": "def-common.BoolFormat.textConvert.$1",
"type": "Any",
"label": "value",
"isRequired": true,
@ -299,7 +300,7 @@
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 20
},
"signature": [
@ -319,7 +320,7 @@
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 21
}
},
@ -330,7 +331,7 @@
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 24
},
"signature": [
@ -356,7 +357,7 @@
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 26
}
},
@ -370,6 +371,7 @@
"description": [],
"children": [
{
"id": "def-common.ColorFormat.findColorRuleForVal.$1",
"type": "Any",
"label": "val",
"isRequired": true,
@ -378,7 +380,7 @@
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 33
}
}
@ -386,7 +388,7 @@
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 33
}
},
@ -395,6 +397,7 @@
"type": "Function",
"children": [
{
"id": "def-common.ColorFormat.htmlConvert.$1",
"type": "Any",
"label": "val",
"isRequired": true,
@ -403,7 +406,7 @@
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 52
}
}
@ -414,7 +417,7 @@
"description": [],
"label": "htmlConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 52
},
"tags": [],
@ -422,7 +425,7 @@
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"path": "src/plugins/data/common/field_formats/converters/color.tsx",
"lineNumber": 19
},
"initialIsOpen": false
@ -578,6 +581,7 @@
"type": "Function",
"children": [
{
"id": "def-common.DurationFormat.textConvert.$1",
"type": "Any",
"label": "val",
"isRequired": true,
@ -678,13 +682,7 @@
"lineNumber": 52
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatConvert",
"text": "FieldFormatConvert"
},
"FieldFormatConvert",
" | undefined"
]
},
@ -702,13 +700,7 @@
"lineNumber": 60
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeConvert",
"text": "HtmlContextTypeConvert"
},
"HtmlContextTypeConvert",
" | undefined"
]
},
@ -726,13 +718,7 @@
"lineNumber": 68
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.TextContextTypeConvert",
"text": "TextContextTypeConvert"
},
"TextContextTypeConvert",
" | undefined"
]
},
@ -812,17 +798,12 @@
"description": [],
"children": [
{
"id": "def-common.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": {
@ -831,6 +812,7 @@
}
},
{
"id": "def-common.FieldFormat.Unnamed.$2",
"type": "Function",
"label": "getConfig",
"isRequired": false,
@ -872,13 +854,7 @@
"text": "FieldFormatsContentType"
},
", options?: Record<string, any> | ",
{
"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<string, any> | ",
{
"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<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"FieldFormatInstanceType",
">"
]
},
@ -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<string, any>, 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,

269
api_docs/data_index_patterns.json
View file

@ -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",
"<T>[]>"
]
},
@ -6310,13 +6309,7 @@
},
"signature": [
"<T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"SavedObject",
"<T>>"
]
},
@ -6332,13 +6325,7 @@
},
"signature": [
"(type: string, id: string, attributes: Record<string, any>, options: Record<string, any>) => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"SavedObject",
"<unknown>>"
]
},
@ -6354,13 +6341,7 @@
},
"signature": [
"(type: string, attributes: Record<string, any>, options: Record<string, any>) => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"SavedObject",
"<unknown>>"
]
},
@ -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<IndexPattern>; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise<IndexPattern>; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; find: (search: string, size?: number) => Promise<IndexPattern[]>; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>; getDefault: () => Promise<IndexPattern | null>; setDefault: (id: string, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>; refreshFields: (indexPattern: IndexPattern) => Promise<void>; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record<string, FieldSpec>; savedObjectToSpec: (savedObject: SavedObject<IndexPatternAttributes>) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise<IndexPattern>; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise<IndexPattern>; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>; }"
"{ get: (id: string) => Promise<IndexPattern>; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise<IndexPattern>; find: (search: string, size?: number) => Promise<IndexPattern[]>; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>; getDefault: () => Promise<IndexPattern | null>; setDefault: (id: string, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>; refreshFields: (indexPattern: IndexPattern) => Promise<void>; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record<string, FieldSpec>; savedObjectToSpec: (savedObject: SavedObject<IndexPatternAttributes>) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise<IndexPattern>; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise<IndexPattern>; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>; }"
],
"initialIsOpen": false
},

125
api_docs/data_query.json
View file

@ -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",
"<unknown>; getAutoRefreshFetch$: () => ",
"Observable",
"<unknown>; getFetch$: () => ",
"<AutoRefreshDoneFn>; 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,

1790
api_docs/data_search.json
View file

File diff suppressed because it is too large Load diff

71
api_docs/data_ui.json
View file

File diff suppressed because one or more lines are too long

37
api_docs/dev_tools.json
View file

@ -49,26 +49,15 @@
"text": "CoreSetup"
},
"<object, unknown>, { 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"
]
}
],

41
api_docs/discover.json
View file

@ -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; }"
]
}

48
api_docs/discover_enhanced.json
View file

@ -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<boolean>"
],
"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<void>; config: Readonly<{} & { defaultAppId: string; }>; } | undefined"
]
},

232
api_docs/embeddable.json
View file

File diff suppressed because it is too large Load diff

1
api_docs/embeddable_enhanced.json
View file

@ -8,6 +8,7 @@
"type": "Function",
"children": [
{
"id": "def-public.isEnhancedEmbeddable.$1",
"type": "Uncategorized",
"label": "maybeEnhancedEmbeddable",
"isRequired": true,

44
api_docs/encrypted_saved_objects.json
View file

@ -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",
"<T>>"
]
}
@ -204,13 +196,7 @@
},
"signature": [
"ReadonlySet<string | ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.AttributeToEncrypt",
"text": "AttributeToEncrypt"
},
"AttributeToEncrypt",
">"
]
},
@ -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"
]
}
],

58
api_docs/es_ui_shared.json
View file

@ -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,

561
api_docs/event_log.json
View file

@ -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"
},
"<TDoc>"
],
"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<void>"
],
"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<void>"
],
"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<boolean>"
],
"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<string, unknown>) => Promise<void>"
],
"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<string, unknown>"
],
"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<boolean>"
],
"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<string, unknown>) => Promise<void>"
],
"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<string, unknown>"
],
"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<boolean>"
],
"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<string, unknown>) => Promise<void>"
],
"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<string, unknown>"
],
"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",
"<T>"
],
"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<DeepWriteable<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) => void"
"(properties: DeepPartial<DeepWriteable<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) => void"
],
"description": [],
"children": [
{
"id": "def-server.IEventLogger.logEvent.$1",
"type": "Object",
"label": "properties",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<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"
"DeepPartial<DeepWriteable<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"
],
"description": [],
"source": {
@ -148,16 +619,17 @@
"type": "Function",
"label": "startTiming",
"signature": [
"(event: DeepPartial<DeepWriteable<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) => void"
"(event: DeepPartial<DeepWriteable<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) => void"
],
"description": [],
"children": [
{
"id": "def-server.IEventLogger.startTiming.$1",
"type": "Object",
"label": "event",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<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"
"DeepPartial<DeepWriteable<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"
],
"description": [],
"source": {
@ -178,16 +650,17 @@
"type": "Function",
"label": "stopTiming",
"signature": [
"(event: DeepPartial<DeepWriteable<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) => void"
"(event: DeepPartial<DeepWriteable<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) => void"
],
"description": [],
"children": [
{
"id": "def-server.IEventLogger.stopTiming.$1",
"type": "Object",
"label": "event",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<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"
"DeepPartial<DeepWriteable<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"
],
"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<DeepWriteable<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 | DeepPartial<DeepWriteable<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
},
@ -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<DeepWriteable<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) => ",
"(properties: DeepPartial<DeepWriteable<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) => ",
{
"pluginId": "eventLog",
"scope": "server",
@ -552,11 +1019,12 @@
"description": [],
"children": [
{
"id": "def-server.IEventLogService.getLogger.$1",
"type": "Object",
"label": "properties",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<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"
"DeepPartial<DeepWriteable<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"
],
"description": [],
"source": {
@ -612,6 +1080,7 @@
"description": [],
"children": [
{
"id": "def-server.IEventLogClientService.getClient.$1",
"type": "Object",
"label": "request",
"isRequired": true,

6
api_docs/event_log.mdx
View file

@ -19,6 +19,12 @@ import eventLogObj from './event_log.json';
### Start
<DocDefinitionList data={[eventLogObj.server.start]}/>
### Functions
<DocDefinitionList data={eventLogObj.server.functions}/>
### Classes
<DocDefinitionList data={eventLogObj.server.classes}/>
### Interfaces
<DocDefinitionList data={eventLogObj.server.interfaces}/>

664
api_docs/expressions.json
View file

File diff suppressed because it is too large Load diff

80
api_docs/features.json
View file

@ -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."

323
api_docs/file_upload.json
View file

File diff suppressed because it is too large Load diff

1373
api_docs/fleet.json
View file

File diff suppressed because it is too large Load diff

161
api_docs/global_search.json
View file

@ -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<string, ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"Serializable",
"> | 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<string, ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"Serializable",
"> | 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,

57
api_docs/home.json
View file

@ -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",
"<unknown>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"SavedObject",
"<unknown>[]) => 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"
]
}
],

36
api_docs/index_management.json
View file

@ -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"
]
},
{

45
api_docs/index_pattern_field_editor.json
View file

@ -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",
">"
]
}

60
api_docs/index_pattern_management.json
View file

@ -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,

25
api_docs/infra.json
View file

@ -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

2
api_docs/ingest_pipelines.json
View file

@ -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,

209
api_docs/inspector.json
View file

@ -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": {

68
api_docs/kibana_legacy.json
View file

@ -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<void>; 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<void>; 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<void>; 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,

138
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

710
api_docs/kibana_utils.json
View file

File diff suppressed because it is too large Load diff

186
api_docs/lens.json
View file

@ -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<string, Pick<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.IndexPatternLayer",
"text": "IndexPatternLayer"
},
"IndexPatternLayer",
", \"columns\" | \"columnOrder\" | \"incompleteColumns\">>"
]
}
@ -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<LensByValueInput, \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"renderMode\"> & { attributes: LensAttributes<'lnsXY', XYState> | LensAttributes<'lnsPie', PieVisualizationState> | LensAttributes<'lnsDatatable', DatatableVisualizationState> | LensAttributes<'lnsMetric', MetricState>; }"
"Pick<LensByValueInput, \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"onLoad\" | \"renderMode\" | \"onBrushEnd\" | \"onFilter\" | \"onTableRowClick\"> & { 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,

262
api_docs/licensing.json
View file

@ -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<string, ",
{
"pluginId": "licensing",
"scope": "common",
"docId": "kibLicensingPluginApi",
"section": "def-common.LicenseFeature",
"text": "LicenseFeature"
},
"LicenseFeature",
"> | 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"
},
"<T>) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaResponse",
"text": "KibanaResponse"
},
"KibanaResponse",
"<T>; 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<string, ",
{
"pluginId": "licensing",
"scope": "common",
"docId": "kibLicensingPluginApi",
"section": "def-common.LicenseFeature",
"text": "LicenseFeature"
},
"LicenseFeature",
"> | 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",
">; }"
]
},

921
api_docs/lists.json
View file

File diff suppressed because it is too large Load diff

3
api_docs/lists.mdx
View file

@ -19,6 +19,9 @@ import listsObj from './lists.json';
### Start
<DocDefinitionList data={[listsObj.client.start]}/>
### Objects
<DocDefinitionList data={listsObj.client.objects}/>
### Functions
<DocDefinitionList data={listsObj.client.functions}/>

36
api_docs/management.json
View file

@ -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<",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.CreateManagementItemArgs",
"text": "CreateManagementItemArgs"
},
"CreateManagementItemArgs",
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & 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"
]
}
],

1141
api_docs/maps.json
View file

File diff suppressed because it is too large Load diff

3
api_docs/maps.mdx
View file

@ -16,6 +16,9 @@ import mapsObj from './maps.json';
### Start
<DocDefinitionList data={[mapsObj.client.start]}/>
### Classes
<DocDefinitionList data={mapsObj.client.classes}/>
### Interfaces
<DocDefinitionList data={mapsObj.client.interfaces}/>

51
api_docs/maps_ems.json
View file

@ -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,

536
api_docs/ml.json
View file

@ -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<string>"
],
"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,7 +4460,117 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 138
"lineNumber": 146
},
"initialIsOpen": false
},
{
"id": "def-common.isPopulatedObject",
"type": "Function",
"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": [
"<U extends string = string>(arg: unknown, requiredAttributes?: U[]) => arg is Record<U, unknown>"
],
"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": [
{
"id": "def-common.isRuntimeField.$1",
"type": "Unknown",
"label": "arg",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 14
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.isRuntimeMappings",
"type": "Function",
"label": "isRuntimeMappings",
"signature": [
"(arg: unknown) => boolean"
],
"description": [],
"children": [
{
"id": "def-common.isRuntimeMappings.$1",
"type": "Unknown",
"label": "arg",
"isRequired": true,
"signature": [
"unknown"
],
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 27
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 27
},
"initialIsOpen": false
},
@ -4632,6 +4586,7 @@
],
"children": [
{
"id": "def-common.patternValidator.$1",
"type": "Object",
"label": "pattern",
"isRequired": true,
@ -4654,110 +4609,7 @@
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.SearchResponse7",
"type": "Interface",
"label": "SearchResponse7",
"signature": [
{
"pluginId": "ml",
"scope": "common",
"docId": "kibMlPluginApi",
"section": "def-common.SearchResponse7",
"text": "SearchResponse7"
},
"<T>"
],
"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",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/es_client.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": [],
"id": "def-common.SearchResponse7.hits",
"type": "Object",
"label": "hits",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/es_client.ts",
"lineNumber": 30
},
"signature": [
"SearchResponse7Hits<T>"
]
},
{
"tags": [],
"id": "def-common.SearchResponse7.aggregations",
"type": "Any",
"label": "aggregations",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/es_client.ts",
"lineNumber": 31
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/ml/common/types/es_client.ts",
"lineNumber": 25
},
"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
},

3
api_docs/ml.mdx
View file

@ -65,9 +65,6 @@ import mlObj from './ml.json';
### Functions
<DocDefinitionList data={mlObj.common.functions}/>
### Interfaces
<DocDefinitionList data={mlObj.common.interfaces}/>
### Enums
<DocDefinitionList data={mlObj.common.enums}/>

4
api_docs/monitoring.json
View file

@ -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
}

39
api_docs/navigation.json
View file

@ -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<SearchBarProps, \"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\" | \"onFiltersUpdated\" | \"onRefreshChange\"> & { 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<SearchBarProps, \"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\" | \"onFiltersUpdated\" | \"onRefreshChange\"> & { 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"
]
}

533
api_docs/observability.json
View file

File diff suppressed because it is too large Load diff

717
api_docs/presentation_util.json
View file

@ -4,87 +4,119 @@
"classes": [],
"functions": [
{
"id": "def-public.DashboardPicker",
"type": "Function",
"label": "DashboardPicker",
"signature": [
"(props: ",
"DashboardPickerProps",
") => JSX.Element"
],
"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
}
}
],
"tags": [],
"returnComment": [],
"id": "def-public.LazyDashboardPicker",
"type": "Function",
"label": "LazyDashboardPicker",
"description": [],
"source": {
"path": "src/plugins/presentation_util/public/components/dashboard_picker.tsx",
"lineNumber": 27
"path": "src/plugins/presentation_util/public/components/index.tsx",
"lineNumber": 34
},
"signature": [
"React.LazyExoticComponent<typeof ",
"DashboardPicker",
">"
],
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectSaveModalDashboard",
"tags": [],
"id": "def-public.LazyLabsBeakerButton",
"type": "Function",
"label": "SavedObjectSaveModalDashboard",
"label": "LazyLabsBeakerButton",
"description": [],
"source": {
"path": "src/plugins/presentation_util/public/components/index.tsx",
"lineNumber": 28
},
"signature": [
"(props: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.SaveModalDashboardProps",
"text": "SaveModalDashboardProps"
},
"Props",
") => JSX.Element"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.LazyLabsFlyout",
"type": "Function",
"label": "LazyLabsFlyout",
"description": [],
"source": {
"path": "src/plugins/presentation_util/public/components/index.tsx",
"lineNumber": 32
},
"signature": [
"(props: ",
"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<typeof ",
"default",
">"
],
"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<P>"
],
"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": 18
}
},
{
"id": "def-public.withSuspense.$2",
"type": "CompoundType",
"label": "fallback",
"isRequired": false,
"signature": [
"React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
],
"description": [],
"source": {
"path": "src/plugins/presentation_util/public/components/index.tsx",
"lineNumber": 19
}
}
],
"signature": [
"<P extends {}>(Component: React.ComponentType<P>, fallback?: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | 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/index.tsx",
"lineNumber": 17
},
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
"lineNumber": 37
},
"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<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | 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
}
]
}
}

20
api_docs/presentation_util.mdx
View file

@ -19,9 +19,29 @@ import presentationUtilObj from './presentation_util.json';
### Start
<DocDefinitionList data={[presentationUtilObj.client.start]}/>
### Objects
<DocDefinitionList data={presentationUtilObj.client.objects}/>
### Functions
<DocDefinitionList data={presentationUtilObj.client.functions}/>
### Interfaces
<DocDefinitionList data={presentationUtilObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={presentationUtilObj.client.misc}/>
## Common
### Objects
<DocDefinitionList data={presentationUtilObj.common.objects}/>
### Functions
<DocDefinitionList data={presentationUtilObj.common.functions}/>
### Interfaces
<DocDefinitionList data={presentationUtilObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={presentationUtilObj.common.misc}/>

305
api_docs/reporting.json
View file

@ -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"
},
"<object, unknown>, { 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"
},
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; 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 | ",
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; 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<void>"
],
"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<Record<string, ",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.LicenseCheckResult",
"text": "LicenseCheckResult"
},
"LicenseCheckResult",
">>"
],
"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"
},
"<unknown, unknown, unknown, any>, 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"
},
"<unknown, unknown, unknown, any>, 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"
},
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; 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 | ",
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; 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<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; 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<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; 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,

400
api_docs/rule_registry.json Normal file
View file

File diff suppressed because one or more lines are too long

38
api_docs/rule_registry.mdx Normal file
View file

@ -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
<DocDefinitionList data={[ruleRegistryObj.server.setup]}/>
### Objects
<DocDefinitionList data={ruleRegistryObj.server.objects}/>
### Functions
<DocDefinitionList data={ruleRegistryObj.server.functions}/>
### Interfaces
<DocDefinitionList data={ruleRegistryObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={ruleRegistryObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={ruleRegistryObj.common.functions}/>
### Enums
<DocDefinitionList data={ruleRegistryObj.common.enums}/>

10
api_docs/runtime_fields.json
View file

@ -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": [],

170
api_docs/saved_objects.json
View file

@ -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<string, unknown>, id: string, references?: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"SavedObjectReference",
"[]) => Record<string, unknown>"
],
"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<string, unknown>; id: string; references?: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"SavedObjectReference",
"[] | undefined; }) => Record<string, unknown>"
],
"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<string, unknown>"
]
},
@ -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,

200
api_docs/saved_objects_management.json
View file

File diff suppressed because one or more lines are too long

58
api_docs/saved_objects_tagging.json
View file

@ -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"
}

249
api_docs/saved_objects_tagging_oss.json
View file

@ -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",
"<unknown>>"
],
"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",
"<unknown>"
]
}
@ -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"
}

166
api_docs/security.json
View file

@ -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<string, string[]>; } | 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"
},
"<unknown, unknown, unknown, any>) => ",
{
"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\">"
]
}

32
api_docs/security_oss.json
View file

@ -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<Record<string, string> | 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"
]
}

304
api_docs/security_solution.json
View file

@ -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"
},
"<T>) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaResponse",
"text": "KibanaResponse"
},
"KibanaResponse",
"<T>; 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": [],

40
api_docs/share.json
View file

@ -52,6 +52,7 @@
"description": [],
"children": [
{
"id": "def-public.KibanaURL.Unnamed.$1",
"type": "string",
"label": "path",
"isRequired": true,
@ -138,17 +139,12 @@
"text": "CoreSetup"
},
"<object, unknown>) => ",
{
"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,

9
api_docs/snapshot_restore.json
View file

@ -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": [],

44
api_docs/spaces.json
View file

@ -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"
},
"<unknown, unknown, unknown, any>) => 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,

1
api_docs/spaces_oss.json
View file

@ -961,6 +961,7 @@
],
"children": [
{
"id": "def-public.SpacesOssPluginSetup.registerSpacesApi.$1",
"type": "Object",
"label": "provider",
"isRequired": true,

21
api_docs/task_manager.json
View file

@ -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"
]
},

120
api_docs/telemetry.json
View file

@ -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"
},
"<Readonly<{ optIn?: boolean | undefined; } & { enabled: boolean; url: string; allowChangingOptInStatus: boolean; config: string; banner: boolean; optInStatusUrl: string; sendUsageFrom: \"server\" | \"browser\"; }>>"
"<Readonly<{ optIn?: boolean | undefined; } & { enabled: boolean; url: string; allowChangingOptInStatus: boolean; config: string; banner: boolean; optInStatusUrl: string; sendUsageFrom: \"browser\" | \"server\"; }>>"
],
"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,

130
api_docs/telemetry_collection_manager.json
View file

@ -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<T[]>"
],
"initialIsOpen": false
@ -289,21 +325,9 @@
},
"signature": [
"<T extends ",
{
"pluginId": "telemetry",
"scope": "common",
"docId": "kibTelemetryPluginApi",
"section": "def-common.BasicStatsPayload",
"text": "BasicStatsPayload"
},
"BasicStatsPayload",
">(collectionConfig: ",
{
"pluginId": "telemetry",
"scope": "common",
"docId": "kibTelemetryPluginApi",
"section": "def-common.CollectionStrategyConfig",
"text": "CollectionStrategyConfig"
},
"CollectionStrategyConfig",
"<T>) => 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<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
@ -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<string[] | ",
{
"pluginId": "telemetry",
"scope": "common",
"docId": "kibTelemetryPluginApi",
"section": "def-common.UsageStatsPayload",
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.UsageStatsPayload",
"text": "UsageStatsPayload"
},
"[]>"
@ -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<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
@ -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<string[] | ",
{
"pluginId": "telemetry",
"scope": "common",
"docId": "kibTelemetryPluginApi",
"section": "def-common.UsageStatsPayload",
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.UsageStatsPayload",
"text": "UsageStatsPayload"
},
"[]>"

9
api_docs/telemetry_management_section.json
View file

@ -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<Props, State, any>"
],
"children": [
@ -123,6 +129,7 @@
"description": [],
"children": [
{
"id": "def-public.OptInExampleFlyout.renderBody.$1",
"type": "Object",
"label": "{ data, isLoading, hasPrivilegeToRead }",
"isRequired": true,

119
api_docs/timelines.json Normal file
View file

@ -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<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>) | 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": []
}
}

31
api_docs/timelines.mdx Normal file
View file

@ -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
<DocDefinitionList data={[timelinesObj.client.setup]}/>
## Server
### Setup
<DocDefinitionList data={[timelinesObj.server.setup]}/>
### Start
<DocDefinitionList data={[timelinesObj.server.start]}/>
## Common
### Consts, variables and types
<DocDefinitionList data={timelinesObj.common.misc}/>

279
api_docs/triggers_actions_ui.json
View file

@ -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<any> | React.LazyExoticComponent<React.ComponentType<",
@ -1178,7 +1183,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 230
"lineNumber": 242
}
},
{
@ -1189,7 +1194,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 231
"lineNumber": 243
},
"signature": [
"string | undefined"
@ -1198,7 +1203,7 @@
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 221
"lineNumber": 233
},
"initialIsOpen": false
},
@ -1227,7 +1232,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 204
"lineNumber": 216
},
"signature": [
"Params"
@ -1241,7 +1246,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 205
"lineNumber": 217
}
},
{
@ -1252,7 +1257,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 206
"lineNumber": 218
}
},
{
@ -1263,7 +1268,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 207
"lineNumber": 219
},
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
@ -1277,7 +1282,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 208
"lineNumber": 220
},
"signature": [
"<Key extends keyof Params>(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": [
"<Prop extends \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">(key: Prop, value: Pick<",
"<Prop extends \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">(key: Prop, value: Pick<",
{
"pluginId": "alerting",
"scope": "common",
@ -1302,7 +1307,7 @@
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void"
"<Params>, \"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",
"<unknown, unknown, any>>, \"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<string, any>"
@ -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<ActionConnector, ActionParams, any>; register: (objectType: ActionTypeModel<ActionConnector, ActionParams, any>) => void; list: () => ActionTypeModel<ActionConnector, ActionParams, any>[]; 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<AsActionVariables<\"context\">>"
@ -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<string, unknown>; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
"{ enabled: boolean; id: string; name: string; params: Record<string, unknown>; 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<Record<string, unknown>>; register: (objectType: AlertTypeModel<Record<string, unknown>>) => void; list: () => AlertTypeModel<Record<string, unknown>>[]; 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",
"<any, any, any>>"
]
},
@ -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",
"<any, any, any>>"
]
},
@ -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<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
]
},
@ -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<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
]
},
@ -3175,21 +3102,9 @@
},
"signature": [
"(props: Pick<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertAddProps",
"text": "AlertAddProps"
},
"AlertAddProps",
"<Record<string, any>>, \"onClose\" | \"metadata\" | \"onSave\" | \"alertTypeId\" | \"consumer\" | \"canChangeTrigger\" | \"initialValues\" | \"reloadAlerts\">) => React.ReactElement<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertAddProps",
"text": "AlertAddProps"
},
"AlertAddProps",
"<Record<string, any>>, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
]
},
@ -3205,21 +3120,9 @@
},
"signature": [
"(props: Pick<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertEditProps",
"text": "AlertEditProps"
},
"AlertEditProps",
"<Record<string, any>>, \"onClose\" | \"metadata\" | \"onSave\" | \"reloadAlerts\" | \"initialAlert\">) => React.ReactElement<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertEditProps",
"text": "AlertEditProps"
},
"AlertEditProps",
"<Record<string, any>>, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
]
}
@ -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",
"; }"
]
}

187
api_docs/ui_actions.json
View file

@ -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",
"<object>"
],
"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",
"<A>>"
],
"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",
"<T>>"
],
"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",
"<Context>) => Promise<boolean>) | 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",
"<Context>"
],
"description": [],
@ -1363,13 +1330,7 @@
"label": "execute",
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"ActionDefinitionContext",
"<Context>) => Promise<void>"
],
"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",
"<Context>"
],
"description": [],
@ -1410,13 +1366,7 @@
"label": "shouldAutoExecute",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"ActionDefinitionContext",
"<Context>) => Promise<boolean>) | 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",
"<Context>"
],
"description": [],
@ -1457,13 +1402,7 @@
"label": "getHref",
"signature": [
"((context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinitionContext",
"text": "ActionDefinitionContext"
},
"ActionDefinitionContext",
"<Context>) => Promise<string | undefined>) | 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",
"<Context>"
],
"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"
]
}

192
api_docs/ui_actions_enhanced.json
View file

@ -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,

26
api_docs/uptime.json
View file

@ -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"
]
}

22
api_docs/url_forwarding.json
View file

@ -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<void>; 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<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
]
}

27
api_docs/usage_collection.json
View file

@ -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",
"<any>"
]
},
@ -223,13 +212,7 @@
"lineNumber": 147
},
"signature": [
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorFetchMethod",
"text": "CollectorFetchMethod"
},
"CollectorFetchMethod",
"<any, TFetchReturn, ExtraOptions>"
]
},
@ -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,

111
api_docs/vis_type_timeseries.json
View file

@ -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"
},
"<unknown, unknown, unknown, any>, 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

6
api_docs/vis_type_timeseries.mdx
View file

@ -16,3 +16,9 @@ import visTypeTimeseriesObj from './vis_type_timeseries.json';
### Setup
<DocDefinitionList data={[visTypeTimeseriesObj.server.setup]}/>
### Functions
<DocDefinitionList data={visTypeTimeseriesObj.server.functions}/>
### Consts, variables and types
<DocDefinitionList data={visTypeTimeseriesObj.server.misc}/>

105
api_docs/visualizations.json
View file

@ -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",
"<TVisParams>"
]
},
@ -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: 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; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: ",
{
"pluginId": "data",
@ -1562,13 +1567,7 @@
},
"signature": [
"Pick<Pick<{ 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; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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: 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; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & Pick<{ type: ",
{
"pluginId": "data",

2
packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts
View file

@ -56,7 +56,5 @@ export function buildFunctionDec(
returnComment: getJSDocReturnTagComment(node),
source: getSourceForNode(node),
};
log.warning(`fn ${label} has tags: ${fn.tags.join(', ')}`);
return fn;
}

25
packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_parameter_decs.ts
View file

@ -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),
});
}

4
packages/kbn-docs-utils/src/api_docs/build_api_declarations/extract_import_refs.ts
View file

@ -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;
}
}

6
packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts
View file

@ -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;
}

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