mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
Fix a bunch of bugs with APIDocs system (#99589)
* Remove custom code, add in a hack * remove artifical limit * Fix arrow functions in interfaces not having children * Update docs * Update api docs after merge from master * update api docs after merge from master * update api docs
This commit is contained in:
Stacey Gammon
GitHub
parent
3e5d9cf47d
commit
044c725c71
107 changed files with 87119 additions and 26218 deletions
|
|
@ -252,7 +252,9 @@
|
|||
"path": "x-pack/plugins/actions/server/types.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
|
|
@ -276,7 +278,9 @@
|
|||
"path": "x-pack/plugins/actions/server/types.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -516,14 +520,55 @@
|
|||
"label": "executor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ExecutorType",
|
||||
"<Config, Secrets, Params, ExecutorResultData>"
|
||||
"(options: ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "server",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-server.ActionTypeExecutorOptions",
|
||||
"text": "ActionTypeExecutorOptions"
|
||||
},
|
||||
"<Config, Secrets, Params>) => Promise<",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-common.ActionTypeExecutorResult",
|
||||
"text": "ActionTypeExecutorResult"
|
||||
},
|
||||
"<ExecutorResultData>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/actions/server/types.ts",
|
||||
"lineNumber": 116
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-server.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "server",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-server.ActionTypeExecutorOptions",
|
||||
"text": "ActionTypeExecutorOptions"
|
||||
},
|
||||
"<Config, Secrets, Params>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/actions/server/types.ts",
|
||||
"lineNumber": 84
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -743,7 +788,7 @@
|
|||
"label": "ActionParamsType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
|
||||
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"error\" | \"info\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
|
||||
|
|
@ -760,7 +805,7 @@
|
|||
"label": "ActionParamsType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
|
||||
"{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
|
||||
|
|
@ -923,7 +968,38 @@
|
|||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-server.ActionResult",
|
||||
"text": "ActionResult"
|
||||
}
|
||||
},
|
||||
"<Record<string, unknown>>>; execute: ({ actionId, params, source, }: Pick<",
|
||||
"ExecuteOptions",
|
||||
"<unknown>, \"source\" | \"params\" | \"actionId\">) => Promise<",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-common.ActionTypeExecutorResult",
|
||||
"text": "ActionTypeExecutorResult"
|
||||
},
|
||||
"<unknown>>; getAll: () => Promise<",
|
||||
"FindActionResult",
|
||||
"[]>; getBulk: (ids: string[]) => Promise<",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "server",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-server.ActionResult",
|
||||
"text": "ActionResult"
|
||||
},
|
||||
"<Record<string, unknown>>[]>; enqueueExecution: (options: ",
|
||||
"ExecuteOptions",
|
||||
") => Promise<void>; listTypes: () => Promise<",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-common.ActionType",
|
||||
"text": "ActionType"
|
||||
},
|
||||
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/actions/server/index.ts",
|
||||
|
|
@ -1719,7 +1795,7 @@
|
|||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/actions/common/types.ts",
|
||||
|
|
|
|||
|
|
@ -58,7 +58,9 @@
|
|||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
|
|
@ -74,7 +76,9 @@
|
|||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
|
|
@ -90,7 +94,9 @@
|
|||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -151,7 +157,55 @@
|
|||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 73
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
"id": "def-public.id",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
"id": "def-public.component",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "component",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ComponentClass<Record<string, any> | undefined, any> | React.FunctionComponent<Record<string, any> | undefined>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
"id": "def-public.allowOverride",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "allowOverride",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -198,7 +252,26 @@
|
|||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 78
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
"id": "def-public.id",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
||||
"lineNumber": 67
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -217,15 +290,36 @@
|
|||
"\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context."
|
||||
],
|
||||
"signature": [
|
||||
"React.LazyExoticComponent<typeof ",
|
||||
"React.ExoticComponent<FieldProps & React.RefAttributes<",
|
||||
"Field",
|
||||
">"
|
||||
">> & { readonly _result: typeof ",
|
||||
"Field",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/advanced_settings/public/index.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "advancedSettings",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 359
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -36,7 +36,75 @@
|
|||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.consumer",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "consumer",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.alertType",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertType",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.handler",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(alert: Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertType",
|
||||
"text": "AlertType"
|
||||
},
|
||||
"<\"default\", \"recovered\">) => string | ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.JsonObject",
|
||||
"text": "JsonObject"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 18
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
|
@ -54,7 +122,62 @@
|
|||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.consumer",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "consumer",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.handler",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(alert: Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertType",
|
||||
"text": "AlertType"
|
||||
},
|
||||
"<\"default\", \"recovered\">) => string | ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.JsonObject",
|
||||
"text": "JsonObject"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -103,7 +226,23 @@
|
|||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 23
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.alertId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertId",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"lineNumber": 23
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
@ -496,7 +635,9 @@
|
|||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 46
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
|
@ -514,7 +655,9 @@
|
|||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
|
@ -538,7 +681,9 @@
|
|||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 48
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
|
@ -554,7 +699,9 @@
|
|||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 49
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -659,7 +806,23 @@
|
|||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 75
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -801,7 +964,14 @@
|
|||
"label": "executor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ExecutorType",
|
||||
"(options: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "server",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-server.AlertExecutorOptions",
|
||||
"text": "AlertExecutorOptions"
|
||||
},
|
||||
"<Params, State, InstanceState, InstanceContext, ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
|
|
@ -810,13 +980,39 @@
|
|||
"section": "def-common.WithoutReservedActionGroups",
|
||||
"text": "WithoutReservedActionGroups"
|
||||
},
|
||||
"<ActionGroupIds, RecoveryActionGroupId>>"
|
||||
"<ActionGroupIds, RecoveryActionGroupId>>) => Promise<void | State>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 129
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "server",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-server.AlertExecutorOptions",
|
||||
"text": "AlertExecutorOptions"
|
||||
},
|
||||
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"lineNumber": 107
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
|
@ -909,7 +1105,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
|
||||
"lineNumber": 132
|
||||
"lineNumber": 140
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -922,7 +1118,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
|
||||
"lineNumber": 133
|
||||
"lineNumber": 141
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -935,7 +1131,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
|
||||
"lineNumber": 134
|
||||
"lineNumber": 142
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -948,7 +1144,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
|
||||
"lineNumber": 135
|
||||
"lineNumber": 143
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -968,11 +1164,11 @@
|
|||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
|
||||
"lineNumber": 136
|
||||
"lineNumber": 144
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -988,7 +1184,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 84
|
||||
"lineNumber": 85
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1012,7 +1208,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 85
|
||||
"lineNumber": 86
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1035,7 +1231,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 93
|
||||
"lineNumber": 94
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1055,7 +1251,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 104
|
||||
"lineNumber": 105
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1073,9 +1269,11 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 105
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
|
@ -1101,11 +1299,11 @@
|
|||
"section": "def-server.AlertsClient",
|
||||
"text": "AlertsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"
|
||||
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 106
|
||||
"lineNumber": 107
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1128,7 +1326,60 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 106
|
||||
"lineNumber": 107
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getAlertingAuthorizationWithRequest",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => Pick<",
|
||||
"AlertingAuthorization",
|
||||
", \"ensureAuthorized\" | \"getFindAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 108
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "request",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 109
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1156,9 +1407,11 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 107
|
||||
"lineNumber": 111
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1174,7 +1427,23 @@
|
|||
"label": "ActionGroupIdsOf",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T extends ActionGroup<infer groups> ? groups : T extends Readonly<ActionGroup<infer groups>> ? groups : never"
|
||||
"T extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups> ? groups : T extends Readonly<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups>> ? groups : never"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_type.ts",
|
||||
|
|
@ -1242,7 +1511,7 @@
|
|||
"label": "AlertsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ get: <Params>({ id, }: { id: string; }) => Promise<Pick<",
|
||||
"{ get: <Params extends Record<string, unknown> = never>({ id, }: { id: string; }) => Promise<Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -1250,7 +1519,7 @@
|
|||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<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, }: ",
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: ",
|
||||
"CreateOptions",
|
||||
"<Params>) => Promise<Pick<",
|
||||
{
|
||||
|
|
@ -1260,7 +1529,7 @@
|
|||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<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?: ",
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params extends Record<string, unknown> = never>({ options: { fields, ...options }, }?: { options?: ",
|
||||
"FindOptions",
|
||||
" | undefined; }) => Promise<",
|
||||
{
|
||||
|
|
@ -1269,7 +1538,38 @@
|
|||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-server.FindResult",
|
||||
"text": "FindResult"
|
||||
}
|
||||
},
|
||||
"<Params>>; update: <Params extends Record<string, unknown> = never>({ id, data, }: ",
|
||||
"UpdateOptions",
|
||||
"<Params>) => Promise<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "server",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-server.PartialAlert",
|
||||
"text": "PartialAlert"
|
||||
},
|
||||
"<Params>>; aggregate: ({ options: { fields, ...options }, }?: { options?: ",
|
||||
"AggregateOptions",
|
||||
" | undefined; }) => Promise<",
|
||||
"AggregateResult",
|
||||
">; enable: ({ id }: { id: string; }) => Promise<void>; disable: ({ id }: { id: string; }) => Promise<void>; muteAll: ({ id }: { id: string; }) => Promise<void>; getAlertState: ({ id }: { id: string; }) => Promise<void | { alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }>; getAlertInstanceSummary: ({ id, dateStart, }: ",
|
||||
"GetAlertInstanceSummaryParams",
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertInstanceSummary",
|
||||
"text": "AlertInstanceSummary"
|
||||
},
|
||||
">; updateApiKey: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
|
||||
"MuteOptions",
|
||||
") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ",
|
||||
"MuteOptions",
|
||||
") => Promise<void>; listAlertTypes: () => Promise<Set<",
|
||||
"RegistryAlertTypeWithAuth",
|
||||
">>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/index.ts",
|
||||
|
|
@ -1320,7 +1620,23 @@
|
|||
"label": "PartialAlert",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"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\">>"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Params>, \"id\"> & Partial<Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
|
|
@ -1337,7 +1653,13 @@
|
|||
"label": "PublicAlertInstance",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ getState: () => State; replaceState: (state: State) => AlertInstance<State, Context, ActionGroupIds>; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance<State, Context, ActionGroupIds>; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance<State, Context, ActionGroupIds>; }"
|
||||
"{ getState: () => State; replaceState: (state: State) => ",
|
||||
"AlertInstance",
|
||||
"<State, Context, ActionGroupIds>; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ",
|
||||
"AlertInstance",
|
||||
"<State, Context, ActionGroupIds>; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => ",
|
||||
"AlertInstance",
|
||||
"<State, Context, ActionGroupIds>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts",
|
||||
|
|
@ -2413,13 +2735,7 @@
|
|||
"label": "status",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertInstanceStatusValues",
|
||||
"text": "AlertInstanceStatusValues"
|
||||
}
|
||||
"\"OK\" | \"Active\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
|
||||
|
|
@ -2648,13 +2964,7 @@
|
|||
"label": "status",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertStatusValues",
|
||||
"text": "AlertStatusValues"
|
||||
}
|
||||
"\"OK\" | \"Active\" | \"Error\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
|
||||
|
|
@ -2702,7 +3012,7 @@
|
|||
"label": "instances",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, ",
|
||||
"{ [x: string]: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2710,7 +3020,7 @@
|
|||
"section": "def-common.AlertInstanceStatus",
|
||||
"text": "AlertInstanceStatus"
|
||||
},
|
||||
">"
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
|
||||
|
|
@ -3115,7 +3425,23 @@
|
|||
"label": "ActionGroupIdsOf",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T extends ActionGroup<infer groups> ? groups : T extends Readonly<ActionGroup<infer groups>> ? groups : never"
|
||||
"T extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups> ? groups : T extends Readonly<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<infer groups>> ? groups : never"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_type.ts",
|
||||
|
|
@ -3132,11 +3458,11 @@
|
|||
"label": "AlertActionParam",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"undefined | null | string | number | false | true | ",
|
||||
"string | number | boolean | ",
|
||||
"SavedObjectAttributes",
|
||||
" | ",
|
||||
"SavedObjectAttributeSingle",
|
||||
"[]"
|
||||
"[] | null | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert.ts",
|
||||
|
|
@ -3507,7 +3833,7 @@
|
|||
"label": "ReservedActionGroups",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"RecoveryActionGroupId | \"recovered\""
|
||||
"\"recovered\" | RecoveryActionGroupId"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
||||
|
|
@ -3524,7 +3850,31 @@
|
|||
"label": "SanitizedAlert",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }"
|
||||
"{ enabled: boolean; id: string; name: string; params: Params; actions: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertAction",
|
||||
"text": "AlertAction"
|
||||
},
|
||||
"[]; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.IntervalSchedule",
|
||||
"text": "IntervalSchedule"
|
||||
},
|
||||
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertExecutionStatus",
|
||||
"text": "AlertExecutionStatus"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert.ts",
|
||||
|
|
@ -3541,7 +3891,15 @@
|
|||
"label": "WithoutReservedActionGroups",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ActionGroupIds extends ReservedActionGroups<RecoveryActionGroupId> ? never : ActionGroupIds"
|
||||
"ActionGroupIds extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ReservedActionGroups",
|
||||
"text": "ReservedActionGroups"
|
||||
},
|
||||
"<RecoveryActionGroupId> ? never : ActionGroupIds"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
||||
|
|
@ -3585,7 +3943,8 @@
|
|||
"; }>, ",
|
||||
"PartialC",
|
||||
"<{ spaceId: ",
|
||||
"StringC"
|
||||
"StringC",
|
||||
"; }>]>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_task_instance.ts",
|
||||
|
|
@ -3610,7 +3969,38 @@
|
|||
", ",
|
||||
"UnknownC",
|
||||
">; alertInstances: ",
|
||||
"RecordC"
|
||||
"RecordC",
|
||||
"<",
|
||||
"StringC",
|
||||
", ",
|
||||
"PartialC",
|
||||
"<{ state: ",
|
||||
"RecordC",
|
||||
"<",
|
||||
"StringC",
|
||||
", ",
|
||||
"UnknownC",
|
||||
">; meta: ",
|
||||
"PartialC",
|
||||
"<{ lastScheduledActions: ",
|
||||
"IntersectionC",
|
||||
"<[",
|
||||
"PartialC",
|
||||
"<{ subgroup: ",
|
||||
"StringC",
|
||||
"; }>, ",
|
||||
"TypeC",
|
||||
"<{ group: ",
|
||||
"StringC",
|
||||
"; date: ",
|
||||
"Type",
|
||||
"<Date, string, unknown>; }>]>; }>; }>>; previousStartedAt: ",
|
||||
"UnionC",
|
||||
"<[",
|
||||
"NullC",
|
||||
", ",
|
||||
"Type",
|
||||
"<Date, string, unknown>]>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_task_instance.ts",
|
||||
|
|
@ -3652,7 +4042,20 @@
|
|||
", ",
|
||||
"UnknownC",
|
||||
">; meta: ",
|
||||
"PartialC"
|
||||
"PartialC",
|
||||
"<{ lastScheduledActions: ",
|
||||
"IntersectionC",
|
||||
"<[",
|
||||
"PartialC",
|
||||
"<{ subgroup: ",
|
||||
"StringC",
|
||||
"; }>, ",
|
||||
"TypeC",
|
||||
"<{ group: ",
|
||||
"StringC",
|
||||
"; date: ",
|
||||
"Type",
|
||||
"<Date, string, unknown>; }>]>; }>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/alert_instance.ts",
|
||||
|
|
@ -3669,15 +4072,7 @@
|
|||
"label": "RecoveredActionGroup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<\"recovered\">>"
|
||||
"{ readonly id: \"recovered\"; readonly name: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
||||
|
|
|
|||
3000
api_docs/apm.json
3000
api_docs/apm.json
File diff suppressed because it is too large
Load diff
|
|
@ -645,7 +645,7 @@
|
|||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"
|
||||
"{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/apm_oss/server/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -41,13 +41,7 @@
|
|||
"label": "placement",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "banners",
|
||||
"scope": "common",
|
||||
"docId": "kibBannersPluginApi",
|
||||
"section": "def-common.BannerPlacement",
|
||||
"text": "BannerPlacement"
|
||||
}
|
||||
"\"top\" | \"disabled\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/banners/common/types.ts",
|
||||
|
|
|
|||
|
|
@ -57,7 +57,8 @@
|
|||
"<string[]>; encryptionKey: ",
|
||||
"Type",
|
||||
"<string>; enrollmentTokensTtlInSeconds: ",
|
||||
"Type"
|
||||
"Type",
|
||||
"<number>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/beats_management/common/index.ts",
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@
|
|||
"label": "BatchedFunc",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(payload: Payload, signal: AbortSignal | undefined) => Promise<Result>"
|
||||
"(payload: Payload, signal?: AbortSignal | undefined) => Promise<Result>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/public/batching/types.ts",
|
||||
|
|
@ -100,7 +100,26 @@
|
|||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"FetchStreamingParams"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
|
@ -126,7 +145,27 @@
|
|||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"lineNumber": 26
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"StreamingBatchedFunctionParams",
|
||||
"<Payload, Result>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
@ -174,7 +213,26 @@
|
|||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.data",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BatchItemData"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -266,7 +324,55 @@
|
|||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.path",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "path",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 46
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.handler",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => ",
|
||||
{
|
||||
"pluginId": "bfetch",
|
||||
"scope": "server",
|
||||
"docId": "kibBfetchPluginApi",
|
||||
"section": "def-server.BatchProcessingRouteParams",
|
||||
"text": "BatchProcessingRouteParams"
|
||||
},
|
||||
"<BatchItemData, BatchItemResult>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
|
@ -298,7 +404,55 @@
|
|||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 49
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.path",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "path",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.params",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => ",
|
||||
{
|
||||
"pluginId": "bfetch",
|
||||
"scope": "common",
|
||||
"docId": "kibBfetchPluginApi",
|
||||
"section": "def-common.StreamingResponseHandler",
|
||||
"text": "StreamingResponseHandler"
|
||||
},
|
||||
"<Payload, Response>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
|
@ -349,13 +503,227 @@
|
|||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RequestHandler",
|
||||
"text": "RequestHandler"
|
||||
}
|
||||
},
|
||||
"<P, Q, B, Context, Method, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
||||
"Stream",
|
||||
" | undefined>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<T>) => ",
|
||||
"KibanaResponse",
|
||||
"<T>; badRequest: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 81
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.streamHandler",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "streamHandler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(context: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.RequestHandlerContext",
|
||||
"text": "RequestHandlerContext"
|
||||
},
|
||||
", request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<P, Q, B, Method>) => ",
|
||||
"Observable",
|
||||
"<Response> | Promise<",
|
||||
"Observable",
|
||||
"<Response>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"lineNumber": 89
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -884,7 +1252,26 @@
|
|||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-common.args",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "args",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Func extends (...args: infer P) => any ? P : never"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
|
@ -900,7 +1287,26 @@
|
|||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-common.items",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "items",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BatchEntry[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
|
@ -1136,7 +1542,26 @@
|
|||
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-common.items",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "items",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Item[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
14014
api_docs/cases.json
14014
api_docs/cases.json
File diff suppressed because it is too large
Load diff
|
|
@ -352,7 +352,17 @@
|
|||
"> | undefined, splitChartAccessor?: string | number | ",
|
||||
"AccessorFn",
|
||||
" | undefined, negate?: boolean) => (points: [",
|
||||
"GeometryValue"
|
||||
"GeometryValue",
|
||||
", ",
|
||||
"XYChartSeriesIdentifier",
|
||||
"][]) => ",
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.ClickTriggerEvent",
|
||||
"text": "ClickTriggerEvent"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
|
||||
|
|
@ -588,13 +598,32 @@
|
|||
"label": "LegendToggle",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>"
|
||||
"React.NamedExoticComponent<LegendToggleProps> & { readonly type: ({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/static/components/legend_toggle.tsx",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 359
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -1350,7 +1379,28 @@
|
|||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 81
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.state",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [
|
||||
"The internal state of the palette"
|
||||
],
|
||||
"signature": [
|
||||
"T | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 81
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
|
@ -1402,7 +1452,76 @@
|
|||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 97
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.series",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "series",
|
||||
"description": [
|
||||
"The current series along with its ancestors."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.SeriesLayer",
|
||||
"text": "SeriesLayer"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 98
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.chartConfiguration",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "chartConfiguration",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.ChartColorConfiguration",
|
||||
"text": "ChartColorConfiguration"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 99
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.state",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [
|
||||
"The internal state of the palette"
|
||||
],
|
||||
"signature": [
|
||||
"T | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 100
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
|
@ -1420,7 +1539,39 @@
|
|||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.size",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "size",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.state",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1531,7 +1682,23 @@
|
|||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 110
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 110
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
|
@ -1555,7 +1722,9 @@
|
|||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"lineNumber": 111
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1881,7 +2050,7 @@
|
|||
"label": "LabelRotation",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number"
|
||||
"number"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/static/components/collections.ts",
|
||||
|
|
@ -1960,7 +2129,7 @@
|
|||
"label": "ColorMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>"
|
||||
"{ readonly Background: \"Background\"; readonly Labels: \"Labels\"; readonly None: \"None\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/static/components/collections.ts",
|
||||
|
|
@ -1977,7 +2146,7 @@
|
|||
"label": "LabelRotation",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>"
|
||||
"{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/static/components/collections.ts",
|
||||
|
|
@ -2430,7 +2599,13 @@
|
|||
"label": "ChartsPluginStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ChartsPluginSetup"
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.ChartsPluginSetup",
|
||||
"text": "ChartsPluginSetup"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/public/plugin.ts",
|
||||
|
|
@ -2499,7 +2674,18 @@
|
|||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExecutionContext",
|
||||
"text": "ExecutionContext"
|
||||
}
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
},
|
||||
", ",
|
||||
"SerializableState",
|
||||
">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/common/palette.ts",
|
||||
|
|
@ -2557,7 +2743,10 @@
|
|||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
}
|
||||
},
|
||||
", ",
|
||||
"SerializableState",
|
||||
">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/charts/common/palette.ts",
|
||||
|
|
|
|||
5296
api_docs/core.json
5296
api_docs/core.json
File diff suppressed because one or more lines are too long
|
|
@ -173,7 +173,7 @@
|
|||
"\nThe last action dispatched on the history stack."
|
||||
],
|
||||
"signature": [
|
||||
"Action"
|
||||
"\"PUSH\" | \"POP\" | \"REPLACE\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/scoped_history.ts",
|
||||
|
|
@ -834,20 +834,63 @@
|
|||
"\nA mount function called when the user navigates to this app's route."
|
||||
],
|
||||
"signature": [
|
||||
"(params: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppMount",
|
||||
"text": "AppMount"
|
||||
"section": "def-public.AppMountParameters",
|
||||
"text": "AppMountParameters"
|
||||
},
|
||||
"<HistoryLocationState>"
|
||||
"<HistoryLocationState>) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppUnmount",
|
||||
"text": "AppUnmount"
|
||||
},
|
||||
" | Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppUnmount",
|
||||
"text": "AppUnmount"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"lineNumber": 187
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppMountParameters",
|
||||
"text": "AppMountParameters"
|
||||
},
|
||||
"<HistoryLocationState>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"lineNumber": 339
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
|
|
@ -1191,7 +1234,7 @@
|
|||
"\nGets the read-only capabilities."
|
||||
],
|
||||
"signature": [
|
||||
"Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>"
|
||||
"{ readonly [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; readonly navLinks: Readonly<{ [x: string]: boolean; }>; readonly management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; readonly catalogue: Readonly<{ [x: string]: boolean; }>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
@ -1693,21 +1736,21 @@
|
|||
"plugin": "dashboard",
|
||||
"link": {
|
||||
"path": "src/plugins/dashboard/public/application/dashboard_router.tsx",
|
||||
"lineNumber": 55
|
||||
"lineNumber": 56
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "dashboard",
|
||||
"link": {
|
||||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
"lineNumber": 305
|
||||
"lineNumber": 298
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "lens",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/lens/public/app_plugin/types.ts",
|
||||
"lineNumber": 75
|
||||
"lineNumber": 71
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -1728,7 +1771,7 @@
|
|||
"plugin": "maps",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx",
|
||||
"lineNumber": 60
|
||||
"lineNumber": 59
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -1812,9 +1855,37 @@
|
|||
"plugin": "maps",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts",
|
||||
"lineNumber": 14
|
||||
"lineNumber": 13
|
||||
}
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.handler",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(factory: ",
|
||||
"AppLeaveActionFactory",
|
||||
", nextAppId?: string | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppLeaveAction",
|
||||
"text": "AppLeaveAction"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"lineNumber": 484
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
@ -1841,7 +1912,33 @@
|
|||
"path": "src/core/public/application/types.ts",
|
||||
"lineNumber": 515
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.menuMount",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "menuMount",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.MountPoint",
|
||||
"text": "MountPoint"
|
||||
},
|
||||
"<HTMLElement> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"lineNumber": 515
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2035,7 +2132,7 @@
|
|||
"signature": [
|
||||
"(factory: ",
|
||||
"AppLeaveActionFactory",
|
||||
", nextAppId: string | undefined) => ",
|
||||
", nextAppId?: string | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
|
|
@ -2169,7 +2266,7 @@
|
|||
"\nInput type for registering secondary in-app locations for an application.\n\nDeep links must include at least one of `path` or `searchDeepLinks`. A deep link that does not have a `path`\nrepresents a topological level in the application's hierarchy, but does not have a destination URL that is\nuser-accessible."
|
||||
],
|
||||
"signature": [
|
||||
"{ id: string; title: string; } & { path: string; searchDeepLinks?: ",
|
||||
"({ id: string; title: string; } & { path: string; searchDeepLinks?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
|
|
@ -2177,7 +2274,7 @@
|
|||
"section": "def-public.AppSearchDeepLink",
|
||||
"text": "AppSearchDeepLink"
|
||||
},
|
||||
"[] | undefined; keywords?: string[] | undefined; } | { id: string; title: string; } & { path?: string | undefined; searchDeepLinks: ",
|
||||
"[] | undefined; keywords?: string[] | undefined; }) | ({ id: string; title: string; } & { path?: string | undefined; searchDeepLinks: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
|
|
@ -2185,7 +2282,7 @@
|
|||
"section": "def-public.AppSearchDeepLink",
|
||||
"text": "AppSearchDeepLink"
|
||||
},
|
||||
"[]; keywords?: string[] | undefined; }"
|
||||
"[]; keywords?: string[] | undefined; })"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
@ -2223,7 +2320,31 @@
|
|||
"\nDefines the list of fields that can be updated via an {@link AppUpdater}."
|
||||
],
|
||||
"signature": [
|
||||
"{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }"
|
||||
"{ status?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppStatus",
|
||||
"text": "AppStatus"
|
||||
},
|
||||
" | undefined; meta?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppMeta",
|
||||
"text": "AppMeta"
|
||||
},
|
||||
" | undefined; navLinkStatus?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppNavLinkStatus",
|
||||
"text": "AppNavLinkStatus"
|
||||
},
|
||||
" | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
@ -2277,7 +2398,39 @@
|
|||
"\nPublic information about a registered {@link App | application}\n"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<App<unknown>, \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.App",
|
||||
"text": "App"
|
||||
},
|
||||
"<unknown>, \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppStatus",
|
||||
"text": "AppStatus"
|
||||
},
|
||||
"; navLinkStatus: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppNavLinkStatus",
|
||||
"text": "AppNavLinkStatus"
|
||||
},
|
||||
"; appRoute: string; meta: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.PublicAppMetaInfo",
|
||||
"text": "PublicAppMetaInfo"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
@ -2296,7 +2449,23 @@
|
|||
"\nPublic information about a registered app's {@link AppMeta | keywords }\n"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<AppMeta, never> & { keywords: string[]; searchDeepLinks: PublicAppSearchDeepLinkInfo[]; }"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppMeta",
|
||||
"text": "AppMeta"
|
||||
},
|
||||
", never> & { keywords: string[]; searchDeepLinks: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.PublicAppSearchDeepLinkInfo",
|
||||
"text": "PublicAppSearchDeepLinkInfo"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
@ -2315,7 +2484,23 @@
|
|||
"\nPublic information about a registered app's {@link AppSearchDeepLink | searchDeepLinks}\n"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<AppSearchDeepLink, \"title\" | \"id\" | \"path\"> & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppSearchDeepLink",
|
||||
"text": "AppSearchDeepLink"
|
||||
},
|
||||
", \"title\" | \"id\" | \"path\"> & { searchDeepLinks: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.PublicAppSearchDeepLinkInfo",
|
||||
"text": "PublicAppSearchDeepLinkInfo"
|
||||
},
|
||||
"[]; keywords: string[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/application/types.ts",
|
||||
|
|
|
|||
|
|
@ -284,7 +284,24 @@
|
|||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForButton"
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
|
||||
"DisambiguateSet",
|
||||
"<",
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForAnchor",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
|
||||
|
|
@ -335,7 +352,7 @@
|
|||
"\nContent of the button (in lieu of `children`)"
|
||||
],
|
||||
"signature": [
|
||||
"React.ReactNode"
|
||||
"string | number | boolean | {} | React.ReactElement<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 | null | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
|
||||
|
|
@ -368,7 +385,24 @@
|
|||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForButton"
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
|
||||
"DisambiguateSet",
|
||||
"<",
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForAnchor",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
|
||||
|
|
@ -434,7 +468,24 @@
|
|||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForButton"
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
|
||||
"DisambiguateSet",
|
||||
"<",
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForAnchor",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
|
||||
|
|
@ -500,7 +551,24 @@
|
|||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForButton"
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
|
||||
"DisambiguateSet",
|
||||
"<",
|
||||
"PropsForButton",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>, ",
|
||||
"PropsForAnchor",
|
||||
"<",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
", {}>> & ",
|
||||
"CommonEuiButtonEmptyProps",
|
||||
" & { href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>), \"iconType\" | \"data-test-subj\" | \"target\" | \"rel\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
|
||||
|
|
@ -602,20 +670,39 @@
|
|||
"label": "mount",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(element: HTMLElement) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.MountPoint",
|
||||
"text": "MountPoint"
|
||||
},
|
||||
"<HTMLElement>"
|
||||
"section": "def-public.UnmountCallback",
|
||||
"text": "UnmountCallback"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
|
||||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.element",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "element",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/types.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1230,7 +1317,7 @@
|
|||
"section": "def-public.ChromeNavLink",
|
||||
"text": "ChromeNavLink"
|
||||
},
|
||||
", \"hidden\" | \"disabled\" | \"href\" | \"url\">>) => ",
|
||||
", \"hidden\" | \"url\" | \"disabled\" | \"href\">>) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
|
|
@ -1295,7 +1382,7 @@
|
|||
"section": "def-public.ChromeNavLink",
|
||||
"text": "ChromeNavLink"
|
||||
},
|
||||
", \"hidden\" | \"disabled\" | \"href\" | \"url\">>"
|
||||
", \"hidden\" | \"url\" | \"disabled\" | \"href\">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
|
||||
|
|
@ -2469,20 +2556,39 @@
|
|||
"label": "content",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(element: HTMLDivElement) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.MountPoint",
|
||||
"text": "MountPoint"
|
||||
},
|
||||
"<HTMLDivElement>"
|
||||
"section": "def-public.UnmountCallback",
|
||||
"text": "UnmountCallback"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/types.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.element",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "element",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/types.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2499,11 +2605,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"CommonProps",
|
||||
" & { text: ",
|
||||
"ReactNode",
|
||||
"; href?: string | undefined; onClick?: ((event: ",
|
||||
"MouseEvent",
|
||||
"<HTMLAnchorElement, MouseEvent>) => void) | undefined; truncate?: boolean | undefined; }"
|
||||
" & { text: React.ReactNode; href?: string | undefined; onClick?: ((event: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => void) | undefined; truncate?: boolean | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/types.ts",
|
||||
|
|
@ -2584,7 +2686,7 @@
|
|||
"label": "ChromeNavLinkUpdateableFields",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }"
|
||||
"{ readonly hidden?: boolean | undefined; readonly url?: string | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/core/public/chrome/nav_links/nav_link.ts",
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -42,11 +42,12 @@
|
|||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerOutput",
|
||||
"text": "ContainerOutput"
|
||||
}
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 103
|
||||
"lineNumber": 105
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -62,7 +63,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 104
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -86,7 +87,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 105
|
||||
"lineNumber": 107
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -102,7 +103,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 107
|
||||
"lineNumber": 109
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -120,7 +121,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 111
|
||||
"lineNumber": 113
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -142,7 +143,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 112
|
||||
"lineNumber": 114
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -159,7 +160,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 113
|
||||
"lineNumber": 115
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -199,7 +200,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 114
|
||||
"lineNumber": 116
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
|
|
@ -242,11 +243,12 @@
|
|||
"<TEmbeddableInput, any, TEmbeddable, ",
|
||||
"SavedObjectAttributes",
|
||||
">, partial?: Partial<TEmbeddableInput>) => ",
|
||||
"DashboardPanelState"
|
||||
"DashboardPanelState",
|
||||
"<TEmbeddableInput>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 127
|
||||
"lineNumber": 129
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -271,7 +273,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 131
|
||||
"lineNumber": 133
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -288,7 +290,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 132
|
||||
"lineNumber": 134
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -320,7 +322,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 138
|
||||
"lineNumber": 140
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -344,7 +346,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 139
|
||||
"lineNumber": 141
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -362,7 +364,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 140
|
||||
"lineNumber": 142
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
|
|
@ -379,7 +381,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 141
|
||||
"lineNumber": 143
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
|
|
@ -417,7 +419,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 179
|
||||
"lineNumber": 181
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -442,7 +444,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 180
|
||||
"lineNumber": 182
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -467,7 +469,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 181
|
||||
"lineNumber": 183
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -484,7 +486,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 182
|
||||
"lineNumber": 184
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
|
|
@ -539,11 +541,28 @@
|
|||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IEmbeddable",
|
||||
"text": "IEmbeddable"
|
||||
}
|
||||
},
|
||||
"<EEI, EEO> = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IEmbeddable",
|
||||
"text": "IEmbeddable"
|
||||
},
|
||||
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>, embeddableId?: string | undefined) => Promise<void | E | ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ErrorEmbeddable",
|
||||
"text": "ErrorEmbeddable"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 226
|
||||
"lineNumber": 228
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -559,7 +578,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 230
|
||||
"lineNumber": 232
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -576,7 +595,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 230
|
||||
"lineNumber": 232
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -593,7 +612,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 230
|
||||
"lineNumber": 232
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
|
|
@ -613,7 +632,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 244
|
||||
"lineNumber": 246
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -629,7 +648,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 244
|
||||
"lineNumber": 246
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -650,7 +669,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 255
|
||||
"lineNumber": 259
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -666,7 +685,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 255
|
||||
"lineNumber": 259
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -723,7 +742,10 @@
|
|||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-public.DashboardContainer",
|
||||
"text": "DashboardContainer"
|
||||
}
|
||||
},
|
||||
", ",
|
||||
"SavedObjectAttributes",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
||||
|
|
@ -933,7 +955,16 @@
|
|||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-public.DashboardContainer",
|
||||
"text": "DashboardContainer"
|
||||
}
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ErrorEmbeddable",
|
||||
"text": "ErrorEmbeddable"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
||||
|
|
@ -1038,7 +1069,43 @@
|
|||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.state",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.references",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectReference",
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
|
|
@ -1072,7 +1139,26 @@
|
|||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
||||
"lineNumber": 76
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.state",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/common/persistable_state/index.ts",
|
||||
"lineNumber": 46
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1223,7 +1309,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 42
|
||||
"lineNumber": 43
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1240,7 +1326,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 43
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1263,7 +1349,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 44
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1279,7 +1365,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 45
|
||||
"lineNumber": 46
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1292,7 +1378,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 46
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1308,7 +1394,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 47
|
||||
"lineNumber": 48
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1320,17 +1406,11 @@
|
|||
"label": "timeRange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
}
|
||||
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 48
|
||||
"lineNumber": 49
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1346,7 +1426,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 49
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1359,7 +1439,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 50
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1375,7 +1455,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 51
|
||||
"lineNumber": 52
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1397,7 +1477,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 52
|
||||
"lineNumber": 53
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1420,7 +1500,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 53
|
||||
"lineNumber": 54
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1433,7 +1513,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 54
|
||||
"lineNumber": 55
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1445,17 +1525,11 @@
|
|||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.Query",
|
||||
"text": "Query"
|
||||
}
|
||||
"{ query: string | { [key: string]: any; }; language: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 55
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1481,7 +1555,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
||||
"lineNumber": 56
|
||||
"lineNumber": 57
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -1713,7 +1787,7 @@
|
|||
"label": "searchSource",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"{ create: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
@ -1721,7 +1795,175 @@
|
|||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"
|
||||
"; history: Record<string, any>[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, value: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceFields",
|
||||
"text": "SearchSourceFields"
|
||||
},
|
||||
"[K]) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
"; removeField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
"; setFields: (newFields: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceFields",
|
||||
"text": "SearchSourceFields"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
"; getId: () => string; getFields: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceFields",
|
||||
"text": "SearchSourceFields"
|
||||
},
|
||||
"; getField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceFields",
|
||||
"text": "SearchSourceFields"
|
||||
},
|
||||
"[K]; getOwnField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceFields",
|
||||
"text": "SearchSourceFields"
|
||||
},
|
||||
"[K]; createCopy: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
"; createChild: (options?: {}) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
"; setParent: (parent?: Pick<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceOptions",
|
||||
"text": "SearchSourceOptions"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
"; getParent: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
" | undefined; fetch$: (options?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.ISearchOptions",
|
||||
"text": "ISearchOptions"
|
||||
},
|
||||
") => ",
|
||||
"Observable",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.IKibanaSearchResponse",
|
||||
"text": "IKibanaSearchResponse"
|
||||
},
|
||||
"<",
|
||||
"SearchResponse",
|
||||
"<any>>>; fetch: (options?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.ISearchOptions",
|
||||
"text": "ISearchOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
"SearchResponse",
|
||||
"<any>>; onRequestStart: (handler: (searchSource: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
", options?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.ISearchOptions",
|
||||
"text": "ISearchOptions"
|
||||
},
|
||||
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSourceFields",
|
||||
"text": "SearchSourceFields"
|
||||
},
|
||||
"; serialize: () => { searchSourceJSON: string; references: ",
|
||||
"SavedObjectReference",
|
||||
"[]; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
|
|
@ -1794,7 +2036,26 @@
|
|||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.editMode",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "editMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2100,7 +2361,14 @@
|
|||
"label": "DashboardUrlGenerator",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">"
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "public",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-public.UrlGeneratorContract",
|
||||
"text": "UrlGeneratorContract"
|
||||
},
|
||||
"<\"DASHBOARD_APP_URL_GENERATOR\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
|
|
@ -2119,7 +2387,15 @@
|
|||
"\nThis should always represent the latest dashboard panel shape, after all possible migrations."
|
||||
],
|
||||
"signature": [
|
||||
"Pick<RawSavedDashboardPanel730ToLatest, \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.RawSavedDashboardPanel730ToLatest",
|
||||
"text": "RawSavedDashboardPanel730ToLatest"
|
||||
},
|
||||
", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2303,7 +2579,9 @@
|
|||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
"lineNumber": 126
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
|
|
@ -2319,7 +2597,9 @@
|
|||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
"lineNumber": 127
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
|
|
@ -2390,7 +2670,7 @@
|
|||
"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; }[]>"
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\">, embeddableType: string) => Promise<{ [key: string]: unknown; }[]>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
|
||||
|
|
@ -2414,7 +2694,7 @@
|
|||
"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\">"
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
|
||||
|
|
@ -2508,7 +2788,40 @@
|
|||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanelTo60",
|
||||
"text": "SavedDashboardPanelTo60"
|
||||
}
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanel610",
|
||||
"text": "SavedDashboardPanel610"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanel620",
|
||||
"text": "SavedDashboardPanel620"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanel630",
|
||||
"text": "SavedDashboardPanel630"
|
||||
},
|
||||
")[], version: string, useMargins: boolean, uiState: { [key: string]: { [key: string]: unknown; }; } | undefined) => ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.RawSavedDashboardPanel730ToLatest",
|
||||
"text": "RawSavedDashboardPanel730ToLatest"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
||||
|
|
@ -2539,7 +2852,32 @@
|
|||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanelTo60",
|
||||
"text": "SavedDashboardPanelTo60"
|
||||
}
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanel610",
|
||||
"text": "SavedDashboardPanel610"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanel620",
|
||||
"text": "SavedDashboardPanel620"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.SavedDashboardPanel630",
|
||||
"text": "SavedDashboardPanel630"
|
||||
},
|
||||
")[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
||||
|
|
@ -2821,7 +3159,9 @@
|
|||
"label": "RawSavedDashboardPanel730ToLatest",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<Pick<RawSavedDashboardPanel620, \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }"
|
||||
"Pick<Pick<",
|
||||
"RawSavedDashboardPanel620",
|
||||
", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/bwc/types.ts",
|
||||
|
|
@ -2838,7 +3178,9 @@
|
|||
"label": "SavedDashboardPanel610",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<RawSavedDashboardPanel610, \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }"
|
||||
"Pick<",
|
||||
"RawSavedDashboardPanel610",
|
||||
", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2855,7 +3197,9 @@
|
|||
"label": "SavedDashboardPanel620",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<RawSavedDashboardPanel620, \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
||||
"Pick<",
|
||||
"RawSavedDashboardPanel620",
|
||||
", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2872,7 +3216,9 @@
|
|||
"label": "SavedDashboardPanel630",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<RawSavedDashboardPanel620, \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
||||
"Pick<",
|
||||
"RawSavedDashboardPanel620",
|
||||
", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2889,7 +3235,9 @@
|
|||
"label": "SavedDashboardPanel640To720",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<Pick<RawSavedDashboardPanel620, \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
||||
"Pick<Pick<",
|
||||
"RawSavedDashboardPanel620",
|
||||
", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2906,7 +3254,15 @@
|
|||
"label": "SavedDashboardPanel730ToLatest",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<RawSavedDashboardPanel730ToLatest, \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.RawSavedDashboardPanel730ToLatest",
|
||||
"text": "RawSavedDashboardPanel730ToLatest"
|
||||
},
|
||||
", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2923,7 +3279,9 @@
|
|||
"label": "SavedDashboardPanelTo60",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<RawSavedDashboardPanelTo60, \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }"
|
||||
"Pick<",
|
||||
"RawSavedDashboardPanelTo60",
|
||||
", \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/types.ts",
|
||||
|
|
@ -2933,6 +3291,36 @@
|
|||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
"objects": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.UI_SETTINGS",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "UI_SETTINGS",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/index.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.UI_SETTINGS.ENABLE_LABS_UI",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ENABLE_LABS_UI",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/dashboard/common/index.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -47,6 +47,9 @@ import dashboardObj from './dashboard.json';
|
|||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={dashboardObj.common.objects}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={dashboardObj.common.functions}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -118,7 +118,9 @@
|
|||
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboardEnhanced",
|
||||
|
|
@ -253,12 +255,13 @@
|
|||
"label": "CollectConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.UiComponent",
|
||||
"text": "UiComponent"
|
||||
"section": "def-common.UiComponentInstance",
|
||||
"text": "UiComponentInstance"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
|
|
@ -290,7 +293,9 @@
|
|||
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
|
||||
"lineNumber": 54
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboardEnhanced",
|
||||
|
|
@ -510,12 +515,13 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"pluginId": "share",
|
||||
"scope": "public",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-public.DashboardUrlGenerator",
|
||||
"text": "DashboardUrlGenerator"
|
||||
}
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-public.UrlGeneratorContract",
|
||||
"text": "UrlGeneratorContract"
|
||||
},
|
||||
"<\"DASHBOARD_APP_URL_GENERATOR\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
|
||||
|
|
@ -550,12 +556,13 @@
|
|||
"label": "start",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "public",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-public.StartServicesGetter",
|
||||
"text": "StartServicesGetter"
|
||||
"section": "def-public.StartServices",
|
||||
"text": "StartServices"
|
||||
},
|
||||
"<{ uiActionsEnhanced: ",
|
||||
{
|
||||
|
|
@ -588,13 +595,16 @@
|
|||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.CoreStart",
|
||||
"text": "CoreStart"
|
||||
}
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -664,13 +674,17 @@
|
|||
"label": "share",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ register: (shareMenuProvider: ",
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "public",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-public.SharePluginSetup",
|
||||
"text": "SharePluginSetup"
|
||||
}
|
||||
"section": "def-public.ShareMenuProvider",
|
||||
"text": "ShareMenuProvider"
|
||||
},
|
||||
") => void; } & { urlGenerators: ",
|
||||
"UrlGeneratorsSetup",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
|
||||
|
|
@ -768,13 +782,17 @@
|
|||
"label": "share",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ toggleShareContextMenu: (options: ",
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "public",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-public.SharePluginStart",
|
||||
"text": "SharePluginStart"
|
||||
}
|
||||
"section": "def-public.ShowShareMenuOptions",
|
||||
"text": "ShowShareMenuOptions"
|
||||
},
|
||||
") => void; } & { urlGenerators: ",
|
||||
"UrlGeneratorsStart",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
|
||||
|
|
|
|||
17220
api_docs/data.json
17220
api_docs/data.json
File diff suppressed because it is too large
Load diff
|
|
@ -356,7 +356,17 @@
|
|||
"label": "AutocompleteStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"
|
||||
"{ getQuerySuggestions: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataAutocompletePluginApi",
|
||||
"section": "def-public.QuerySuggestionGetFn",
|
||||
"text": "QuerySuggestionGetFn"
|
||||
},
|
||||
"; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ",
|
||||
"ValueSuggestionsGetFn",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/autocomplete/autocomplete_service.ts",
|
||||
|
|
|
|||
|
|
@ -37,7 +37,17 @@
|
|||
"label": "FieldFormatsStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<FieldFormatsRegistry, \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\"> & { deserialize: FormatFactory; }"
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormatsRegistry",
|
||||
"text": "FieldFormatsRegistry"
|
||||
},
|
||||
", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\"> & { deserialize: ",
|
||||
"FormatFactory",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/field_formats/field_formats_service.ts",
|
||||
|
|
@ -1213,15 +1223,10 @@
|
|||
"label": "from",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
".from"
|
||||
"(convertFn: ",
|
||||
"FieldFormatConvertFunction",
|
||||
") => ",
|
||||
"FieldFormatInstanceType"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_format.ts",
|
||||
|
|
@ -1276,15 +1281,14 @@
|
|||
"label": "isInstanceOfFieldFormat",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"(fieldFormat: any) => fieldFormat is ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
".isInstanceOfFieldFormat"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_format.ts",
|
||||
|
|
@ -2085,7 +2089,39 @@
|
|||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 162
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.formatId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "formatId",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 163
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 163
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -2381,7 +2417,71 @@
|
|||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 242
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.fieldType",
|
||||
"type": "Enum",
|
||||
"tags": [],
|
||||
"label": "fieldType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 187
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.esTypes",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "esTypes",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 188
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
|
||||
"lineNumber": 189
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -4138,7 +4238,7 @@
|
|||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/types.ts",
|
||||
|
|
@ -4245,7 +4345,7 @@
|
|||
"label": "FieldFormatsGetConfigFn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(key: string, defaultOverride: T | undefined) => T"
|
||||
"<T = any>(key: string, defaultOverride?: T | undefined) => T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/types.ts",
|
||||
|
|
@ -4262,7 +4362,19 @@
|
|||
"label": "FieldFormatsStartCommon",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record<string, any>, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ",
|
||||
"{ init: (getConfig: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.GetConfigFn",
|
||||
"text": "GetConfigFn"
|
||||
},
|
||||
", metaParamsOptions?: Record<string, any>, defaultFieldConverters?: ",
|
||||
"FieldFormatInstanceType",
|
||||
"[]) => void; register: (fieldFormats: ",
|
||||
"FieldFormatInstanceType",
|
||||
"[]) => void; deserialize: ",
|
||||
"FormatFactory",
|
||||
"; getDefaultConfig: (fieldType: ",
|
||||
{
|
||||
|
|
@ -4280,7 +4392,19 @@
|
|||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (fieldType: ",
|
||||
"[] | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormatConfig",
|
||||
"text": "FieldFormatConfig"
|
||||
},
|
||||
"; getType: (formatId: string) => ",
|
||||
"FieldFormatInstanceType",
|
||||
" | undefined; getTypeWithoutMetaParams: (formatId: string) => ",
|
||||
"FieldFormatInstanceType",
|
||||
" | undefined; getDefaultType: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
@ -4295,7 +4419,140 @@
|
|||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
}
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
"FieldFormatInstanceType",
|
||||
" | undefined; getTypeNameByEsTypes: (esTypes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
" | undefined; getDefaultTypeName: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"; getInstance: ((formatId: string, params?: Record<string, any>) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
") & _.MemoizedFunction; getDefaultInstancePlain: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined, params?: Record<string, any>) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
"; getDefaultInstanceCacheResolver: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[]) => string; getByFieldType: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
") => ",
|
||||
"FieldFormatInstanceType",
|
||||
"[]; getDefaultInstance: ((fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined, params?: Record<string, any>) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
") & _.MemoizedFunction; parseDefaultTypeMap: (value: any) => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/types.ts",
|
||||
|
|
@ -4312,13 +4569,7 @@
|
|||
"label": "HTML_CONTEXT_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormatsContentType",
|
||||
"text": "FieldFormatsContentType"
|
||||
}
|
||||
"\"html\" | \"text\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts",
|
||||
|
|
@ -4335,7 +4586,13 @@
|
|||
"label": "IFieldFormat",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"FieldFormat"
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/types.ts",
|
||||
|
|
@ -4373,7 +4630,176 @@
|
|||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
}
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormatConfig",
|
||||
"text": "FieldFormatConfig"
|
||||
},
|
||||
"; getType: (formatId: string) => ",
|
||||
"FieldFormatInstanceType",
|
||||
" | undefined; getTypeWithoutMetaParams: (formatId: string) => ",
|
||||
"FieldFormatInstanceType",
|
||||
" | undefined; getDefaultType: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
"FieldFormatInstanceType",
|
||||
" | undefined; getTypeNameByEsTypes: (esTypes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
" | undefined; getDefaultTypeName: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"; getInstance: ((formatId: string, params?: Record<string, any>) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
") & _.MemoizedFunction; getDefaultInstancePlain: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined, params?: Record<string, any>) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
"; getDefaultInstanceCacheResolver: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[]) => string; getByFieldType: (fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
") => ",
|
||||
"FieldFormatInstanceType",
|
||||
"[]; getDefaultInstance: ((fieldType: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.KBN_FIELD_TYPES",
|
||||
"text": "KBN_FIELD_TYPES"
|
||||
},
|
||||
", esTypes?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
"[] | undefined, params?: Record<string, any>) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormat",
|
||||
"text": "FieldFormat"
|
||||
},
|
||||
") & _.MemoizedFunction; parseDefaultTypeMap: (value: any) => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/index.ts",
|
||||
|
|
@ -4390,13 +4816,7 @@
|
|||
"label": "TEXT_CONTEXT_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataFieldFormatsPluginApi",
|
||||
"section": "def-common.FieldFormatsContentType",
|
||||
"text": "FieldFormatsContentType"
|
||||
}
|
||||
"\"html\" | \"text\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/field_formats/content_types/text_content_type.ts",
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -528,15 +528,23 @@
|
|||
"label": "setFiltersStore",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"(filters: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.FilterManager",
|
||||
"text": "FilterManager"
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
".setFiltersStore"
|
||||
"[], store: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.FilterStateStore",
|
||||
"text": "FilterStateStore"
|
||||
},
|
||||
", shouldOverrideStore?: boolean) => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
|
|
@ -794,7 +802,114 @@
|
|||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.SavedQueryService",
|
||||
"text": "SavedQueryService"
|
||||
}
|
||||
},
|
||||
"; state$: ",
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; getEsQuery: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.DslQuery",
|
||||
"text": "DslQuery"
|
||||
},
|
||||
"[]; filter: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; should: never[]; must_not: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.FilterManager",
|
||||
"text": "FilterManager"
|
||||
},
|
||||
"; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; queryString: Pick<",
|
||||
"QueryStringManager",
|
||||
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, stateContainer: ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.BaseStateContainer",
|
||||
"text": "BaseStateContainer"
|
||||
},
|
||||
"<S>, syncConfig: { time?: boolean | undefined; refreshInterval?: boolean | undefined; filters?: boolean | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.FilterStateStore",
|
||||
"text": "FilterStateStore"
|
||||
},
|
||||
" | undefined; query?: boolean | undefined; }) => () => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
|
||||
|
|
@ -837,7 +952,96 @@
|
|||
"text": "SavedQueryService"
|
||||
},
|
||||
"; state$: ",
|
||||
"Observable"
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; getEsQuery: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.DslQuery",
|
||||
"text": "DslQuery"
|
||||
},
|
||||
"[]; filter: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; should: never[]; must_not: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.FilterManager",
|
||||
"text": "FilterManager"
|
||||
},
|
||||
"; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; queryString: Pick<",
|
||||
"QueryStringManager",
|
||||
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts",
|
||||
|
|
@ -1099,7 +1303,104 @@
|
|||
"text": "SavedQueryService"
|
||||
},
|
||||
"; state$: ",
|
||||
"Observable"
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; getEsQuery: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.DslQuery",
|
||||
"text": "DslQuery"
|
||||
},
|
||||
"[]; filter: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; should: never[]; must_not: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.FilterManager",
|
||||
"text": "FilterManager"
|
||||
},
|
||||
"; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; queryString: Pick<",
|
||||
"QueryStringManager",
|
||||
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "public",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-public.IKbnUrlStateStorage",
|
||||
"text": "IKbnUrlStateStorage"
|
||||
},
|
||||
") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
|
||||
|
|
@ -1142,7 +1443,96 @@
|
|||
"text": "SavedQueryService"
|
||||
},
|
||||
"; state$: ",
|
||||
"Observable"
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; getEsQuery: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.DslQuery",
|
||||
"text": "DslQuery"
|
||||
},
|
||||
"[]; filter: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; should: never[]; must_not: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.FilterManager",
|
||||
"text": "FilterManager"
|
||||
},
|
||||
"; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; queryString: Pick<",
|
||||
"QueryStringManager",
|
||||
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ",
|
||||
"Observable",
|
||||
"<{ changes: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
"; state: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
"; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts",
|
||||
|
|
@ -1430,7 +1820,42 @@
|
|||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.attributes",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "attributes",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedQueryAttributes"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.config",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ overwrite: boolean; } | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -1454,7 +1879,9 @@
|
|||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -1478,7 +1905,58 @@
|
|||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.searchText",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "searchText",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.perPage",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "perPage",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 36
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.activePage",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "activePage",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -1502,7 +1980,23 @@
|
|||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 39
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 39
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -1518,7 +2012,23 @@
|
|||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
@ -1534,7 +2044,9 @@
|
|||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1595,15 +2107,25 @@
|
|||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.Query",
|
||||
"text": "Query"
|
||||
},
|
||||
") => void; filterManager: FilterManager; queryString: Pick<QueryStringManager, \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
|
||||
") => void; filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataPluginApi",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.FilterManager",
|
||||
"text": "FilterManager"
|
||||
},
|
||||
"; queryString: Pick<",
|
||||
"QueryStringManager",
|
||||
", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.SavedQueryService",
|
||||
"text": "SavedQueryService"
|
||||
},
|
||||
|
|
@ -1613,7 +2135,7 @@
|
|||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataPluginApi",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryStateChange",
|
||||
"text": "QueryStateChange"
|
||||
},
|
||||
|
|
@ -1621,10 +2143,53 @@
|
|||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataPluginApi",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
}
|
||||
},
|
||||
"; }>; timefilter: ",
|
||||
"TimefilterSetup",
|
||||
"; getEsQuery: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.DslQuery",
|
||||
"text": "DslQuery"
|
||||
},
|
||||
"[]; filter: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; should: never[]; must_not: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; }; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/query_service.ts",
|
||||
|
|
@ -1641,7 +2206,22 @@
|
|||
"label": "SavedQueryTimeFilter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"TimeRange & { refreshInterval: RefreshInterval; }"
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" & { refreshInterval: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
|
|
@ -1666,8 +2246,129 @@
|
|||
"Observable",
|
||||
"<unknown>; getAutoRefreshFetch$: () => ",
|
||||
"Observable",
|
||||
"<AutoRefreshDoneFn>; getFetch$: () => ",
|
||||
"Observable"
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.AutoRefreshDoneFn",
|
||||
"text": "AutoRefreshDoneFn"
|
||||
},
|
||||
">; getFetch$: () => ",
|
||||
"Observable",
|
||||
"<unknown>; getTime: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"; getAbsoluteTime: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"; setTime: (time: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.InputTimeRange",
|
||||
"text": "InputTimeRange"
|
||||
},
|
||||
") => void; getRefreshInterval: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
"; setRefreshInterval: (refreshInterval: Partial<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
">) => void; createFilter: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.RangeFilter",
|
||||
"text": "RangeFilter"
|
||||
},
|
||||
" | undefined; getBounds: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRangeBounds",
|
||||
"text": "TimeRangeBounds"
|
||||
},
|
||||
"; calculateBounds: (timeRange: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRangeBounds",
|
||||
"text": "TimeRangeBounds"
|
||||
},
|
||||
"; getActiveBounds: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRangeBounds",
|
||||
"text": "TimeRangeBounds"
|
||||
},
|
||||
" | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"; getRefreshIntervalDefaults: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/timefilter/timefilter.ts",
|
||||
|
|
@ -1684,7 +2385,23 @@
|
|||
"label": "TimeHistoryContract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ add: (time: TimeRange) => void; get: () => TimeRange[]; }"
|
||||
"{ add: (time: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
") => void; get: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/public/query/timefilter/time_history.ts",
|
||||
|
|
@ -1831,7 +2548,8 @@
|
|||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.FilterCompareOptions",
|
||||
"text": "FilterCompareOptions"
|
||||
}
|
||||
},
|
||||
") => boolean"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/data/common/query/filter_manager/compare_filters.ts",
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load diff
|
|
@ -204,7 +204,30 @@
|
|||
"path": "src/plugins/dev_tools/public/plugin.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "devTools",
|
||||
"id": "def-public.devTool",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "devTool",
|
||||
"description": [
|
||||
"The dev tools descriptor"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"DevToolApp",
|
||||
", \"title\" | \"id\" | \"order\" | \"mount\" | \"tooltipContent\" | \"enableRouting\"> & { disabled?: boolean | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/dev_tools/public/plugin.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
|
|
@ -539,7 +539,9 @@
|
|||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
|
|
@ -563,7 +565,32 @@
|
|||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 23
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.saveOptions",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "saveOptions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectSaveOpts",
|
||||
"text": "SavedObjectSaveOpts"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 23
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
|
|
@ -651,7 +678,23 @@
|
|||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
|
|
@ -667,7 +710,23 @@
|
|||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -710,13 +769,7 @@
|
|||
"label": "timeRange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
}
|
||||
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/discover/public/application/embeddable/types.ts",
|
||||
|
|
|
|||
|
|
@ -344,7 +344,8 @@
|
|||
"text": "Action"
|
||||
},
|
||||
"<",
|
||||
"ExploreDataChartActionContext"
|
||||
"ExploreDataChartActionContext",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
|
||||
|
|
@ -724,15 +725,41 @@
|
|||
"label": "uiActions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"{ readonly addTriggerAction: (triggerId: string, action: ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.UiActionsService",
|
||||
"text": "UiActionsService"
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">"
|
||||
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(definition: A) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<",
|
||||
"ActionContext",
|
||||
"<A>>; readonly registerTrigger: (trigger: ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Trigger",
|
||||
"text": "Trigger"
|
||||
},
|
||||
") => void; readonly unregisterAction: (actionId: string) => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
|
||||
|
|
@ -849,7 +876,7 @@
|
|||
"label": "uiActions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"{ readonly clear: () => void; readonly fork: () => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
|
|
@ -857,17 +884,77 @@
|
|||
"section": "def-public.UiActionsService",
|
||||
"text": "UiActionsService"
|
||||
},
|
||||
", ",
|
||||
"MethodKeysOf",
|
||||
"; readonly addTriggerAction: (triggerId: string, action: ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(definition: A) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<",
|
||||
"ActionContext",
|
||||
"<A>>; readonly registerTrigger: (trigger: ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.UiActionsService",
|
||||
"text": "UiActionsService"
|
||||
"section": "def-public.Trigger",
|
||||
"text": "Trigger"
|
||||
},
|
||||
">>"
|
||||
") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ",
|
||||
"TriggerContract",
|
||||
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: <T extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(id: string) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<",
|
||||
"ActionContext",
|
||||
"<T>>; readonly getTriggerActions: (triggerId: string) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<object>[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -95,14 +95,6 @@
|
|||
"label": "embeddable",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "embeddableEnhanced",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddableEnhancedPluginApi",
|
||||
"section": "def-public.EnhancedEmbeddable",
|
||||
"text": "EnhancedEmbeddable"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
@ -126,7 +118,15 @@
|
|||
"section": "def-public.EmbeddableOutput",
|
||||
"text": "EmbeddableOutput"
|
||||
},
|
||||
">>"
|
||||
"> & { enhancements: { dynamicActions: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-public.DynamicActionManager",
|
||||
"text": "DynamicActionManager"
|
||||
},
|
||||
"; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
|
||||
|
|
@ -268,13 +268,7 @@
|
|||
"label": "drilldownGrouping",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.PresentableGrouping",
|
||||
"text": "PresentableGrouping"
|
||||
},
|
||||
"PresentableGroup",
|
||||
"<{ embeddable?: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
|
|
@ -299,7 +293,7 @@
|
|||
"section": "def-public.EmbeddableOutput",
|
||||
"text": "EmbeddableOutput"
|
||||
},
|
||||
"> | undefined; }>"
|
||||
"> | undefined; }>[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts",
|
||||
|
|
@ -316,7 +310,15 @@
|
|||
"label": "EnhancedEmbeddable",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"E & { enhancements: { dynamicActions: DynamicActionManager;}; }"
|
||||
"E & { enhancements: { dynamicActions: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-public.DynamicActionManager",
|
||||
"text": "DynamicActionManager"
|
||||
},
|
||||
"; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
|
||||
|
|
|
|||
|
|
@ -181,7 +181,59 @@
|
|||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"lineNumber": 43
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -305,7 +357,32 @@
|
|||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"lineNumber": 36
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.typeRegistration",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "typeRegistration",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "encryptedSavedObjects",
|
||||
"scope": "server",
|
||||
"docId": "kibEncryptedSavedObjectsPluginApi",
|
||||
"section": "def-server.EncryptedSavedObjectTypeRegistration",
|
||||
"text": "EncryptedSavedObjectTypeRegistration"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"lineNumber": 36
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
|
|
@ -315,13 +392,166 @@
|
|||
"label": "createMigration",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"CreateEncryptedSavedObjectsMigrationFn"
|
||||
"<InputAttributes = unknown, MigratedAttributes = InputAttributes>(isMigrationNeededPredicate: IsMigrationNeededPredicate<InputAttributes, MigratedAttributes>, migration: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectMigrationFn",
|
||||
"text": "SavedObjectMigrationFn"
|
||||
},
|
||||
"<InputAttributes, MigratedAttributes>, inputType?: ",
|
||||
{
|
||||
"pluginId": "encryptedSavedObjects",
|
||||
"scope": "server",
|
||||
"docId": "kibEncryptedSavedObjectsPluginApi",
|
||||
"section": "def-server.EncryptedSavedObjectTypeRegistration",
|
||||
"text": "EncryptedSavedObjectTypeRegistration"
|
||||
},
|
||||
" | undefined, migratedType?: ",
|
||||
{
|
||||
"pluginId": "encryptedSavedObjects",
|
||||
"scope": "server",
|
||||
"docId": "kibEncryptedSavedObjectsPluginApi",
|
||||
"section": "def-server.EncryptedSavedObjectTypeRegistration",
|
||||
"text": "EncryptedSavedObjectTypeRegistration"
|
||||
},
|
||||
" | undefined) => SavedObjectOptionalMigrationFn<InputAttributes, MigratedAttributes>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.isMigrationNeededPredicate",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isMigrationNeededPredicate",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(encryptedDoc: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<InputAttributes> | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<MigratedAttributes>) => encryptedDoc is ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<InputAttributes>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.migration",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "migration",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(doc: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<InputAttributes>, context: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectMigrationContext",
|
||||
"text": "SavedObjectMigrationContext"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<MigratedAttributes>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.inputType",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "inputType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "encryptedSavedObjects",
|
||||
"scope": "server",
|
||||
"docId": "kibEncryptedSavedObjectsPluginApi",
|
||||
"section": "def-server.EncryptedSavedObjectTypeRegistration",
|
||||
"text": "EncryptedSavedObjectTypeRegistration"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.migratedType",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "migratedType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "encryptedSavedObjects",
|
||||
"scope": "server",
|
||||
"docId": "kibEncryptedSavedObjectsPluginApi",
|
||||
"section": "def-server.EncryptedSavedObjectTypeRegistration",
|
||||
"text": "EncryptedSavedObjectTypeRegistration"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -354,7 +584,26 @@
|
|||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.error",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "error",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Error"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
|
|
@ -364,13 +613,42 @@
|
|||
"label": "getClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ClientInstanciator"
|
||||
"(options?: ",
|
||||
"EncryptedSavedObjectsClientOptions",
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "encryptedSavedObjects",
|
||||
"scope": "server",
|
||||
"docId": "kibEncryptedSavedObjectsPluginApi",
|
||||
"section": "def-server.EncryptedSavedObjectsClient",
|
||||
"text": "EncryptedSavedObjectsClient"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"EncryptedSavedObjectsClientOptions",
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
|||
|
|
@ -49,7 +49,8 @@
|
|||
"<boolean>; accessCheckTimeout: ",
|
||||
"Type",
|
||||
"<number>; accessCheckTimeoutWarning: ",
|
||||
"Type"
|
||||
"Type",
|
||||
"<number>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/enterprise_search/server/index.ts",
|
||||
|
|
|
|||
|
|
@ -35,15 +35,8 @@
|
|||
"label": "getDerivedStateFromProps",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
{
|
||||
"pluginId": "esUiShared",
|
||||
"scope": "public",
|
||||
"docId": "kibEsUiSharedPluginApi",
|
||||
"section": "def-public.CronEditor",
|
||||
"text": "CronEditor"
|
||||
},
|
||||
".getDerivedStateFromProps"
|
||||
"(props: Props) => ",
|
||||
"FieldToValueMap"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx",
|
||||
|
|
@ -357,13 +350,32 @@
|
|||
"label": "JsonEditor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof JsonEditorComp"
|
||||
"<T extends object = { [key: string]: any; }>({ label, helpText, onUpdate, value, defaultValue, euiCodeEditorProps, error: propsError, }: Props<T>) => JSX.Element"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx",
|
||||
"lineNumber": 102
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-public.__0",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Props<T>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -1271,7 +1283,9 @@
|
|||
"path": "src/plugins/es_ui_shared/public/request/use_request.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1377,14 +1391,32 @@
|
|||
"label": "indexNameBeginsWithPeriod",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"indexNameBeginsWithPeriod"
|
||||
"(indexName?: string | undefined) => boolean"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/indices/index.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-public.indexName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "indexName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/indices/validate/validate_index.ts",
|
||||
"lineNumber": 12
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
|
|
@ -1394,14 +1426,29 @@
|
|||
"label": "findIllegalCharactersInIndexName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"findIllegalCharactersInIndexName"
|
||||
"(indexName: string) => string[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/indices/index.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-public.indexName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "indexName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/indices/validate/validate_index.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
|
|
@ -1411,14 +1458,29 @@
|
|||
"label": "indexNameContainsSpaces",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"indexNameContainsSpaces"
|
||||
"(indexName: string) => boolean"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/indices/index.ts",
|
||||
"lineNumber": 21
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-public.indexName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "indexName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/public/indices/validate/validate_index.ts",
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -687,7 +687,7 @@
|
|||
"label": "logEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(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"
|
||||
"(properties: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
@ -703,7 +703,7 @@
|
|||
"label": "properties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"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"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
@ -723,7 +723,7 @@
|
|||
"label": "startTiming",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(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"
|
||||
"(event: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
@ -739,7 +739,7 @@
|
|||
"label": "event",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"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"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
@ -759,7 +759,7 @@
|
|||
"label": "stopTiming",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(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"
|
||||
"(event: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
@ -775,7 +775,7 @@
|
|||
"label": "event",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"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"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
@ -850,7 +850,7 @@
|
|||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | 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)[]"
|
||||
"(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
||||
|
|
@ -872,7 +872,7 @@
|
|||
"label": "IEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"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; } & {}>>>"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
|
|
@ -889,7 +889,7 @@
|
|||
"label": "IValidatedEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | 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; } & {}>"
|
||||
"Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
|
|
@ -1171,7 +1171,7 @@
|
|||
"label": "getLogger",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(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) => ",
|
||||
"(properties: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
|
||||
{
|
||||
"pluginId": "eventLog",
|
||||
"scope": "server",
|
||||
|
|
@ -1194,7 +1194,7 @@
|
|||
"label": "properties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"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"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; url?: string | undefined; end?: string | undefined; category?: string[] | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ description?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -70,7 +70,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; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
|
||||
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/kibana_feature.ts",
|
||||
|
|
@ -132,7 +132,7 @@
|
|||
"label": "category",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>"
|
||||
"{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/kibana_feature.ts",
|
||||
|
|
@ -886,7 +886,7 @@
|
|||
"\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically."
|
||||
],
|
||||
"signature": [
|
||||
"\"read\" | \"all\" | \"none\""
|
||||
"\"none\" | \"all\" | \"read\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/sub_feature.ts",
|
||||
|
|
@ -1198,7 +1198,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; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
|
||||
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/kibana_feature.ts",
|
||||
|
|
@ -1260,7 +1260,7 @@
|
|||
"label": "category",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>"
|
||||
"{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/kibana_feature.ts",
|
||||
|
|
@ -2304,13 +2304,72 @@
|
|||
"\nUtility for iterating through all privileges belonging to a specific feature.\n{@see FeaturePrivilegeIterator }"
|
||||
],
|
||||
"signature": [
|
||||
"FeaturePrivilegeIterator"
|
||||
"(feature: ",
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.KibanaFeature",
|
||||
"text": "KibanaFeature"
|
||||
},
|
||||
", options: ",
|
||||
"FeaturePrivilegeIteratorOptions",
|
||||
") => IterableIterator<{ privilegeId: string; privilege: ",
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.FeatureKibanaPrivileges",
|
||||
"text": "FeatureKibanaPrivileges"
|
||||
},
|
||||
"; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/plugin.ts",
|
||||
"lineNumber": 70
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "features",
|
||||
"id": "def-server.feature",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "feature",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.KibanaFeature",
|
||||
"text": "KibanaFeature"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/feature_privilege_iterator/feature_privilege_iterator.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "features",
|
||||
"id": "def-server.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"FeaturePrivilegeIteratorOptions"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/feature_privilege_iterator/feature_privilege_iterator.ts",
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "features",
|
||||
|
|
@ -2322,13 +2381,70 @@
|
|||
"\nUtility for iterating through all sub-feature privileges belonging to a specific feature.\n{@see SubFeaturePrivilegeIterator }"
|
||||
],
|
||||
"signature": [
|
||||
"SubFeaturePrivilegeIterator"
|
||||
"(feature: ",
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.KibanaFeature",
|
||||
"text": "KibanaFeature"
|
||||
},
|
||||
", licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => IterableIterator<",
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.SubFeaturePrivilegeConfig",
|
||||
"text": "SubFeaturePrivilegeConfig"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/plugin.ts",
|
||||
"lineNumber": 76
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "features",
|
||||
"id": "def-server.feature",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "feature",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.KibanaFeature",
|
||||
"text": "KibanaFeature"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts",
|
||||
"lineNumber": 18
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "features",
|
||||
"id": "def-server.licenseType",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "licenseType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2417,7 +2533,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/server/feature_schema.ts",
|
||||
"lineNumber": 23
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2658,7 +2774,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; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
|
||||
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/kibana_feature.ts",
|
||||
|
|
@ -2720,7 +2836,7 @@
|
|||
"label": "category",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>"
|
||||
"{ readonly id: string; readonly label: string; readonly ariaLabel?: string | undefined; readonly order?: number | undefined; readonly euiIconType?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/kibana_feature.ts",
|
||||
|
|
@ -2926,7 +3042,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; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>"
|
||||
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/sub_feature.ts",
|
||||
|
|
@ -2967,7 +3083,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; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]"
|
||||
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/sub_feature.ts",
|
||||
|
|
@ -2991,7 +3107,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; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }"
|
||||
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/sub_feature.ts",
|
||||
|
|
@ -3805,7 +3921,7 @@
|
|||
"\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically."
|
||||
],
|
||||
"signature": [
|
||||
"\"read\" | \"all\" | \"none\""
|
||||
"\"none\" | \"all\" | \"read\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/sub_feature.ts",
|
||||
|
|
@ -3859,13 +3975,7 @@
|
|||
"\nThe type of privilege group.\n- `mutually_exclusive`::\n Users will be able to select at most one privilege within this group.\n Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All)\n- `independent`::\n Users will be able to select any combination of privileges within this group."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "features",
|
||||
"scope": "common",
|
||||
"docId": "kibFeaturesPluginApi",
|
||||
"section": "def-common.SubFeaturePrivilegeGroupType",
|
||||
"text": "SubFeaturePrivilegeGroupType"
|
||||
}
|
||||
"\"mutually_exclusive\" | \"independent\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/features/common/sub_feature.ts",
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
"label": "FileDataVisualizerPluginStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }"
|
||||
"{ getFileDataVisualizerComponent: () => Promise<React.FC<{}>>; getMaxBytesFormatted: () => string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_data_visualizer/public/plugin.ts",
|
||||
|
|
@ -230,7 +230,7 @@
|
|||
"label": "JobFieldType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\""
|
||||
"\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
|
||||
|
|
|
|||
|
|
@ -125,7 +125,52 @@
|
|||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.geojsonFile",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "geojsonFile",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"GeoJSON.FeatureCollection<GeoJSON.Geometry, GeoJSON.GeoJsonProperties>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.previewCoverage",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "previewCoverage",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -141,7 +186,9 @@
|
|||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 26
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -157,7 +204,9 @@
|
|||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -173,7 +222,9 @@
|
|||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -197,7 +248,32 @@
|
|||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.results",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "results",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "fileUpload",
|
||||
"scope": "public",
|
||||
"docId": "kibFileUploadPluginApi",
|
||||
"section": "def-public.FileUploadGeoResults",
|
||||
"text": "FileUploadGeoResults"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -213,7 +289,9 @@
|
|||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -880,7 +958,39 @@
|
|||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.error",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "error",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -896,7 +1006,9 @@
|
|||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"lineNumber": 18
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
|
@ -912,7 +1024,9 @@
|
|||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1241,7 +1355,208 @@
|
|||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
}
|
||||
},
|
||||
".OBJECT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".DATE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".DATE_NANOS | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".DATE_RANGE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".GEO_POINT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".GEO_SHAPE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".FLOAT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".HALF_FLOAT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".SCALED_FLOAT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".DOUBLE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".INTEGER | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".LONG | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".SHORT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".UNSIGNED_LONG | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".FLOAT_RANGE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".DOUBLE_RANGE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".INTEGER_RANGE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".LONG_RANGE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".NESTED | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".BYTE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".IP | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".IP_RANGE | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".ATTACHMENT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".TOKEN_COUNT | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".MURMUR3 | ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.ES_FIELD_TYPES",
|
||||
"text": "ES_FIELD_TYPES"
|
||||
},
|
||||
".HISTOGRAM; format?: string | undefined; }; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
|
|
@ -1524,12 +1839,13 @@
|
|||
"label": "doc",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | object | ",
|
||||
{
|
||||
"pluginId": "fileUpload",
|
||||
"scope": "common",
|
||||
"docId": "kibFileUploadPluginApi",
|
||||
"section": "def-common.ImportDoc",
|
||||
"text": "ImportDoc"
|
||||
"section": "def-common.Doc",
|
||||
"text": "Doc"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
|
|
@ -1983,7 +2299,14 @@
|
|||
"label": "FormattedOverrides",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }"
|
||||
{
|
||||
"pluginId": "fileUpload",
|
||||
"scope": "common",
|
||||
"docId": "kibFileUploadPluginApi",
|
||||
"section": "def-common.InputOverrides",
|
||||
"text": "InputOverrides"
|
||||
},
|
||||
" & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/file_upload/common/types.ts",
|
||||
|
|
|
|||
3051
api_docs/fleet.json
3051
api_docs/fleet.json
File diff suppressed because it is too large
Load diff
|
|
@ -323,7 +323,7 @@
|
|||
"\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n"
|
||||
],
|
||||
"signature": [
|
||||
"GlobalSearchProviderResultUrl"
|
||||
"string | { path: string; prependBasePath: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/common/types.ts",
|
||||
|
|
@ -478,7 +478,9 @@
|
|||
"path": "x-pack/plugins/global_search/public/types.ts",
|
||||
"lineNumber": 53
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -532,7 +534,9 @@
|
|||
"\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<GlobalSearchProviderResult, \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
|
||||
"Pick<",
|
||||
"GlobalSearchProviderResult",
|
||||
", \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/common/types.ts",
|
||||
|
|
@ -551,7 +555,15 @@
|
|||
"label": "GlobalSearchPluginSetup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }"
|
||||
"{ registerResultProvider: (provider: ",
|
||||
{
|
||||
"pluginId": "globalSearch",
|
||||
"scope": "public",
|
||||
"docId": "kibGlobalSearchPluginApi",
|
||||
"section": "def-public.GlobalSearchResultProvider",
|
||||
"text": "GlobalSearchResultProvider"
|
||||
},
|
||||
") => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/public/types.ts",
|
||||
|
|
@ -579,7 +591,9 @@
|
|||
"section": "def-public.GlobalSearchFindOptions",
|
||||
"text": "GlobalSearchFindOptions"
|
||||
},
|
||||
") => Observable<",
|
||||
") => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"GlobalSearchBatchedResults",
|
||||
">; getSearchableTypes: () => Promise<string[]>; }"
|
||||
],
|
||||
|
|
@ -719,7 +733,7 @@
|
|||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; typeRegistry: Pick<",
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; typeRegistry: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
|
|
@ -744,7 +758,10 @@
|
|||
"text": "IUiSettingsClient"
|
||||
},
|
||||
"; }; capabilities: ",
|
||||
"Observable"
|
||||
"Observable",
|
||||
"<",
|
||||
"Capabilities",
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
|
|
@ -910,7 +927,7 @@
|
|||
"\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n"
|
||||
],
|
||||
"signature": [
|
||||
"GlobalSearchProviderResultUrl"
|
||||
"string | { path: string; prependBasePath: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/common/types.ts",
|
||||
|
|
@ -1011,7 +1028,8 @@
|
|||
") => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"GlobalSearchProviderResult"
|
||||
"GlobalSearchProviderResult",
|
||||
"[]>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
|
|
@ -1103,7 +1121,32 @@
|
|||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
"lineNumber": 140
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "globalSearch",
|
||||
"id": "def-server.context",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "globalSearch",
|
||||
"scope": "server",
|
||||
"docId": "kibGlobalSearchPluginApi",
|
||||
"section": "def-server.GlobalSearchProviderContext",
|
||||
"text": "GlobalSearchProviderContext"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
"lineNumber": 140
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1214,7 +1257,9 @@
|
|||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
"lineNumber": 57
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1251,7 +1296,9 @@
|
|||
"\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<GlobalSearchProviderResult, \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
|
||||
"Pick<",
|
||||
"GlobalSearchProviderResult",
|
||||
", \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/common/types.ts",
|
||||
|
|
@ -1270,19 +1317,33 @@
|
|||
"label": "GlobalSearchPluginStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ",
|
||||
"{ find: (params: ",
|
||||
"GlobalSearchFindParams",
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "globalSearch",
|
||||
"scope": "server",
|
||||
"docId": "kibGlobalSearchPluginApi",
|
||||
"section": "def-server.GlobalSearchFindOptions",
|
||||
"text": "GlobalSearchFindOptions"
|
||||
},
|
||||
", request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => Observable<GlobalSearchBatchedResults>; getSearchableTypes: (request: ",
|
||||
"<unknown, unknown, unknown, any>) => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"GlobalSearchBatchedResults",
|
||||
">; getSearchableTypes: (request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
|
|
@ -1304,7 +1365,15 @@
|
|||
"label": "GlobalSearchPluginSetup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }"
|
||||
"{ registerResultProvider: (provider: ",
|
||||
{
|
||||
"pluginId": "globalSearch",
|
||||
"scope": "server",
|
||||
"docId": "kibGlobalSearchPluginApi",
|
||||
"section": "def-server.GlobalSearchResultProvider",
|
||||
"text": "GlobalSearchResultProvider"
|
||||
},
|
||||
") => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
|
|
|
|||
|
|
@ -220,7 +220,7 @@
|
|||
"EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement."
|
||||
],
|
||||
"signature": [
|
||||
"IconType"
|
||||
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
||||
|
|
@ -419,7 +419,7 @@
|
|||
"EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement."
|
||||
],
|
||||
"signature": [
|
||||
"IconType"
|
||||
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
||||
|
|
@ -547,7 +547,7 @@
|
|||
"label": "TutorialDirectoryHeaderLinkComponent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(props: { children?: React.ReactNode; }, context: any) => React.ReactElement<any, any> | null"
|
||||
"React.FunctionComponent<{}>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
||||
|
|
@ -564,7 +564,7 @@
|
|||
"label": "TutorialDirectoryNoticeComponent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(props: { children?: React.ReactNode; }, context: any) => React.ReactElement<any, any> | null"
|
||||
"React.FunctionComponent<{}>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
||||
|
|
@ -581,7 +581,7 @@
|
|||
"label": "TutorialModuleNoticeComponent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement<any, any> | null"
|
||||
"React.FunctionComponent<{ moduleName: string; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
||||
|
|
@ -598,13 +598,7 @@
|
|||
"label": "TutorialSetup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: ",
|
||||
"FC",
|
||||
"<{}>) => void; registerDirectoryHeaderLink: (id: string, component: ",
|
||||
"FC",
|
||||
"<{}>) => void; registerModuleNotice: (id: string, component: ",
|
||||
"FC",
|
||||
"<{ moduleName: string; }>) => void; }"
|
||||
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/public/plugin.ts",
|
||||
|
|
@ -963,7 +957,7 @@
|
|||
"plugin": "cloud",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/cloud/public/plugin.ts",
|
||||
"lineNumber": 67
|
||||
"lineNumber": 66
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -977,7 +971,7 @@
|
|||
"plugin": "apm",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/apm/public/plugin.ts",
|
||||
"lineNumber": 86
|
||||
"lineNumber": 82
|
||||
}
|
||||
}
|
||||
]
|
||||
|
|
@ -1023,73 +1017,7 @@
|
|||
"server": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.ArtifactsSchema",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ArtifactsSchema",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"lineNumber": 59
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.ArtifactsSchema.exportedFields",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "exportedFields",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ documentationUrl: string; } | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"lineNumber": 60
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.ArtifactsSchema.dashboards",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "dashboards",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DashboardSchema",
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"lineNumber": 63
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.ArtifactsSchema.application",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "application",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ path: string; label: string; } | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"lineNumber": 64
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
|
|
@ -1100,13 +1028,30 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"lineNumber": 13
|
||||
"lineNumber": 23
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.ArtifactsSchema",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "ArtifactsSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly application?: Readonly<{} & { label: string; path: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.SampleDataRegistrySetup",
|
||||
|
|
@ -1115,11 +1060,25 @@
|
|||
"label": "SampleDataRegistrySetup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ registerSampleDataset: (specProvider: SampleDatasetProvider) => void; getSampleDatasets: () => SampleDatasetSchema<unknown>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: SavedObject<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: AppLinkSchema[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: SampleDatasetDashboardPanel) => void; }"
|
||||
"{ registerSampleDataset: (specProvider: ",
|
||||
{
|
||||
"pluginId": "home",
|
||||
"scope": "server",
|
||||
"docId": "kibHomePluginApi",
|
||||
"section": "def-server.SampleDatasetProvider",
|
||||
"text": "SampleDatasetProvider"
|
||||
},
|
||||
") => void; getSampleDatasets: () => ",
|
||||
"Writable",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"SavedObject",
|
||||
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
|
||||
"SampleDatasetDashboardPanel",
|
||||
") => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts",
|
||||
"lineNumber": 168
|
||||
"lineNumber": 169
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1133,12 +1092,12 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"SampleDatasetSchema",
|
||||
"<unknown>"
|
||||
"Writable",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
|
||||
"lineNumber": 82
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1153,12 +1112,11 @@
|
|||
"signature": [
|
||||
"(context: ",
|
||||
"TutorialContext",
|
||||
") => ",
|
||||
"TutorialSchema"
|
||||
") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; isBeta?: boolean | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; } & { id: string; name: string; category: \"metrics\" | \"security\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; label: string; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; success?: string | undefined; error?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"lineNumber": 100
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1467,13 +1425,12 @@
|
|||
"text": "SampleDatasetProvider"
|
||||
},
|
||||
") => void; getSampleDatasets: () => ",
|
||||
"SampleDatasetSchema",
|
||||
"<unknown>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"Writable",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"SavedObject",
|
||||
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
|
||||
"AppLinkSchema",
|
||||
"[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
|
||||
"SampleDatasetDashboardPanel"
|
||||
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
|
||||
"SampleDatasetDashboardPanel",
|
||||
") => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/home/server/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -45,9 +45,6 @@ import homeObj from './home.json';
|
|||
### Objects
|
||||
<DocDefinitionList data={homeObj.server.objects}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={homeObj.server.interfaces}/>
|
||||
|
||||
### Enums
|
||||
<DocDefinitionList data={homeObj.server.enums}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -1262,7 +1262,7 @@
|
|||
"label": "health",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ClusterStatus"
|
||||
"\"green\" | \"yellow\" | \"red\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/index_management/common/types/data_streams.ts",
|
||||
|
|
@ -1491,7 +1491,7 @@
|
|||
"label": "status",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"HealthFromEs"
|
||||
"\"GREEN\" | \"YELLOW\" | \"RED\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/index_management/common/types/data_streams.ts",
|
||||
|
|
|
|||
|
|
@ -67,15 +67,13 @@
|
|||
"label": "getDerivedStateFromProps",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
{
|
||||
"pluginId": "indexPatternFieldEditor",
|
||||
"scope": "public",
|
||||
"docId": "kibIndexPatternFieldEditorPluginApi",
|
||||
"section": "def-public.DefaultFormatEditor",
|
||||
"text": "DefaultFormatEditor"
|
||||
},
|
||||
".getDerivedStateFromProps"
|
||||
"(nextProps: ",
|
||||
"FormatEditorProps",
|
||||
"<{}>, state: ",
|
||||
"FormatEditorState",
|
||||
") => { error: string | undefined; samples: ",
|
||||
"Sample",
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
||||
|
|
@ -226,7 +224,7 @@
|
|||
"\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""
|
||||
],
|
||||
"signature": [
|
||||
"InternalFieldType"
|
||||
"\"concrete\" | \"runtime\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
||||
|
|
@ -594,7 +592,42 @@
|
|||
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
|||
|
|
@ -799,7 +799,9 @@
|
|||
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexPatternManagement",
|
||||
|
|
@ -904,19 +906,54 @@
|
|||
"[]>; }; list: { getIndexPatternTags: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-public.IIndexPattern",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SimpleSavedObject",
|
||||
"text": "SimpleSavedObject"
|
||||
}
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
">, isDefault: boolean) => ",
|
||||
"IndexPatternTag",
|
||||
"[]; getFieldInfo: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
", field: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IFieldType",
|
||||
"text": "IFieldType"
|
||||
},
|
||||
") => string[]; areScriptedFieldsEnabled: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
") => boolean; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/index_pattern_management/public/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -109,7 +109,23 @@
|
|||
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-public.val",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "val",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/common/formatters/number.ts",
|
||||
"lineNumber": 8
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
|
|
@ -127,7 +143,23 @@
|
|||
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-public.bytes",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "bytes",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/common/formatters/bytes.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
|
|
@ -145,7 +177,23 @@
|
|||
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
||||
"lineNumber": 21
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-public.bytes",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "bytes",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/common/formatters/bytes.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
|
|
@ -163,7 +211,23 @@
|
|||
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
||||
"lineNumber": 23
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-public.bytes",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "bytes",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/common/formatters/bytes.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
|
|
@ -179,7 +243,23 @@
|
|||
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
||||
"lineNumber": 24
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-public.val",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "val",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/common/formatters/percent.ts",
|
||||
"lineNumber": 9
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
|
|
@ -195,7 +275,23 @@
|
|||
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-public.val",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "val",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/common/formatters/high_precision.ts",
|
||||
"lineNumber": 8
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -233,7 +329,9 @@
|
|||
"label": "InfraRequestHandlerContext",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext"
|
||||
"InfraMlRequestHandlerContext",
|
||||
" & ",
|
||||
"InfraSpacesRequestHandlerContext"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/server/types.ts",
|
||||
|
|
@ -273,7 +371,39 @@
|
|||
"path": "x-pack/plugins/infra/server/plugin.ts",
|
||||
"lineNumber": 76
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-server.sourceId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "sourceId",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/server/plugin.ts",
|
||||
"lineNumber": 77
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-server.sourceProperties",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "sourceProperties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"InfraStaticSourceConfiguration"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/infra/server/plugin.ts",
|
||||
"lineNumber": 78
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
|
|
@ -217,7 +217,8 @@
|
|||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.OverlayRef",
|
||||
"text": "OverlayRef"
|
||||
}
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
|
|
@ -291,8 +292,7 @@
|
|||
"section": "def-common.RequestAdapter",
|
||||
"text": "RequestAdapter"
|
||||
},
|
||||
" extends ",
|
||||
"EventEmitter"
|
||||
" extends EventEmitter"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/common/adapters/request/request_adapter.ts",
|
||||
|
|
@ -919,7 +919,23 @@
|
|||
"label": "component",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ComponentType<",
|
||||
"React.ComponentClass<",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "public",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-public.InspectorViewProps",
|
||||
"text": "InspectorViewProps"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
},
|
||||
">, any> | React.FunctionComponent<",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "public",
|
||||
|
|
@ -1215,7 +1231,13 @@
|
|||
"label": "InspectorSession",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"OverlayRef"
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.OverlayRef",
|
||||
"text": "OverlayRef"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/public/types.ts",
|
||||
|
|
@ -1261,7 +1283,32 @@
|
|||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"lineNumber": 21
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.view",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "view",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "public",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-public.InspectorViewDescription",
|
||||
"text": "InspectorViewDescription"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/public/view_registry.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
|
|
@ -1322,7 +1369,37 @@
|
|||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"True, if a call to `open` with the same adapters\nwould have shown the inspector panel, false otherwise."
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.adapters",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "adapters",
|
||||
"description": [
|
||||
"- An object of adapters. This should be the same\nyou would pass into `open`."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
|
|
@ -1366,7 +1443,61 @@
|
|||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"The session instance for the opened inspector."
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.adapters",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "adapters",
|
||||
"description": [
|
||||
"- An object of adapters for which you want to show\nthe inspector panel."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [
|
||||
"- Options that configure the inspector. See InspectorOptions type."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "public",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-public.InspectorOptions",
|
||||
"text": "InspectorOptions"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
@ -1402,8 +1533,7 @@
|
|||
"section": "def-common.RequestAdapter",
|
||||
"text": "RequestAdapter"
|
||||
},
|
||||
" extends ",
|
||||
"EventEmitter"
|
||||
" extends EventEmitter"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/inspector/common/adapters/request/request_adapter.ts",
|
||||
|
|
|
|||
|
|
@ -982,6 +982,25 @@
|
|||
"lineNumber": 14
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
"id": "def-public.options",
|
||||
"type": "Unknown",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"unknown"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -1184,6 +1203,8 @@
|
|||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -1821,7 +1842,7 @@
|
|||
"label": "AngularHttpError",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"IHttpResponse<{ message: string; }>"
|
||||
"angular.IHttpResponse<{ message: string; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
|
||||
|
|
@ -1838,7 +1859,7 @@
|
|||
"label": "createTopNavDirective",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"angular.Injectable<angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>>"
|
||||
"angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController> | (string | angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>)[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
|
||||
|
|
@ -1855,7 +1876,7 @@
|
|||
"label": "IPrivate",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(provider: (...injectable: any[]) => T) => T"
|
||||
"<T>(provider: (...injectable: any[]) => T) => T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
|
||||
|
|
@ -1872,7 +1893,7 @@
|
|||
"label": "KbnAccessibleClickProvider",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"angular.Injectable<angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>>"
|
||||
"angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController> | (string | angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>)[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load diff
|
|
@ -87,7 +87,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx",
|
||||
"lineNumber": 40
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx",
|
||||
"lineNumber": 43
|
||||
"lineNumber": 48
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -320,7 +320,7 @@
|
|||
"label": "operationType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | undefined"
|
||||
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"math\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | \"formula\" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
|
||||
|
|
@ -368,9 +368,9 @@
|
|||
"label": "layers",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, Pick<",
|
||||
"{ [x: string]: Pick<",
|
||||
"IndexPatternLayer",
|
||||
", \"columns\" | \"columnOrder\" | \"incompleteColumns\">>"
|
||||
", \"columns\" | \"columnOrder\" | \"incompleteColumns\">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
|
||||
|
|
@ -407,7 +407,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
|
||||
"lineNumber": 75
|
||||
"lineNumber": 80
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -423,7 +423,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
|
||||
"lineNumber": 76
|
||||
"lineNumber": 81
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -439,7 +439,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
|
||||
"lineNumber": 77
|
||||
"lineNumber": 82
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -484,8 +484,7 @@
|
|||
"\nPosition of the legend relative to the chart"
|
||||
],
|
||||
"signature": [
|
||||
"node_modules/utility-types/dist/utility-types",
|
||||
"$Values<Readonly<{ Top: \"top\"; Bottom: \"bottom\"; Left: \"left\"; Right: \"right\"; }>>"
|
||||
"\"top\" | \"bottom\" | \"left\" | \"right\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
|
|
@ -539,7 +538,15 @@
|
|||
"\nReact component which can be used to embed a Lens visualization into another application.\nSee `x-pack/examples/embedded_lens_example` for exemplary usage.\n\nThis API might undergo breaking changes even in minor versions.\n"
|
||||
],
|
||||
"signature": [
|
||||
"React.ComponentType<",
|
||||
"React.ComponentClass<",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.EmbeddableComponentProps",
|
||||
"text": "EmbeddableComponentProps"
|
||||
},
|
||||
", any> | React.FunctionComponent<",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
|
|
@ -575,7 +582,44 @@
|
|||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"lineNumber": 101
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.input",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "input",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"LensByValueInput",
|
||||
" | ",
|
||||
"LensByReferenceInput"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"lineNumber": 101
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.openInNewTab",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "openInNewTab",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"lineNumber": 101
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
|
|
@ -593,7 +637,9 @@
|
|||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"lineNumber": 105
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
|
|
@ -613,7 +659,9 @@
|
|||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"lineNumber": 110
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -672,7 +720,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/types.ts",
|
||||
"lineNumber": 358
|
||||
"lineNumber": 363
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -684,17 +732,11 @@
|
|||
"label": "dataType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.DataType",
|
||||
"text": "DataType"
|
||||
}
|
||||
"\"string\" | \"number\" | \"boolean\" | \"date\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"histogram\" | \"document\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/types.ts",
|
||||
"lineNumber": 360
|
||||
"lineNumber": 365
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -707,7 +749,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/types.ts",
|
||||
"lineNumber": 363
|
||||
"lineNumber": 368
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -725,7 +767,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/types.ts",
|
||||
"lineNumber": 369
|
||||
"lineNumber": 374
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -758,7 +800,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
|
||||
"lineNumber": 23
|
||||
"lineNumber": 24
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -774,7 +816,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
|
||||
"lineNumber": 24
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -790,7 +832,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
|
||||
"lineNumber": 25
|
||||
"lineNumber": 26
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -1162,7 +1204,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 376
|
||||
"lineNumber": 424
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1178,7 +1220,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 377
|
||||
"lineNumber": 425
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1191,7 +1233,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 378
|
||||
"lineNumber": 426
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1207,7 +1249,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 379
|
||||
"lineNumber": 427
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1223,7 +1265,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 380
|
||||
"lineNumber": 428
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1240,7 +1282,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 381
|
||||
"lineNumber": 429
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1252,17 +1294,11 @@
|
|||
"label": "seriesType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.SeriesType",
|
||||
"text": "SeriesType"
|
||||
}
|
||||
"\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 382
|
||||
"lineNumber": 430
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1278,7 +1314,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 383
|
||||
"lineNumber": 431
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1301,7 +1337,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 384
|
||||
"lineNumber": 432
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -1317,7 +1353,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 423
|
||||
"lineNumber": 473
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1329,17 +1365,11 @@
|
|||
"label": "preferredSeriesType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.SeriesType",
|
||||
"text": "SeriesType"
|
||||
}
|
||||
"\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 424
|
||||
"lineNumber": 474
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1361,7 +1391,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 425
|
||||
"lineNumber": 475
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1377,7 +1407,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 426
|
||||
"lineNumber": 476
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1393,7 +1423,41 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 427
|
||||
"lineNumber": 477
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.XYState.yLeftExtent",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "yLeftExtent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"AxisExtentConfig",
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 478
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.XYState.yRightExtent",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "yRightExtent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"AxisExtentConfig",
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 479
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1416,7 +1480,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 428
|
||||
"lineNumber": 480
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1432,7 +1496,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 429
|
||||
"lineNumber": 481
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1448,7 +1512,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 430
|
||||
"lineNumber": 482
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1464,7 +1528,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 431
|
||||
"lineNumber": 483
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1487,7 +1551,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 432
|
||||
"lineNumber": 484
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1510,7 +1574,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 433
|
||||
"lineNumber": 485
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1533,7 +1597,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 434
|
||||
"lineNumber": 486
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1549,7 +1613,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 435
|
||||
"lineNumber": 487
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1565,7 +1629,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 436
|
||||
"lineNumber": 488
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -1583,11 +1647,20 @@
|
|||
"label": "AvgIndexPatternColumn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"average\"; }"
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.FieldBasedIndexPatternColumn",
|
||||
"text": "FieldBasedIndexPatternColumn"
|
||||
},
|
||||
" & { operationType: \"average\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
|
||||
"lineNumber": 126
|
||||
"lineNumber": 132
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1601,7 +1674,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'counter_rate'; }"
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
"ReferenceBasedIndexPatternColumn",
|
||||
" & { operationType: \"counter_rate\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx",
|
||||
|
|
@ -1619,7 +1694,15 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: 'count'; }"
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.FieldBasedIndexPatternColumn",
|
||||
"text": "FieldBasedIndexPatternColumn"
|
||||
},
|
||||
" & { operationType: \"count\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx",
|
||||
|
|
@ -1637,7 +1720,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'cumulative_sum'; }"
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
"ReferenceBasedIndexPatternColumn",
|
||||
" & { operationType: \"cumulative_sum\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx",
|
||||
|
|
@ -1654,11 +1739,11 @@
|
|||
"label": "DataType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"string\" | \"number\" | \"boolean\" | \"date\" | \"ip\" | \"histogram\" | \"document\""
|
||||
"\"string\" | \"number\" | \"boolean\" | \"date\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"histogram\" | \"document\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/types.ts",
|
||||
"lineNumber": 347
|
||||
"lineNumber": 352
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1672,7 +1757,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: typeof OPERATION_NAME; }"
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
"ReferenceBasedIndexPatternColumn",
|
||||
" & { operationType: \"differences\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx",
|
||||
|
|
@ -1752,11 +1839,27 @@
|
|||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.PercentileIndexPatternColumn",
|
||||
"text": "PercentileIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.CountIndexPatternColumn",
|
||||
"text": "CountIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.LastValueIndexPatternColumn",
|
||||
"text": "LastValueIndexPatternColumn"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
|
||||
"lineNumber": 71
|
||||
"lineNumber": 79
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1809,11 +1912,71 @@
|
|||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.CardinalityIndexPatternColumn",
|
||||
"text": "CardinalityIndexPatternColumn"
|
||||
}
|
||||
},
|
||||
" | MetricColumn<\"sum\"> | MetricColumn<\"median\"> | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.PercentileIndexPatternColumn",
|
||||
"text": "PercentileIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.CountIndexPatternColumn",
|
||||
"text": "CountIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.LastValueIndexPatternColumn",
|
||||
"text": "LastValueIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.CumulativeSumIndexPatternColumn",
|
||||
"text": "CumulativeSumIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.CounterRateIndexPatternColumn",
|
||||
"text": "CounterRateIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.DerivativeIndexPatternColumn",
|
||||
"text": "DerivativeIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.MovingAverageIndexPatternColumn",
|
||||
"text": "MovingAverageIndexPatternColumn"
|
||||
},
|
||||
" | ",
|
||||
"MathIndexPatternColumn",
|
||||
" | ",
|
||||
"FormulaIndexPatternColumn"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
|
||||
"lineNumber": 52
|
||||
"lineNumber": 58
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1826,11 +1989,20 @@
|
|||
"label": "MaxIndexPatternColumn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"max\"; }"
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.FieldBasedIndexPatternColumn",
|
||||
"text": "FieldBasedIndexPatternColumn"
|
||||
},
|
||||
" & { operationType: \"max\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
|
||||
"lineNumber": 128
|
||||
"lineNumber": 134
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1843,11 +2015,20 @@
|
|||
"label": "MedianIndexPatternColumn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"median\"; }"
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.FieldBasedIndexPatternColumn",
|
||||
"text": "FieldBasedIndexPatternColumn"
|
||||
},
|
||||
" & { operationType: \"median\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
|
||||
"lineNumber": 129
|
||||
"lineNumber": 135
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1860,11 +2041,20 @@
|
|||
"label": "MinIndexPatternColumn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"min\"; }"
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.FieldBasedIndexPatternColumn",
|
||||
"text": "FieldBasedIndexPatternColumn"
|
||||
},
|
||||
" & { operationType: \"min\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
|
||||
"lineNumber": 127
|
||||
"lineNumber": 133
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1878,11 +2068,13 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'moving_average'; params: { window: number;}; }"
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
"ReferenceBasedIndexPatternColumn",
|
||||
" & { operationType: \"moving_average\"; params: { window: number; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx",
|
||||
"lineNumber": 40
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1897,11 +2089,11 @@
|
|||
"\nA union type of all available operation types. The operation type is a unique id of an operation.\nEach column is assigned to exactly one operation type."
|
||||
],
|
||||
"signature": [
|
||||
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\""
|
||||
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"math\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | \"formula\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
|
||||
"lineNumber": 399
|
||||
"lineNumber": 497
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1914,7 +2106,23 @@
|
|||
"label": "PersistedIndexPatternLayer",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ columns: Record<string, IndexPatternColumn>; columnOrder: string[]; incompleteColumns?: Record<string, IncompleteColumn> | undefined; }"
|
||||
"{ columns: Record<string, ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.IndexPatternColumn",
|
||||
"text": "IndexPatternColumn"
|
||||
},
|
||||
">; columnOrder: string[]; incompleteColumns?: Record<string, ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.IncompleteColumn",
|
||||
"text": "IncompleteColumn"
|
||||
},
|
||||
"> | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
|
||||
|
|
@ -1931,7 +2139,14 @@
|
|||
"label": "PieLayerState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SharedPieLayerState & { layerId: string; }"
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.SharedPieLayerState",
|
||||
"text": "SharedPieLayerState"
|
||||
},
|
||||
" & { layerId: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
|
||||
|
|
@ -1952,7 +2167,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 354
|
||||
"lineNumber": 402
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1965,11 +2180,20 @@
|
|||
"label": "SumIndexPatternColumn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"sum\"; }"
|
||||
"BaseIndexPatternColumn",
|
||||
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.FieldBasedIndexPatternColumn",
|
||||
"text": "FieldBasedIndexPatternColumn"
|
||||
},
|
||||
" & { operationType: \"sum\"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
|
||||
"lineNumber": 125
|
||||
"lineNumber": 131
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1984,7 +2208,41 @@
|
|||
"\nType-safe variant of by value embeddable input for Lens.\nThis can be used to hardcode certain Lens chart configurations within another app."
|
||||
],
|
||||
"signature": [
|
||||
"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>; }"
|
||||
"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\", ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.XYState",
|
||||
"text": "XYState"
|
||||
},
|
||||
"> | LensAttributes<\"lnsPie\", ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.PieVisualizationState",
|
||||
"text": "PieVisualizationState"
|
||||
},
|
||||
"> | LensAttributes<\"lnsDatatable\", ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.DatatableVisualizationState",
|
||||
"text": "DatatableVisualizationState"
|
||||
},
|
||||
"> | LensAttributes<\"lnsMetric\", ",
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.MetricState",
|
||||
"text": "MetricState"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx",
|
||||
|
|
@ -2005,7 +2263,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 368
|
||||
"lineNumber": 416
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2022,7 +2280,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 420
|
||||
"lineNumber": 470
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2039,7 +2297,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
|
||||
"lineNumber": 366
|
||||
"lineNumber": 414
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -130,7 +130,368 @@
|
|||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<T>) => ",
|
||||
"KibanaResponse"
|
||||
"KibanaResponse",
|
||||
"<T>; badRequest: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }>) => (ctx: Context, request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<Params, Query, Body, any>, response: { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
||||
"Stream",
|
||||
" | undefined>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<T>) => ",
|
||||
"KibanaResponse",
|
||||
"<T>; badRequest: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.IKibanaResponse",
|
||||
"text": "IKibanaResponse"
|
||||
},
|
||||
"<any> | Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.IKibanaResponse",
|
||||
"text": "IKibanaResponse"
|
||||
},
|
||||
"<any>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
||||
|
|
@ -172,7 +533,162 @@
|
|||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
}
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
||||
|
|
|
|||
|
|
@ -172,7 +172,9 @@
|
|||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"lineNumber": 142
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
@ -208,7 +210,9 @@
|
|||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"lineNumber": 152
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
@ -377,7 +381,7 @@
|
|||
"\nThe state of checking the results of a license type meeting the license minimum."
|
||||
],
|
||||
"signature": [
|
||||
"LicenseCheckState"
|
||||
"\"valid\" | \"invalid\" | \"expired\" | \"unavailable\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
|
|
@ -488,7 +492,7 @@
|
|||
"\nThe validity status of the license."
|
||||
],
|
||||
"signature": [
|
||||
"LicenseStatus"
|
||||
"\"active\" | \"invalid\" | \"expired\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
|
|
@ -549,13 +553,6 @@
|
|||
},
|
||||
"deprecated": true,
|
||||
"references": [
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts",
|
||||
"lineNumber": 21
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -570,6 +567,13 @@
|
|||
"lineNumber": 23
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts",
|
||||
"lineNumber": 24
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -605,6 +609,20 @@
|
|||
"lineNumber": 44
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts",
|
||||
"lineNumber": 54
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts",
|
||||
"lineNumber": 55
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -874,7 +892,9 @@
|
|||
"\nProvides information about feature availability for the current license."
|
||||
],
|
||||
"signature": [
|
||||
"{ [x: string]: LicenseFeature; }"
|
||||
"{ [x: string]: ",
|
||||
"LicenseFeature",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
|
|
@ -925,7 +945,7 @@
|
|||
"plugin": "security",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security/public/plugin.tsx",
|
||||
"lineNumber": 89
|
||||
"lineNumber": 82
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -1234,7 +1254,352 @@
|
|||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<T>) => ",
|
||||
"KibanaResponse"
|
||||
"KibanaResponse",
|
||||
"<T>; badRequest: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }>) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RequestHandler",
|
||||
"text": "RequestHandler"
|
||||
},
|
||||
"<P, Q, B, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
||||
"Stream",
|
||||
" | undefined>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<T>) => ",
|
||||
"KibanaResponse",
|
||||
"<T>; badRequest: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
||||
|
|
@ -1299,7 +1664,162 @@
|
|||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
}
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; unauthorized: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; forbidden: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; notFound: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; conflict: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ErrorHttpResponseOptions",
|
||||
"text": "ErrorHttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; customError: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.CustomHttpResponseOptions",
|
||||
"text": "CustomHttpResponseOptions"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">) => ",
|
||||
"KibanaResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.ResponseError",
|
||||
"text": "ResponseError"
|
||||
},
|
||||
">; redirected: (options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.RedirectResponseOptions",
|
||||
"text": "RedirectResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; ok: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; accepted: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<string | Record<string, any> | Buffer | ",
|
||||
"Stream",
|
||||
">; noContent: (options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.HttpResponseOptions",
|
||||
"text": "HttpResponseOptions"
|
||||
},
|
||||
") => ",
|
||||
"KibanaResponse",
|
||||
"<undefined>; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
||||
|
|
@ -1692,7 +2212,9 @@
|
|||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"lineNumber": 142
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
@ -1728,7 +2250,9 @@
|
|||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"lineNumber": 152
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
@ -1897,7 +2421,7 @@
|
|||
"\nThe state of checking the results of a license type meeting the license minimum."
|
||||
],
|
||||
"signature": [
|
||||
"LicenseCheckState"
|
||||
"\"valid\" | \"invalid\" | \"expired\" | \"unavailable\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
|
|
@ -2064,7 +2588,7 @@
|
|||
"\nThe validity status of the license."
|
||||
],
|
||||
"signature": [
|
||||
"LicenseStatus"
|
||||
"\"active\" | \"invalid\" | \"expired\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
|
|
@ -2125,13 +2649,6 @@
|
|||
},
|
||||
"deprecated": true,
|
||||
"references": [
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts",
|
||||
"lineNumber": 21
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -2146,6 +2663,13 @@
|
|||
"lineNumber": 23
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts",
|
||||
"lineNumber": 24
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -2181,6 +2705,20 @@
|
|||
"lineNumber": 44
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts",
|
||||
"lineNumber": 54
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts",
|
||||
"lineNumber": 55
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -2469,7 +3007,9 @@
|
|||
"\nProvides information about feature availability for the current license."
|
||||
],
|
||||
"signature": [
|
||||
"{ [x: string]: LicenseFeature; }"
|
||||
"{ [x: string]: ",
|
||||
"LicenseFeature",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
|
|
@ -2555,7 +3095,7 @@
|
|||
"plugin": "reporting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 226
|
||||
"lineNumber": 228
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -2569,7 +3109,7 @@
|
|||
"plugin": "alerting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"lineNumber": 162
|
||||
"lineNumber": 168
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -2590,7 +3130,7 @@
|
|||
"plugin": "fleet",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
||||
"lineNumber": 211
|
||||
"lineNumber": 213
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -2786,7 +3326,79 @@
|
|||
"lineNumber": 84
|
||||
},
|
||||
"deprecated": true,
|
||||
"references": []
|
||||
"references": [],
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.clusterClient",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "clusterClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ callAsInternalUser: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.LegacyAPICaller",
|
||||
"text": "LegacyAPICaller"
|
||||
},
|
||||
"; asScoped: (request?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any> | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.LegacyRequest",
|
||||
"text": "LegacyRequest"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.FakeRequest",
|
||||
"text": "FakeRequest"
|
||||
},
|
||||
" | undefined) => Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.LegacyScopedClusterClient",
|
||||
"text": "LegacyScopedClusterClient"
|
||||
},
|
||||
", \"callAsCurrentUser\" | \"callAsInternalUser\">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"lineNumber": 85
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.pollingFrequency",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "pollingFrequency",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"lineNumber": 86
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
@ -2902,7 +3514,79 @@
|
|||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"lineNumber": 109
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.clusterClient",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "clusterClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ callAsInternalUser: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.LegacyAPICaller",
|
||||
"text": "LegacyAPICaller"
|
||||
},
|
||||
"; asScoped: (request?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any> | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.LegacyRequest",
|
||||
"text": "LegacyRequest"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.FakeRequest",
|
||||
"text": "FakeRequest"
|
||||
},
|
||||
" | undefined) => Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.LegacyScopedClusterClient",
|
||||
"text": "LegacyScopedClusterClient"
|
||||
},
|
||||
", \"callAsCurrentUser\" | \"callAsInternalUser\">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"lineNumber": 110
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.pollingFrequency",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "pollingFrequency",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"lineNumber": 111
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
|
|||
3797
api_docs/lists.json
3797
api_docs/lists.json
File diff suppressed because one or more lines are too long
|
|
@ -41,15 +41,9 @@ import listsObj from './lists.json';
|
|||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={listsObj.common.objects}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={listsObj.common.functions}/>
|
||||
|
||||
### Enums
|
||||
<DocDefinitionList data={listsObj.common.enums}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={listsObj.common.misc}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -34,13 +34,50 @@
|
|||
"label": "mount",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Mount"
|
||||
"(params: ",
|
||||
{
|
||||
"pluginId": "management",
|
||||
"scope": "public",
|
||||
"docId": "kibManagementPluginApi",
|
||||
"section": "def-public.ManagementAppMountParams",
|
||||
"text": "ManagementAppMountParams"
|
||||
},
|
||||
") => ",
|
||||
"Unmount",
|
||||
" | Promise<",
|
||||
"Unmount",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/management/public/utils/management_app.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "management",
|
||||
"scope": "public",
|
||||
"docId": "kibManagementPluginApi",
|
||||
"section": "def-public.ManagementAppMountParams",
|
||||
"text": "ManagementAppMountParams"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/management/public/types.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
|
|
@ -223,7 +260,7 @@
|
|||
"section": "def-public.RegisterManagementAppArgs",
|
||||
"text": "RegisterManagementAppArgs"
|
||||
},
|
||||
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
|
||||
", \"title\" | \"id\" | \"meta\" | \"order\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
|
||||
{
|
||||
"pluginId": "management",
|
||||
"scope": "public",
|
||||
|
|
@ -254,7 +291,7 @@
|
|||
"section": "def-public.RegisterManagementAppArgs",
|
||||
"text": "RegisterManagementAppArgs"
|
||||
},
|
||||
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">"
|
||||
", \"title\" | \"id\" | \"meta\" | \"order\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/management/public/utils/management_section.ts",
|
||||
|
|
@ -548,7 +585,27 @@
|
|||
"path": "src/plugins/management/public/types.ts",
|
||||
"lineNumber": 61
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
"id": "def-public.crumbs",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "crumbs",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"EuiBreadcrumb",
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/management/public/types.ts",
|
||||
"lineNumber": 61
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
|
|
@ -608,13 +665,50 @@
|
|||
"label": "mount",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Mount"
|
||||
"(params: ",
|
||||
{
|
||||
"pluginId": "management",
|
||||
"scope": "public",
|
||||
"docId": "kibManagementPluginApi",
|
||||
"section": "def-public.ManagementAppMountParams",
|
||||
"text": "ManagementAppMountParams"
|
||||
},
|
||||
") => ",
|
||||
"Unmount",
|
||||
" | Promise<",
|
||||
"Unmount",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/management/public/utils/management_app.ts",
|
||||
"lineNumber": 14
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "management",
|
||||
"scope": "public",
|
||||
"docId": "kibManagementPluginApi",
|
||||
"section": "def-public.ManagementAppMountParams",
|
||||
"text": "ManagementAppMountParams"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/management/public/types.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
|
|
|
|||
|
|
@ -48,7 +48,12 @@
|
|||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ReferenceOrValueEmbeddable",
|
||||
"text": "ReferenceOrValueEmbeddable"
|
||||
}
|
||||
},
|
||||
"<",
|
||||
"MapByValueInput",
|
||||
", ",
|
||||
"MapByReferenceInput",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
||||
|
|
@ -939,62 +944,33 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 31
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.addFilters",
|
||||
"type": "Function",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "addFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filter: object, actionId: string) => void"
|
||||
"((filters: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[], actionId: string) => Promise<void>) | null"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 32
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.addFilters.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "filter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"object"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.addFilters.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "actionId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
|
@ -1008,11 +984,11 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 33
|
||||
"lineNumber": 36
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
|
@ -1027,20 +1003,55 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 34
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.isLocked",
|
||||
"type": "boolean",
|
||||
"id": "def-public.RenderTooltipContentParams.getActionContext",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isLocked",
|
||||
"label": "getActionContext",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(() => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionExecutionContext",
|
||||
"text": "ActionExecutionContext"
|
||||
},
|
||||
"<object>) | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 35
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.getFilterActions",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getFilterActions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(() => Promise<",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<object>[]>) | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 39
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -1052,33 +1063,42 @@
|
|||
"label": "getLayerName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(layerId: string) => Promise<string>"
|
||||
"(layerId: string) => Promise<string | null>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 36
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.getLayerName.$1",
|
||||
"id": "def-public.layerId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "layerId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 36
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.isLocked",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isLocked",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
|
@ -1088,37 +1108,34 @@
|
|||
"label": "loadFeatureProperties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({ layerId, featureId }: ",
|
||||
"LoadFeatureProps",
|
||||
") => Promise<",
|
||||
"({ layerId, featureId, mbProperties, }: { layerId: string; featureId?: string | number | undefined; mbProperties: GeoJSON.GeoJsonProperties; }) => Promise<",
|
||||
"ITooltipProperty",
|
||||
"[]>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 37
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1",
|
||||
"id": "def-public.__0",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{ layerId, featureId }",
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"LoadFeatureProps"
|
||||
"{ layerId: string; featureId?: string | number | undefined; mbProperties: GeoJSON.GeoJsonProperties; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 37
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
|
@ -1128,36 +1145,56 @@
|
|||
"label": "loadFeatureGeometry",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({ layerId, featureId }: ",
|
||||
"LoadFeatureProps",
|
||||
") => ",
|
||||
"FeatureGeometry"
|
||||
"({ layerId, featureId, }: { layerId: string; featureId?: string | number | undefined; }) => GeoJSON.Point | GeoJSON.MultiPoint | GeoJSON.LineString | GeoJSON.MultiLineString | GeoJSON.Polygon | GeoJSON.MultiPolygon | GeoJSON.GeometryCollection | null"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 38
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1",
|
||||
"id": "def-public.__0",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{ layerId, featureId }",
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"LoadFeatureProps"
|
||||
"{ layerId: string; featureId?: string | number | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 38
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "onSingleValueTrigger",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"((actionId: string, key: string, value: ",
|
||||
{
|
||||
"pluginId": "maps",
|
||||
"scope": "common",
|
||||
"docId": "kibMapsPluginApi",
|
||||
"section": "def-common.RawValue",
|
||||
"text": "RawValue"
|
||||
},
|
||||
") => void) | undefined"
|
||||
],
|
||||
"returnComment": []
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"lineNumber": 58
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1273,7 +1310,22 @@
|
|||
"label": "MapEmbeddableOutput",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"EmbeddableOutput & { indexPatterns: IIndexPattern[]; }"
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableOutput",
|
||||
"text": "EmbeddableOutput"
|
||||
},
|
||||
" & { indexPatterns: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/public/embeddable/types.ts",
|
||||
|
|
@ -3206,7 +3258,7 @@
|
|||
"label": "RawValue",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"undefined | null | string | number | false | true | string[]"
|
||||
"string | number | boolean | string[] | null | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/maps/common/constants.ts",
|
||||
|
|
|
|||
|
|
@ -805,7 +805,7 @@
|
|||
"label": "LayerConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly name: string; readonly format: Readonly<{} & { type: string; }>; readonly fields: Readonly<{} & { description: string; name: string; }>[]; readonly meta: Readonly<{} & { feature_collection_path: string; }>; readonly url: string; readonly attribution: string; }"
|
||||
"{ readonly name: string; readonly fields: Readonly<{} & { description: string; name: string; }>[]; readonly meta: Readonly<{} & { feature_collection_path: string; }>; readonly format: Readonly<{} & { type: string; }>; readonly url: string; readonly attribution: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/config.ts",
|
||||
|
|
@ -822,7 +822,7 @@
|
|||
"label": "MapsEmsConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly includeElasticMapsService: boolean; readonly proxyElasticMapsServiceInMaps: boolean; readonly regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly manifestServiceUrl: string; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
|
||||
"{ readonly includeElasticMapsService: boolean; readonly proxyElasticMapsServiceInMaps: boolean; readonly regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; format: Readonly<{} & { type: string; }>; url: string; attribution: string; }>[]; }>; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly manifestServiceUrl: string; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/config.ts",
|
||||
|
|
@ -914,7 +914,7 @@
|
|||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>"
|
||||
"{ readonly includeElasticMapsService: boolean; readonly proxyElasticMapsServiceInMaps: boolean; readonly regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; format: Readonly<{} & { type: string; }>; url: string; attribution: string; }>[]; }>; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly manifestServiceUrl: string; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/public/index.ts",
|
||||
|
|
@ -944,7 +944,9 @@
|
|||
"path": "src/plugins/maps_ems/public/index.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -1025,7 +1027,7 @@
|
|||
"section": "def-server.PluginInitializerContext",
|
||||
"text": "PluginInitializerContext"
|
||||
},
|
||||
"<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
|
||||
"<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; format: Readonly<{} & { type: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/server/index.ts",
|
||||
|
|
@ -1064,7 +1066,7 @@
|
|||
"section": "def-server.PluginInitializerContext",
|
||||
"text": "PluginInitializerContext"
|
||||
},
|
||||
"<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
|
||||
"<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; format: Readonly<{} & { type: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/server/index.ts",
|
||||
|
|
@ -1092,7 +1094,7 @@
|
|||
"section": "def-server.CoreSetup",
|
||||
"text": "CoreSetup"
|
||||
},
|
||||
"<object, unknown>) => { config: Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; }"
|
||||
"<object, unknown>) => { config: Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; format: Readonly<{} & { type: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/server/index.ts",
|
||||
|
|
@ -1172,7 +1174,7 @@
|
|||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>"
|
||||
"{ readonly includeElasticMapsService: boolean; readonly proxyElasticMapsServiceInMaps: boolean; readonly regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; format: Readonly<{} & { type: string; }>; url: string; attribution: string; }>[]; }>; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly manifestServiceUrl: string; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/maps_ems/server/index.ts",
|
||||
|
|
|
|||
|
|
@ -36,13 +36,51 @@
|
|||
"label": "getMetricsEntitiesClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"GetMetricsEntitiesClientType"
|
||||
"(esClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.ElasticsearchClient",
|
||||
"text": "ElasticsearchClient"
|
||||
},
|
||||
") => ",
|
||||
"MetricsEntitiesClient"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "metricsEntities",
|
||||
"id": "def-server.esClient",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "esClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"KibanaClient",
|
||||
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
|
||||
"TransportRequestParams",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): ",
|
||||
"TransportRequestPromise",
|
||||
"<",
|
||||
"ApiResponse",
|
||||
"<Record<string, any>, unknown>>; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
||||
"lineNumber": 12
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
244
api_docs/ml.json
244
api_docs/ml.json
|
|
@ -880,7 +880,7 @@
|
|||
"label": "capabilities",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"MlCapabilities"
|
||||
"{ canAccessML: boolean; canGetJobs: boolean; canGetDatafeeds: boolean; canGetCalendars: boolean; canFindFileStructure: boolean; canGetDataFrameAnalytics: boolean; canGetAnnotations: boolean; canCreateAnnotation: boolean; canDeleteAnnotation: boolean; canUseMlAlerts: boolean; } & { canCreateJob: boolean; canDeleteJob: boolean; canOpenJob: boolean; canCloseJob: boolean; canUpdateJob: boolean; canForecastJob: boolean; canCreateDatafeed: boolean; canDeleteDatafeed: boolean; canStartStopDatafeed: boolean; canUpdateDatafeed: boolean; canPreviewDatafeed: boolean; canGetFilters: boolean; canCreateCalendar: boolean; canDeleteCalendar: boolean; canCreateFilter: boolean; canDeleteFilter: boolean; canCreateDataFrameAnalytics: boolean; canDeleteDataFrameAnalytics: boolean; canStartStopDataFrameAnalytics: boolean; canCreateMlAlerts: boolean; canUseMlAlerts: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
|
||||
|
|
@ -1292,7 +1292,7 @@
|
|||
},
|
||||
"<",
|
||||
"MlAnomalyDetectionAlertParams",
|
||||
">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
|
||||
">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
|
||||
|
|
@ -1320,7 +1320,7 @@
|
|||
},
|
||||
" extends Pick<",
|
||||
"UseDataGridReturnType",
|
||||
", \"status\" | \"baseline\" | \"pagination\" | \"errorMessage\" | \"chartsVisible\" | \"chartsButtonVisible\" | \"ccsWarning\" | \"columnsWithCharts\" | \"invalidSortingColumnns\" | \"noDataMessage\" | \"onChangeItemsPerPage\" | \"onChangePage\" | \"onSort\" | \"setPagination\" | \"setVisibleColumns\" | \"rowCount\" | \"rowCountRelation\" | \"sortingColumns\" | \"tableItems\" | \"toggleChartVisibility\" | \"visibleColumns\" | \"predictionFieldName\" | \"resultsField\">"
|
||||
", \"status\" | \"errorMessage\" | \"baseline\" | \"pagination\" | \"chartsVisible\" | \"chartsButtonVisible\" | \"ccsWarning\" | \"columnsWithCharts\" | \"invalidSortingColumnns\" | \"noDataMessage\" | \"onChangeItemsPerPage\" | \"onChangePage\" | \"onSort\" | \"setPagination\" | \"setVisibleColumns\" | \"rowCount\" | \"rowCountRelation\" | \"sortingColumns\" | \"tableItems\" | \"toggleChartVisibility\" | \"visibleColumns\" | \"predictionFieldName\" | \"resultsField\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
|
||||
|
|
@ -1336,19 +1336,36 @@
|
|||
"label": "renderCellValue",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "ml",
|
||||
"scope": "public",
|
||||
"docId": "kibMlPluginApi",
|
||||
"section": "def-public.RenderCellValue",
|
||||
"text": "RenderCellValue"
|
||||
}
|
||||
"({ rowIndex, columnId, setCellProps, }: { rowIndex: number; columnId: string; setCellProps: (props: ",
|
||||
"CommonProps",
|
||||
" & React.HTMLAttributes<HTMLDivElement>) => void; }) => any"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
|
||||
"lineNumber": 84
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-public.__0",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ rowIndex: number; columnId: string; setCellProps: (props: ",
|
||||
"CommonProps",
|
||||
" & React.HTMLAttributes<HTMLDivElement>) => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
|
||||
"lineNumber": 43
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1396,7 +1413,15 @@
|
|||
"label": "AnomalySwimlaneEmbeddableInput",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"EmbeddableInput & AnomalySwimlaneEmbeddableCustomInput"
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableInput",
|
||||
"text": "EmbeddableInput"
|
||||
},
|
||||
" & ",
|
||||
"AnomalySwimlaneEmbeddableCustomInput"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/public/embeddables/types.ts",
|
||||
|
|
@ -1430,7 +1455,8 @@
|
|||
"label": "EsSorting",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Dictionary<{ order: 'asc' | 'desc'; }>"
|
||||
"Dictionary",
|
||||
"<{ order: \"asc\" | \"desc\"; }>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
|
||||
|
|
@ -1465,7 +1491,7 @@
|
|||
"label": "RenderCellValue",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(__0: { rowIndex: number; columnId: string; setCellProps: (props: ",
|
||||
"({ rowIndex, columnId, setCellProps, }: { rowIndex: number; columnId: string; setCellProps: (props: ",
|
||||
"CommonProps",
|
||||
" & React.HTMLAttributes<HTMLDivElement>) => void; }) => any"
|
||||
],
|
||||
|
|
@ -1486,9 +1512,11 @@
|
|||
"label": "ES_CLIENT_TOTAL_HITS_RELATION",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<\"GTE\" | \"EQ\", ",
|
||||
"{ GTE: ",
|
||||
"TotalHitsRelation",
|
||||
">"
|
||||
"; EQ: ",
|
||||
"TotalHitsRelation",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/es_client.ts",
|
||||
|
|
@ -1523,7 +1551,15 @@
|
|||
"label": "MlPluginStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ urlGenerator: UrlGeneratorContract<\"ML_APP_URL_GENERATOR\"> | undefined; }"
|
||||
"{ urlGenerator: ",
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "public",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-public.UrlGeneratorContract",
|
||||
"text": "UrlGeneratorContract"
|
||||
},
|
||||
"<\"ML_APP_URL_GENERATOR\"> | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/public/plugin.ts",
|
||||
|
|
@ -2901,7 +2937,9 @@
|
|||
"label": "datafeed_config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DatafeedWithStats"
|
||||
"Datafeed",
|
||||
" & ",
|
||||
"DatafeedStats"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
|
||||
|
|
@ -2912,6 +2950,72 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.IndicesOptions",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "IndicesOptions",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.IndicesOptions.allow_no_indices",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "allow_no_indices",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.IndicesOptions.expand_wildcards",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "expand_wildcards",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
"ExpandWildcardOptions",
|
||||
"[] | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
"lineNumber": 21
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.IndicesOptions.ignore_unavailable",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "ignore_unavailable",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.Influencer",
|
||||
|
|
@ -3401,7 +3505,7 @@
|
|||
},
|
||||
"<",
|
||||
"MlAnomalyDetectionAlertParams",
|
||||
">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
|
||||
">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
|
||||
|
|
@ -3511,7 +3615,8 @@
|
|||
"label": "model_size_stats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ModelSizeStats"
|
||||
"ModelSizeStats",
|
||||
" & { model_bytes_exceeded: number; model_bytes_memory_limit: number; peak_model_bytes?: number | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/model_snapshot.ts",
|
||||
|
|
@ -3620,7 +3725,9 @@
|
|||
"label": "Aggregation",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: estypes.AggregationContainer; }"
|
||||
"{ [x: string]: ",
|
||||
"AggregationContainer",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
|
|
@ -3637,7 +3744,7 @@
|
|||
"label": "AnalysisConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.AnalysisConfig"
|
||||
"AnalysisConfig"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3654,7 +3761,7 @@
|
|||
"label": "AnalysisLimits",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.AnalysisLimits"
|
||||
"AnalysisLimits"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3705,7 +3812,7 @@
|
|||
"label": "ChunkingConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.ChunkingConfig"
|
||||
"ChunkingConfig"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
|
|
@ -3722,7 +3829,7 @@
|
|||
"label": "CustomRule",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.DetectionRule"
|
||||
"DetectionRule"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3739,7 +3846,7 @@
|
|||
"label": "CustomSettings",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.CustomSettings"
|
||||
"CustomSettings"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3756,7 +3863,7 @@
|
|||
"label": "DataCounts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.DataCounts"
|
||||
"DataCounts"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
|
||||
|
|
@ -3773,7 +3880,7 @@
|
|||
"label": "DataDescription",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.DataDescription"
|
||||
"DataDescription"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3790,7 +3897,7 @@
|
|||
"label": "Datafeed",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.Datafeed"
|
||||
"Datafeed"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
|
|
@ -3824,7 +3931,7 @@
|
|||
"label": "DatafeedStats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.DatafeedStats"
|
||||
"DatafeedStats"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts",
|
||||
|
|
@ -3860,7 +3967,7 @@
|
|||
"label": "Detector",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.Detector"
|
||||
"Detector"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3894,7 +4001,7 @@
|
|||
"label": "ForecastsStats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.JobForecastStatistics"
|
||||
"JobForecastStatistics"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
|
||||
|
|
@ -3903,23 +4010,6 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.IndicesOptions",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "IndicesOptions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.IndicesOptions"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
|
||||
"lineNumber": 18
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-server.Job",
|
||||
|
|
@ -3928,7 +4018,7 @@
|
|||
"label": "Job",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.Job"
|
||||
"Job"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -3962,7 +4052,12 @@
|
|||
"label": "JobStats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.JobStats & { model_size_stats: ModelSizeStats; timing_stats: TimingStats; }"
|
||||
"JobStats",
|
||||
" & { model_size_stats: ",
|
||||
"ModelSizeStats",
|
||||
"; timing_stats: ",
|
||||
"TimingStats",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
|
||||
|
|
@ -3986,7 +4081,8 @@
|
|||
"ModelSizeStats",
|
||||
"; timing_stats: ",
|
||||
"TimingStats",
|
||||
"; } & JobAlertingRuleStats"
|
||||
"; } & ",
|
||||
"JobAlertingRuleStats"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
|
||||
|
|
@ -4003,7 +4099,8 @@
|
|||
"label": "MlSummaryJobs",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"MlSummaryJob[]"
|
||||
"MlSummaryJob",
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
|
||||
|
|
@ -4020,7 +4117,7 @@
|
|||
"label": "ModelPlotConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.ModelPlotConfig"
|
||||
"ModelPlotConfig"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
|
||||
|
|
@ -4037,7 +4134,8 @@
|
|||
"label": "ModelSizeStats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.ModelSizeStats & { model_bytes_exceeded: number; model_bytes_memory_limit: number; peak_model_bytes?: number | undefined; }"
|
||||
"ModelSizeStats",
|
||||
" & { model_bytes_exceeded: number; model_bytes_memory_limit: number; peak_model_bytes?: number | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
|
||||
|
|
@ -4071,7 +4169,7 @@
|
|||
"label": "Node",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.DiscoveryNode"
|
||||
"DiscoveryNode"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
|
||||
|
|
@ -4105,7 +4203,8 @@
|
|||
"label": "TimingStats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.TimingStats & { total_bucket_processing_time_ms: number; }"
|
||||
"TimingStats",
|
||||
" & { total_bucket_processing_time_ms: number; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
|
||||
|
|
@ -4132,7 +4231,26 @@
|
|||
" & ",
|
||||
"ModulesProvider",
|
||||
" & ",
|
||||
"ResultsServiceProvider"
|
||||
"ResultsServiceProvider",
|
||||
" & { alertingServiceProvider(savedObjectsClient: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise<any>; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, startedAt: Date, previousStartedAt: Date | null) => Promise<",
|
||||
"AnomalyDetectionAlertContext",
|
||||
" | undefined>; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/server/plugin.ts",
|
||||
|
|
@ -4552,7 +4670,9 @@
|
|||
"label": "RuntimeMappings",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: estypes.RuntimeField; }"
|
||||
"{ [x: string]: ",
|
||||
"RuntimeField",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/fields.ts",
|
||||
|
|
@ -4571,9 +4691,11 @@
|
|||
"label": "ES_CLIENT_TOTAL_HITS_RELATION",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<\"GTE\" | \"EQ\", ",
|
||||
"{ GTE: ",
|
||||
"TotalHitsRelation",
|
||||
">"
|
||||
"; EQ: ",
|
||||
"TotalHitsRelation",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ml/common/types/es_client.ts",
|
||||
|
|
|
|||
|
|
@ -39,7 +39,9 @@
|
|||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"lineNumber": 95
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
|
|
@ -55,7 +57,9 @@
|
|||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"lineNumber": 96
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
|
|
@ -79,7 +83,36 @@
|
|||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"lineNumber": 97
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
"id": "def-server.esClient",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "esClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"KibanaClient",
|
||||
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
|
||||
"TransportRequestParams",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): ",
|
||||
"TransportRequestPromise",
|
||||
"<",
|
||||
"ApiResponse",
|
||||
"<Record<string, any>, unknown>>; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"lineNumber": 97
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
|
|
@ -95,7 +128,9 @@
|
|||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"lineNumber": 98
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -111,7 +146,15 @@
|
|||
"label": "KibanaSettingsCollector",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Collector<EmailSettingData | undefined, {}> & KibanaSettingsCollectorExtraOptions"
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.ICollector",
|
||||
"text": "ICollector"
|
||||
},
|
||||
"<EmailSettingData | undefined, {}> & ",
|
||||
"KibanaSettingsCollectorExtraOptions"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts",
|
||||
|
|
@ -128,9 +171,9 @@
|
|||
"label": "MonitoringConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; agent: Readonly<{} & { interval: string; }>; licensing: Readonly<{} & { api_polling_frequency: ",
|
||||
"Duration",
|
||||
"; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
|
||||
"{ ui: { elasticsearch: ",
|
||||
"MonitoringElasticsearchConfig",
|
||||
"; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; 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: moment.Duration; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/monitoring/server/config.ts",
|
||||
|
|
@ -168,7 +211,9 @@
|
|||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"lineNumber": 102
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -262,7 +262,25 @@
|
|||
"label": "NewsfeedPublicPluginStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ createNewsFeed$: (endpoint: NewsfeedApiEndpoint) => Rx.Observable<void | FetchResult | null>; }"
|
||||
"{ createNewsFeed$: (endpoint: ",
|
||||
{
|
||||
"pluginId": "newsfeed",
|
||||
"scope": "public",
|
||||
"docId": "kibNewsfeedPluginApi",
|
||||
"section": "def-public.NewsfeedApiEndpoint",
|
||||
"text": "NewsfeedApiEndpoint"
|
||||
},
|
||||
") => ",
|
||||
"Observable",
|
||||
"<void | ",
|
||||
{
|
||||
"pluginId": "newsfeed",
|
||||
"scope": "public",
|
||||
"docId": "kibNewsfeedPluginApi",
|
||||
"section": "def-public.FetchResult",
|
||||
"text": "FetchResult"
|
||||
},
|
||||
" | null>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/newsfeed/public/plugin.tsx",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -22,9 +22,6 @@ import observabilityObj from './observability.json';
|
|||
### Functions
|
||||
<DocDefinitionList data={observabilityObj.client.functions}/>
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={observabilityObj.client.classes}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={observabilityObj.client.interfaces}/>
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -633,7 +633,10 @@
|
|||
"text": "ReportingSetup"
|
||||
},
|
||||
", ",
|
||||
"ReportingPublicPluginSetupDendencies"
|
||||
"ReportingPublicPluginSetupDendencies",
|
||||
", ",
|
||||
"ReportingPublicPluginStartDendencies",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||||
|
|
@ -874,7 +877,13 @@
|
|||
"label": "ReportingStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ReportingSetup"
|
||||
{
|
||||
"pluginId": "reporting",
|
||||
"scope": "public",
|
||||
"docId": "kibReportingPluginApi",
|
||||
"section": "def-public.ReportingSetup",
|
||||
"text": "ReportingSetup"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/public/index.ts",
|
||||
|
|
@ -896,7 +905,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 58
|
||||
"lineNumber": 60
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -919,9 +928,11 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 70
|
||||
"lineNumber": 72
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
|
|
@ -935,7 +946,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 72
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -951,7 +962,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 72
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -971,13 +982,13 @@
|
|||
"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; }>; roles: Readonly<{} & { enabled: boolean; 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 | ",
|
||||
"<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 | ",
|
||||
"ByteSizeValue",
|
||||
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||||
"; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 72
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -999,7 +1010,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 90
|
||||
"lineNumber": 92
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1015,7 +1026,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 90
|
||||
"lineNumber": 92
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1037,7 +1048,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 104
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1053,7 +1064,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 104
|
||||
"lineNumber": 106
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1073,7 +1084,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 117
|
||||
"lineNumber": 119
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1091,7 +1102,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 128
|
||||
"lineNumber": 130
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1109,7 +1120,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 135
|
||||
"lineNumber": 137
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1135,7 +1146,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 142
|
||||
"lineNumber": 144
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1157,7 +1168,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 142
|
||||
"lineNumber": 144
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1179,7 +1190,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 151
|
||||
"lineNumber": 153
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1204,7 +1215,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 185
|
||||
"lineNumber": 187
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1222,7 +1233,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 197
|
||||
"lineNumber": 199
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1242,7 +1253,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 204
|
||||
"lineNumber": 206
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1261,7 +1272,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 212
|
||||
"lineNumber": 214
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1291,7 +1302,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 216
|
||||
"lineNumber": 218
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1310,7 +1321,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 216
|
||||
"lineNumber": 218
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1332,7 +1343,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 220
|
||||
"lineNumber": 222
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1352,7 +1363,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 224
|
||||
"lineNumber": 226
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1372,7 +1383,25 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 234
|
||||
"lineNumber": 236
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-server.ReportingCore.getEnableScreenshotMode",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getEnableScreenshotMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => () => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 242
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1391,7 +1420,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 243
|
||||
"lineNumber": 250
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1413,7 +1442,7 @@
|
|||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise<",
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
|
|
@ -1425,7 +1454,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 255
|
||||
"lineNumber": 262
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1445,11 +1474,11 @@
|
|||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 255
|
||||
"lineNumber": 262
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1479,7 +1508,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 261
|
||||
"lineNumber": 268
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1502,7 +1531,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 261
|
||||
"lineNumber": 268
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1519,7 +1548,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 261
|
||||
"lineNumber": 268
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1549,7 +1578,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 275
|
||||
"lineNumber": 282
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1565,7 +1594,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 275
|
||||
"lineNumber": 282
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1582,7 +1611,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 275
|
||||
"lineNumber": 282
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
|
|
@ -1599,7 +1628,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 275
|
||||
"lineNumber": 282
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1637,7 +1666,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 295
|
||||
"lineNumber": 302
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1660,7 +1689,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 295
|
||||
"lineNumber": 302
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1677,7 +1706,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 295
|
||||
"lineNumber": 302
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1705,7 +1734,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 305
|
||||
"lineNumber": 312
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1731,7 +1760,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 310
|
||||
"lineNumber": 317
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1749,7 +1778,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 315
|
||||
"lineNumber": 322
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1765,7 +1794,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 315
|
||||
"lineNumber": 322
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1785,7 +1814,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 319
|
||||
"lineNumber": 326
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -1801,7 +1830,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 319
|
||||
"lineNumber": 326
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -1821,7 +1850,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 323
|
||||
"lineNumber": 330
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
|
|
@ -1876,7 +1905,16 @@
|
|||
"docId": "kibReportingPluginApi",
|
||||
"section": "def-server.ReportingSetupDeps",
|
||||
"text": "ReportingSetupDeps"
|
||||
}
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "reporting",
|
||||
"scope": "server",
|
||||
"docId": "kibReportingPluginApi",
|
||||
"section": "def-server.ReportingStartDeps",
|
||||
"text": "ReportingStartDeps"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||||
|
|
@ -1915,9 +1953,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; }>; roles: Readonly<{} & { enabled: boolean; 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 | ",
|
||||
"<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 | ",
|
||||
"ByteSizeValue",
|
||||
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||||
"; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||||
|
|
@ -2053,7 +2091,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||||
"lineNumber": 86
|
||||
"lineNumber": 87
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -2075,7 +2113,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||||
"lineNumber": 86
|
||||
"lineNumber": 87
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -2098,7 +2136,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||||
"lineNumber": 86
|
||||
"lineNumber": 87
|
||||
},
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
|
|
@ -2127,9 +2165,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; }>; roles: Readonly<{} & { enabled: boolean; 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 | ",
|
||||
" 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 | ",
|
||||
"ByteSizeValue",
|
||||
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||||
"; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/config/config.ts",
|
||||
|
|
@ -2165,7 +2203,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 28
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -2187,7 +2225,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 29
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -2209,7 +2247,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 30
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -2232,7 +2270,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 31
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -2255,7 +2293,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 32
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -2267,17 +2305,15 @@
|
|||
"label": "taskManager",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "taskManager",
|
||||
"scope": "server",
|
||||
"docId": "kibTaskManagerPluginApi",
|
||||
"section": "def-server.TaskManagerSetupContract",
|
||||
"text": "TaskManagerSetupContract"
|
||||
}
|
||||
"{ index: string; addMiddleware: (middleware: ",
|
||||
"Middleware",
|
||||
") => void; } & Pick<",
|
||||
"TaskTypeDictionary",
|
||||
", \"registerTaskDefinitions\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 33
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -2300,7 +2336,29 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 34
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-server.ReportingSetupDeps.screenshotMode",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "screenshotMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "screenshotMode",
|
||||
"scope": "server",
|
||||
"docId": "kibScreenshotModePluginApi",
|
||||
"section": "def-server.ScreenshotModePluginSetup",
|
||||
"text": "ScreenshotModePluginSetup"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 36
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -2316,7 +2374,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 37
|
||||
"lineNumber": 39
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -2338,7 +2396,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 38
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
|
|
@ -2350,17 +2408,15 @@
|
|||
"label": "taskManager",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "taskManager",
|
||||
"scope": "server",
|
||||
"docId": "kibTaskManagerPluginApi",
|
||||
"section": "def-server.TaskManagerStartContract",
|
||||
"text": "TaskManagerStartContract"
|
||||
}
|
||||
"Pick<",
|
||||
"TaskScheduling",
|
||||
", \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<",
|
||||
"TaskStore",
|
||||
", \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: (id: string) => Promise<void>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 39
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
|
|
@ -2380,7 +2436,7 @@
|
|||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 42
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
|
|
@ -2396,9 +2452,11 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"lineNumber": 43
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -11,25 +11,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
import ruleRegistryObj from './rule_registry.json';
|
||||
|
||||
## Client
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={ruleRegistryObj.client.classes}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={ruleRegistryObj.client.interfaces}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={ruleRegistryObj.client.misc}/>
|
||||
|
||||
## Server
|
||||
|
||||
### Setup
|
||||
<DocDefinitionList data={[ruleRegistryObj.server.setup]}/>
|
||||
|
||||
### Start
|
||||
<DocDefinitionList data={[ruleRegistryObj.server.start]}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={ruleRegistryObj.server.functions}/>
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={ruleRegistryObj.server.classes}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={ruleRegistryObj.server.interfaces}/>
|
||||
|
||||
|
|
@ -38,15 +33,6 @@ import ruleRegistryObj from './rule_registry.json';
|
|||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={ruleRegistryObj.common.objects}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={ruleRegistryObj.common.functions}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={ruleRegistryObj.common.interfaces}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={ruleRegistryObj.common.misc}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -171,7 +171,26 @@
|
|||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
"id": "def-public.e",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "e",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.FormEvent<HTMLFormElement> | React.MouseEvent<Element, MouseEvent> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -213,7 +232,32 @@
|
|||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
||||
"lineNumber": 59
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
"id": "def-public.field",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "runtimeFields",
|
||||
"scope": "public",
|
||||
"docId": "kibRuntimeFieldsPluginApi",
|
||||
"section": "def-public.RuntimeField",
|
||||
"text": "RuntimeField"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
||||
"lineNumber": 59
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
|
|
@ -231,7 +275,9 @@
|
|||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
||||
"lineNumber": 63
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
|
|
@ -337,7 +383,7 @@
|
|||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
|
||||
"\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
||||
|
|
@ -376,7 +422,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"ComboBoxOption",
|
||||
"<\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\">[]"
|
||||
"<\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\">[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/runtime_fields/public/constants.ts",
|
||||
|
|
@ -393,7 +439,7 @@
|
|||
"label": "RuntimeType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
|
||||
"\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\""
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
||||
|
|
|
|||
|
|
@ -55,7 +55,78 @@
|
|||
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
||||
"lineNumber": 108
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.componentName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "componentName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.location",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "location",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propFullName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propFullName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -74,7 +145,78 @@
|
|||
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
||||
"lineNumber": 109
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.componentName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "componentName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.location",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "location",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propFullName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propFullName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -91,7 +233,78 @@
|
|||
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
||||
"lineNumber": 110
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.componentName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "componentName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.location",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "location",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propFullName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propFullName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -108,7 +321,78 @@
|
|||
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
||||
"lineNumber": 111
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.componentName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "componentName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.location",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "location",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propFullName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propFullName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -125,7 +409,78 @@
|
|||
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
||||
"lineNumber": 112
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.componentName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "componentName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.location",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "location",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propFullName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propFullName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -142,7 +497,78 @@
|
|||
"path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx",
|
||||
"lineNumber": 113
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.componentName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "componentName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.location",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "location",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.propFullName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "propFullName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "node_modules/@types/prop-types/index.d.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -500,7 +926,7 @@
|
|||
"label": "loaderProperties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, string>"
|
||||
"{ [x: string]: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
||||
|
|
@ -797,7 +1223,7 @@
|
|||
"label": "attributes",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, unknown>"
|
||||
"{ [x: string]: unknown; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/saved_object_loader.ts",
|
||||
|
|
@ -1481,7 +1907,10 @@
|
|||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SimpleSavedObject",
|
||||
"text": "SimpleSavedObject"
|
||||
}
|
||||
},
|
||||
"<",
|
||||
"SavedObjectAttributes",
|
||||
">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
||||
|
|
@ -1613,15 +2042,113 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"{ get: <T = unknown>(type: string, id: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
"section": "def-public.SimpleSavedObject",
|
||||
"text": "SimpleSavedObject"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"find\" | \"bulkGet\" | \"update\" | \"bulkUpdate\">"
|
||||
"<T>>; delete: (type: string, id: string, options?: ",
|
||||
"SavedObjectsDeleteOptions",
|
||||
" | undefined) => Promise<{}>; create: <T = unknown>(type: string, attributes: T, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SimpleSavedObject",
|
||||
"text": "SimpleSavedObject"
|
||||
},
|
||||
"<T>>; bulkCreate: (objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsBulkCreateObject",
|
||||
"text": "SavedObjectsBulkCreateObject"
|
||||
},
|
||||
"<unknown>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsBulkCreateOptions",
|
||||
"text": "SavedObjectsBulkCreateOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsBatchResponse",
|
||||
"text": "SavedObjectsBatchResponse"
|
||||
},
|
||||
"<unknown>>; find: <T = unknown, A = unknown>(options: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsFindResponsePublic",
|
||||
"text": "SavedObjectsFindResponsePublic"
|
||||
},
|
||||
"<T, unknown>>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsBatchResponse",
|
||||
"text": "SavedObjectsBatchResponse"
|
||||
},
|
||||
"<unknown>>; update: <T = unknown>(type: string, id: string, attributes: T, { version, references, upsert }?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"<unknown>) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SimpleSavedObject",
|
||||
"text": "SimpleSavedObject"
|
||||
},
|
||||
"<T>>; bulkUpdate: <T = unknown>(objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsBulkUpdateObject",
|
||||
"text": "SavedObjectsBulkUpdateObject"
|
||||
},
|
||||
"<unknown>[]) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsBatchResponse",
|
||||
"text": "SavedObjectsBatchResponse"
|
||||
},
|
||||
"<unknown>>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts",
|
||||
|
|
@ -1798,7 +2325,9 @@
|
|||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -1936,7 +2465,9 @@
|
|||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"lineNumber": 29
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -1984,7 +2515,33 @@
|
|||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.OnSaveProps",
|
||||
"text": "OnSaveProps"
|
||||
},
|
||||
" & { returnToOrigin: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2199,7 +2756,9 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 26
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2209,7 +2768,7 @@
|
|||
"label": "_source",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, unknown>"
|
||||
"{ [x: string]: unknown; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
|
|
@ -2239,7 +2798,26 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.resp",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "resp",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2270,7 +2848,26 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.opts",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "opts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectCreationOpts"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2318,7 +2915,9 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2334,7 +2933,9 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 34
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2350,7 +2951,9 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2366,7 +2969,9 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 36
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2459,7 +3064,9 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 41
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2512,7 +3119,32 @@
|
|||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.saveOptions",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "saveOptions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectSaveOpts",
|
||||
"text": "SavedObjectSaveOpts"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2927,7 +3559,32 @@
|
|||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"lineNumber": 21
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.config",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectConfig",
|
||||
"text": "SavedObjectConfig"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"lineNumber": 21
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
|
@ -2945,7 +3602,26 @@
|
|||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.object",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "object",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -3013,12 +3689,15 @@
|
|||
"\nThe factory to use to create the decorator"
|
||||
],
|
||||
"signature": [
|
||||
"(services: ",
|
||||
"SavedObjectKibanaServices",
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectDecoratorFactory",
|
||||
"text": "SavedObjectDecoratorFactory"
|
||||
"section": "def-public.SavedObjectDecorator",
|
||||
"text": "SavedObjectDecorator"
|
||||
},
|
||||
"<T>"
|
||||
],
|
||||
|
|
@ -3026,7 +3705,26 @@
|
|||
"path": "src/plugins/saved_objects/public/saved_object/decorators/registry.ts",
|
||||
"lineNumber": 26
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.services",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "services",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectKibanaServices"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -3738,7 +4436,33 @@
|
|||
"path": "src/plugins/saved_objects/public/plugin.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.config",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectDecoratorConfig",
|
||||
"text": "SavedObjectDecoratorConfig"
|
||||
},
|
||||
"<any>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects/public/plugin.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -84,7 +84,13 @@
|
|||
"label": "SavedObjectTaggingPluginStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectsTaggingApi"
|
||||
{
|
||||
"pluginId": "savedObjectsTaggingOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsTaggingOssPluginApi",
|
||||
"section": "def-public.SavedObjectsTaggingApi",
|
||||
"text": "SavedObjectsTaggingApi"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/saved_objects_tagging/public/types.ts",
|
||||
|
|
@ -822,7 +828,7 @@
|
|||
"label": "errors",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<Record<\"color\" | \"description\" | \"id\" | \"name\", string | undefined>>"
|
||||
"{ color?: string | undefined; description?: string | undefined; id?: string | undefined; name?: string | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/saved_objects_tagging/common/validation.ts",
|
||||
|
|
@ -933,7 +939,16 @@
|
|||
"label": "TagSavedObject",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObject<TagAttributes>"
|
||||
"SavedObject",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "savedObjectsTaggingOss",
|
||||
"scope": "common",
|
||||
"docId": "kibSavedObjectsTaggingOssPluginApi",
|
||||
"section": "def-common.TagAttributes",
|
||||
"text": "TagAttributes"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/saved_objects_tagging/common/types.ts",
|
||||
|
|
@ -969,7 +984,14 @@
|
|||
"label": "TagWithRelations",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Tag & { relationCount: number; }"
|
||||
{
|
||||
"pluginId": "savedObjectsTaggingOss",
|
||||
"scope": "common",
|
||||
"docId": "kibSavedObjectsTaggingOssPluginApi",
|
||||
"section": "def-common.Tag",
|
||||
"text": "Tag"
|
||||
},
|
||||
" & { relationCount: number; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/saved_objects_tagging/common/types.ts",
|
||||
|
|
|
|||
|
|
@ -300,7 +300,26 @@
|
|||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 251
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.ids",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "ids",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 251
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -940,7 +959,42 @@
|
|||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 196
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
|
|
@ -966,7 +1020,42 @@
|
|||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 200
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
|
|
@ -992,7 +1081,42 @@
|
|||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 206
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1083,7 +1207,26 @@
|
|||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 234
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.ids",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "ids",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"lineNumber": 234
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1107,7 +1250,14 @@
|
|||
"section": "def-public.SavedObject",
|
||||
"text": "SavedObject"
|
||||
},
|
||||
") => boolean"
|
||||
") => object is ",
|
||||
{
|
||||
"pluginId": "savedObjectsTaggingOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsTaggingOssPluginApi",
|
||||
"section": "def-public.TagDecoratedSavedObject",
|
||||
"text": "TagDecoratedSavedObject"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
|
|
@ -1124,7 +1274,14 @@
|
|||
"label": "TagDecoratedSavedObject",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObject & { getTags(): string[]; setTags(tags: string[]): void; }"
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObject",
|
||||
"text": "SavedObject"
|
||||
},
|
||||
" & { getTags(): string[]; setTags(tags: string[]): void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/decorator/types.ts",
|
||||
|
|
|
|||
345
api_docs/screenshot_mode.json
Normal file
345
api_docs/screenshot_mode.json
Normal file
|
|
@ -0,0 +1,345 @@
|
|||
{
|
||||
"id": "screenshotMode",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.setScreenshotModeEnabled",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "setScreenshotModeEnabled",
|
||||
"description": [
|
||||
"\nUse this function to set the current browser to screenshot mode.\n\nThis function should be called as early as possible to ensure that screenshot mode is\ncorrectly detected for the first page load. It is not suitable for use inside any plugin\ncode unless the plugin code is guaranteed to, somehow, load before any other code.\n\nAdditionally, we don't know what environment this code will run in so we remove as many external\nreferences as possible to make it portable. For instance, running inside puppeteer."
|
||||
],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/common/get_set_browser_screenshot_mode.ts",
|
||||
"lineNumber": 39
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModeRequestHandlerContext",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ScreenshotModeRequestHandlerContext",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "screenshotMode",
|
||||
"scope": "server",
|
||||
"docId": "kibScreenshotModePluginApi",
|
||||
"section": "def-server.ScreenshotModeRequestHandlerContext",
|
||||
"text": "ScreenshotModeRequestHandlerContext"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.RequestHandlerContext",
|
||||
"text": "RequestHandlerContext"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModeRequestHandlerContext.screenshotMode",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "screenshotMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ isScreenshot: boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 32
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.KBN_SCREENSHOT_MODE_HEADER",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "KBN_SCREENSHOT_MODE_HEADER",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/common/constants.ts",
|
||||
"lineNumber": 9
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": [],
|
||||
"setup": {
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModePluginSetup",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ScreenshotModePluginSetup",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 18
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModePluginSetup.isScreenshotMode",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isScreenshotMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => boolean"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.request",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "request",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModePluginSetup.setScreenshotModeEnabled",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "setScreenshotModeEnabled",
|
||||
"description": [
|
||||
"\nSet the current environment to screenshot mode. Intended to run in a browser-environment."
|
||||
],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 24
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
"initialIsOpen": true
|
||||
},
|
||||
"start": {
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModePluginStart",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ScreenshotModePluginStart",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.ScreenshotModePluginStart.isScreenshotMode",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isScreenshotMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => boolean"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-server.request",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "request",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/server/types.ts",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
"initialIsOpen": true
|
||||
}
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-common.getScreenshotMode",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getScreenshotMode",
|
||||
"description": [
|
||||
"\nThis function is responsible for detecting whether we are currently in screenshot mode.\n\nWe check in the current window context whether screenshot mode is enabled, otherwise we check\nlocalStorage. The ability to set a value in localStorage enables more convenient development and testing\nin functionality that needs to detect screenshot mode."
|
||||
],
|
||||
"signature": [
|
||||
"() => boolean"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/common/get_set_browser_screenshot_mode.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-common.setScreenshotModeDisabled",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "setScreenshotModeDisabled",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/common/get_set_browser_screenshot_mode.ts",
|
||||
"lineNumber": 52
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-common.setScreenshotModeEnabled",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "setScreenshotModeEnabled",
|
||||
"description": [
|
||||
"\nUse this function to set the current browser to screenshot mode.\n\nThis function should be called as early as possible to ensure that screenshot mode is\ncorrectly detected for the first page load. It is not suitable for use inside any plugin\ncode unless the plugin code is guaranteed to, somehow, load before any other code.\n\nAdditionally, we don't know what environment this code will run in so we remove as many external\nreferences as possible to make it portable. For instance, running inside puppeteer."
|
||||
],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/common/get_set_browser_screenshot_mode.ts",
|
||||
"lineNumber": 39
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "screenshotMode",
|
||||
"id": "def-common.KBN_SCREENSHOT_MODE_HEADER",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "KBN_SCREENSHOT_MODE_HEADER",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/screenshot_mode/common/constants.ts",
|
||||
"lineNumber": 9
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
38
api_docs/screenshot_mode.mdx
Normal file
38
api_docs/screenshot_mode.mdx
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
id: kibScreenshotModePluginApi
|
||||
slug: /kibana-dev-docs/screenshotModePluginApi
|
||||
title: screenshotMode
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the screenshotMode plugin
|
||||
date: 2020-11-16
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
|
||||
---
|
||||
|
||||
import screenshotModeObj from './screenshot_mode.json';
|
||||
|
||||
## Server
|
||||
|
||||
### Setup
|
||||
<DocDefinitionList data={[screenshotModeObj.server.setup]}/>
|
||||
|
||||
### Start
|
||||
<DocDefinitionList data={[screenshotModeObj.server.start]}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={screenshotModeObj.server.functions}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={screenshotModeObj.server.interfaces}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={screenshotModeObj.server.misc}/>
|
||||
|
||||
## Common
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={screenshotModeObj.common.functions}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={screenshotModeObj.common.misc}/>
|
||||
|
||||
|
|
@ -442,7 +442,7 @@
|
|||
"label": "iconType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"IconType"
|
||||
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
|
||||
|
|
@ -510,7 +510,11 @@
|
|||
"label": "SecurityPluginSetup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ authc: AuthenticationServiceSetup; sessionTimeout: ISessionTimeout; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
|
||||
"{ authc: ",
|
||||
"AuthenticationServiceSetup",
|
||||
"; sessionTimeout: ",
|
||||
"SessionTimeout",
|
||||
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
|
||||
"SecurityLicenseFeatures",
|
||||
"; features$: ",
|
||||
"Observable",
|
||||
|
|
@ -520,7 +524,7 @@
|
|||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/public/plugin.tsx",
|
||||
"lineNumber": 171
|
||||
"lineNumber": 164
|
||||
},
|
||||
"deprecated": false,
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -536,11 +540,13 @@
|
|||
"signature": [
|
||||
"{ navControlService: ",
|
||||
"SecurityNavControlServiceStart",
|
||||
"; authc: AuthenticationServiceSetup; }"
|
||||
"; authc: ",
|
||||
"AuthenticationServiceSetup",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/public/plugin.tsx",
|
||||
"lineNumber": 172
|
||||
"lineNumber": 165
|
||||
},
|
||||
"deprecated": false,
|
||||
"lifecycle": "start",
|
||||
|
|
@ -644,7 +650,33 @@
|
|||
"path": "x-pack/plugins/security/server/audit/audit_service.ts",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "security",
|
||||
"id": "def-server.event",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "event",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "security",
|
||||
"scope": "server",
|
||||
"docId": "kibSecurityPluginApi",
|
||||
"section": "def-server.AuditEvent",
|
||||
"text": "AuditEvent"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/audit/audit_service.ts",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1127,14 +1159,14 @@
|
|||
"plugin": "alerting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client_factory.test.ts",
|
||||
"lineNumber": 24
|
||||
"lineNumber": 23
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "alerting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/alerting/server/alerts_client_factory.test.ts",
|
||||
"lineNumber": 90
|
||||
"lineNumber": 98
|
||||
}
|
||||
}
|
||||
],
|
||||
|
|
@ -1153,7 +1185,52 @@
|
|||
"path": "x-pack/plugins/security/server/audit/audit_service.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "security",
|
||||
"id": "def-server.eventType",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "eventType",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/audit/audit_service.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "security",
|
||||
"id": "def-server.message",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "message",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/audit/audit_service.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "security",
|
||||
"id": "def-server.data",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, any> | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/audit/audit_service.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1229,6 +1306,13 @@
|
|||
"lineNumber": 444
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "cases",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/cases/server/plugin.ts",
|
||||
"lineNumber": 89
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "ml",
|
||||
"link": {
|
||||
|
|
@ -1236,13 +1320,6 @@
|
|||
"lineNumber": 105
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts",
|
||||
"lineNumber": 28
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
|
|
@ -1254,14 +1331,14 @@
|
|||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts",
|
||||
"lineNumber": 43
|
||||
"lineNumber": 45
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts",
|
||||
"lineNumber": 44
|
||||
"lineNumber": 45
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -1271,13 +1348,6 @@
|
|||
"lineNumber": 44
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "cases",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/cases/server/plugin.ts",
|
||||
"lineNumber": 83
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "dashboardMode",
|
||||
"link": {
|
||||
|
|
@ -1298,6 +1368,13 @@
|
|||
"path": "x-pack/plugins/logstash/server/routes/pipeline/save.ts",
|
||||
"lineNumber": 41
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts",
|
||||
"lineNumber": 28
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -1311,9 +1388,15 @@
|
|||
"label": "authz",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"AuthorizationServiceSetup",
|
||||
", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
|
||||
"{ mode: ",
|
||||
"AuthorizationMode",
|
||||
"; actions: ",
|
||||
"Actions",
|
||||
"; checkPrivilegesDynamicallyWithRequest: ",
|
||||
"CheckPrivilegesDynamicallyWithRequest",
|
||||
"; checkPrivilegesWithRequest: ",
|
||||
"CheckPrivilegesWithRequest",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/plugin.ts",
|
||||
|
|
@ -1437,9 +1520,19 @@
|
|||
"label": "authc",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"AuthenticationServiceStart",
|
||||
", \"getCurrentUser\" | \"apiKeys\">"
|
||||
"{ getCurrentUser: (request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => ",
|
||||
"AuthenticatedUser",
|
||||
" | null; apiKeys: Pick<",
|
||||
"APIKeys",
|
||||
", \"create\" | \"areAPIKeysEnabled\" | \"invalidate\" | \"grantAsInternalUser\" | \"invalidateAsInternalUser\">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/plugin.ts",
|
||||
|
|
@ -1455,9 +1548,15 @@
|
|||
"label": "authz",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"AuthorizationServiceSetup",
|
||||
", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
|
||||
"{ mode: ",
|
||||
"AuthorizationMode",
|
||||
"; actions: ",
|
||||
"Actions",
|
||||
"; checkPrivilegesDynamicallyWithRequest: ",
|
||||
"CheckPrivilegesDynamicallyWithRequest",
|
||||
"; checkPrivilegesWithRequest: ",
|
||||
"CheckPrivilegesWithRequest",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/plugin.ts",
|
||||
|
|
@ -1471,6 +1570,31 @@
|
|||
],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "security",
|
||||
"id": "def-server.AuthorizationServiceSetup",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "AuthorizationServiceSetup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ mode: ",
|
||||
"AuthorizationMode",
|
||||
"; actions: ",
|
||||
"Actions",
|
||||
"; checkPrivilegesDynamicallyWithRequest: ",
|
||||
"CheckPrivilegesDynamicallyWithRequest",
|
||||
"; checkPrivilegesWithRequest: ",
|
||||
"CheckPrivilegesWithRequest",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/security/server/index.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "security",
|
||||
"id": "def-server.ROUTE_TAG_CAN_REDIRECT",
|
||||
|
|
|
|||
|
|
@ -149,7 +149,27 @@
|
|||
"path": "src/plugins/security_oss/server/plugin.ts",
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "securityOss",
|
||||
"id": "def-server.provider",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "provider",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"AnonymousAccessService"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/security_oss/server/plugin.ts",
|
||||
"lineNumber": 35
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -27,9 +27,6 @@ import securitySolutionObj from './security_solution.json';
|
|||
### Start
|
||||
<DocDefinitionList data={[securitySolutionObj.server.start]}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={securitySolutionObj.server.functions}/>
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={securitySolutionObj.server.classes}/>
|
||||
|
||||
|
|
@ -39,14 +36,3 @@ import securitySolutionObj from './security_solution.json';
|
|||
### Consts, variables and types
|
||||
<DocDefinitionList data={securitySolutionObj.server.misc}/>
|
||||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={securitySolutionObj.common.objects}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={securitySolutionObj.common.functions}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={securitySolutionObj.common.misc}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -509,7 +509,9 @@
|
|||
"path": "src/plugins/share/public/types.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
|
|
@ -549,7 +551,7 @@
|
|||
},
|
||||
" extends Pick<",
|
||||
"EuiContextMenuPanelItemDescriptorEntry",
|
||||
", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"disabled\" | \"data-test-subj\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">"
|
||||
", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"disabled\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/share/public/types.ts",
|
||||
|
|
@ -699,7 +701,32 @@
|
|||
"path": "src/plugins/share/public/types.ts",
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-public.context",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "public",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-public.ShareContext",
|
||||
"text": "ShareContext"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/share/public/types.ts",
|
||||
"lineNumber": 74
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1243,7 +1270,7 @@
|
|||
"label": "DownloadableContent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ content: string; type: string; } | Blob"
|
||||
"Blob | { content: string; type: string; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/share/public/lib/download_as.ts",
|
||||
|
|
@ -1287,7 +1314,9 @@
|
|||
"section": "def-public.ShareMenuProvider",
|
||||
"text": "ShareMenuProvider"
|
||||
},
|
||||
") => void; } & { urlGenerators: UrlGeneratorsSetup; }"
|
||||
") => void; } & { urlGenerators: ",
|
||||
"UrlGeneratorsSetup",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/share/public/plugin.ts",
|
||||
|
|
@ -1313,7 +1342,9 @@
|
|||
"section": "def-public.ShowShareMenuOptions",
|
||||
"text": "ShowShareMenuOptions"
|
||||
},
|
||||
") => void; } & { urlGenerators: UrlGeneratorsStart; }"
|
||||
") => void; } & { urlGenerators: ",
|
||||
"UrlGeneratorsStart",
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/share/public/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -449,7 +449,13 @@
|
|||
"\nStart contract for the Spaces plugin."
|
||||
],
|
||||
"signature": [
|
||||
"SpacesApi"
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-public.SpacesApi",
|
||||
"text": "SpacesApi"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/spaces/public/plugin.tsx",
|
||||
|
|
@ -1204,14 +1210,14 @@
|
|||
"plugin": "reporting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 264
|
||||
"lineNumber": 271
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/plugin.ts",
|
||||
"lineNumber": 193
|
||||
"lineNumber": 194
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -1363,14 +1369,14 @@
|
|||
"plugin": "security",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts",
|
||||
"lineNumber": 784
|
||||
"lineNumber": 1000
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "security",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts",
|
||||
"lineNumber": 811
|
||||
"lineNumber": 1027
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -1551,7 +1557,35 @@
|
|||
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-server.request",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "request",
|
||||
"description": [
|
||||
"the request."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
|
|
@ -1996,28 +2030,28 @@
|
|||
"plugin": "reporting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 262
|
||||
"lineNumber": 269
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "reporting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 284
|
||||
"lineNumber": 291
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "reporting",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"lineNumber": 296
|
||||
"lineNumber": 303
|
||||
}
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"link": {
|
||||
"path": "x-pack/plugins/security_solution/server/plugin.ts",
|
||||
"lineNumber": 193
|
||||
"lineNumber": 194
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -221,7 +221,7 @@
|
|||
"tags": [],
|
||||
"label": "changeSpacesHandler",
|
||||
"description": [
|
||||
"\nOptional handler that is called when the user has saved changes and there are spaces to be added to and/or removed from the object. If\nthis is not defined, a default handler will be used that calls `/api/spaces/_share_saved_object_add` and/or\n`/api/spaces/_share_saved_object_remove` and displays toast(s) indicating what occurred."
|
||||
"\nOptional handler that is called when the user has saved changes and there are spaces to be added to and/or removed from the object. If\nthis is not defined, a default handler will be used that calls `/api/spaces/_update_objects_spaces` and displays a toast indicating\nwhat occurred."
|
||||
],
|
||||
"signature": [
|
||||
"((spacesToAdd: string[], spacesToRemove: string[]) => Promise<void>) | undefined"
|
||||
|
|
@ -416,15 +416,7 @@
|
|||
"The space to represent with an avatar."
|
||||
],
|
||||
"signature": [
|
||||
"Partial<",
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "common",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-common.Space",
|
||||
"text": "Space"
|
||||
},
|
||||
">"
|
||||
"{ id?: string | undefined; name?: string | undefined; description?: string | undefined; color?: string | undefined; initials?: string | undefined; imageUrl?: string | undefined; disabledFeatures?: string[] | undefined; _reserved?: boolean | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
|
|
@ -577,9 +569,14 @@
|
|||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.SpacesApi.getActiveSpace$",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getActiveSpace$",
|
||||
"description": [
|
||||
"\nObservable representing the currently active space.\nThe details of the space can change without a full page reload (such as display name, color, etc.)"
|
||||
],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"Observable",
|
||||
|
|
@ -593,16 +590,13 @@
|
|||
},
|
||||
">"
|
||||
],
|
||||
"description": [
|
||||
"\nObservable representing the currently active space.\nThe details of the space can change without a full page reload (such as display name, color, etc.)"
|
||||
],
|
||||
"children": [],
|
||||
"tags": [],
|
||||
"returnComment": [],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 22
|
||||
}
|
||||
},
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
|
|
@ -714,7 +708,43 @@
|
|||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 68
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.path",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "path",
|
||||
"description": [
|
||||
"The path to use for the new URL, optionally including `search` and/or `hash` URL components."
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 68
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.objectNoun",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "objectNoun",
|
||||
"description": [
|
||||
"The string that is used to describe the object in the toast, e.g., _The **object** you're looking for has a new\nlocation_. Default value is 'object'."
|
||||
],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 68
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -744,14 +774,7 @@
|
|||
"\nProvides a context that is required to render some Spaces components."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-public.LazyComponentFn",
|
||||
"text": "LazyComponentFn"
|
||||
},
|
||||
"<",
|
||||
"(props: ",
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
|
|
@ -759,13 +782,32 @@
|
|||
"section": "def-public.SpacesContextProps",
|
||||
"text": "SpacesContextProps"
|
||||
},
|
||||
">"
|
||||
") => 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>)>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 78
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
|
|
@ -777,14 +819,7 @@
|
|||
"\nDisplays a flyout to edit the spaces that an object is shared to.\n\nNote: must be rendered inside of a SpacesContext."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-public.LazyComponentFn",
|
||||
"text": "LazyComponentFn"
|
||||
},
|
||||
"<",
|
||||
"(props: ",
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
|
|
@ -792,13 +827,32 @@
|
|||
"section": "def-public.ShareToSpaceFlyoutProps",
|
||||
"text": "ShareToSpaceFlyoutProps"
|
||||
},
|
||||
">"
|
||||
") => 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>)>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 84
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
|
|
@ -810,14 +864,7 @@
|
|||
"\nDisplays a corresponding list of spaces for a given list of saved object namespaces. It shows up to five spaces (and an indicator for\nany number of spaces that the user is not authorized to see) by default. If more than five named spaces would be displayed, the extras\n(along with the unauthorized spaces indicator, if present) are hidden behind a button. If '*' (aka \"All spaces\") is present, it\nsupersedes all of the above and just displays a single badge without a button.\n\nNote: must be rendered inside of a SpacesContext."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-public.LazyComponentFn",
|
||||
"text": "LazyComponentFn"
|
||||
},
|
||||
"<",
|
||||
"(props: ",
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
|
|
@ -825,13 +872,32 @@
|
|||
"section": "def-public.SpaceListProps",
|
||||
"text": "SpaceListProps"
|
||||
},
|
||||
">"
|
||||
") => 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>)>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 93
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
|
|
@ -843,14 +909,7 @@
|
|||
"\nDisplays a callout that needs to be used if a call to `SavedObjectsClient.resolve()` results in an `\"conflict\"` outcome, which\nindicates that the user has loaded the page which is associated directly with one object (A), *and* with a legacy URL that points to a\ndifferent object (B).\n\nIn this case, `SavedObjectsClient.resolve()` has returned object A. This component displays a warning callout to the user explaining\nthat there is a conflict, and it includes a button that will redirect the user to object B when clicked.\n\nConsumers need to determine the local path for the new URL on their own, based on the object ID that was used to call\n`SavedObjectsClient.resolve()` (A) and the `aliasTargetId` value in the response (B). For example...\n\nA is `workpad-123` and B is `workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e`.\n\nFull legacy URL: `https://localhost:5601/app/canvas#/workpad/workpad-123/page/1`\n\nNew URL path: `#/workpad/workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e/page/1`"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-public.LazyComponentFn",
|
||||
"text": "LazyComponentFn"
|
||||
},
|
||||
"<",
|
||||
"(props: ",
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
|
|
@ -858,13 +917,32 @@
|
|||
"section": "def-public.LegacyUrlConflictProps",
|
||||
"text": "LegacyUrlConflictProps"
|
||||
},
|
||||
">"
|
||||
") => 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>)>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 111
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
|
|
@ -876,14 +954,7 @@
|
|||
"\nDisplays an avatar for the given space."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesOssPluginApi",
|
||||
"section": "def-public.LazyComponentFn",
|
||||
"text": "LazyComponentFn"
|
||||
},
|
||||
"<",
|
||||
"(props: ",
|
||||
{
|
||||
"pluginId": "spacesOss",
|
||||
"scope": "public",
|
||||
|
|
@ -891,13 +962,32 @@
|
|||
"section": "def-public.SpaceAvatarProps",
|
||||
"text": "SpaceAvatarProps"
|
||||
},
|
||||
">"
|
||||
") => 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>)>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 115
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spacesOss",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/spaces_oss/public/api.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -522,7 +522,7 @@
|
|||
"\nThe state passed into the task's run function, and returned by the previous\nrun. If there was no previous run, or if the previous run did not return\nany state, this will be the empy object: {}"
|
||||
],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/task_manager/server/task.ts",
|
||||
|
|
@ -740,7 +740,7 @@
|
|||
"\nA task-specific set of parameters, used by the task's run function to tailor\nits work. This is generally user-input, such as { sms: '333-444-2222' }."
|
||||
],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/task_manager/server/task.ts",
|
||||
|
|
@ -758,7 +758,7 @@
|
|||
"\nThe state passed into the task's run function, and returned by the previous\nrun. If there was no previous run, or if the previous run did not return\nany state, this will be the empy object: {}"
|
||||
],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/task_manager/server/task.ts",
|
||||
|
|
@ -877,7 +877,11 @@
|
|||
"label": "TaskManagerSetupContract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ index: string; addMiddleware: (middleware: Middleware) => void; } & Pick<TaskTypeDictionary, \"registerTaskDefinitions\">"
|
||||
"{ index: string; addMiddleware: (middleware: ",
|
||||
"Middleware",
|
||||
") => void; } & Pick<",
|
||||
"TaskTypeDictionary",
|
||||
", \"registerTaskDefinitions\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
||||
|
|
@ -895,7 +899,11 @@
|
|||
"label": "TaskManagerStartContract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<TaskScheduling, \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<TaskStore, \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: TaskStore['remove']; }"
|
||||
"Pick<",
|
||||
"TaskScheduling",
|
||||
", \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<",
|
||||
"TaskStore",
|
||||
", \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: (id: string) => Promise<void>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -200,7 +200,9 @@
|
|||
"path": "src/plugins/telemetry/public/plugin.ts",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetry",
|
||||
|
|
@ -233,7 +235,9 @@
|
|||
"path": "src/plugins/telemetry/public/plugin.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetry",
|
||||
|
|
@ -251,7 +255,9 @@
|
|||
"path": "src/plugins/telemetry/public/plugin.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetry",
|
||||
|
|
@ -269,7 +275,25 @@
|
|||
"path": "src/plugins/telemetry/public/plugin.ts",
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "telemetry",
|
||||
"id": "def-public.optedIn",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "optedIn",
|
||||
"description": [
|
||||
"Whether the user is opting-in (`true`) or out (`false`)."
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry/public/plugin.ts",
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -656,7 +680,14 @@
|
|||
"\nThe Data Telemetry is reported as an array of {@link DataTelemetryDocument}"
|
||||
],
|
||||
"signature": [
|
||||
"DataTelemetryDocument[]"
|
||||
{
|
||||
"pluginId": "telemetry",
|
||||
"scope": "server",
|
||||
"docId": "kibTelemetryPluginApi",
|
||||
"section": "def-server.DataTelemetryDocument",
|
||||
"text": "DataTelemetryDocument"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
|
||||
|
|
@ -675,7 +706,17 @@
|
|||
"\nThe payload structure as composed by the OSS telemetry collection mechanism."
|
||||
],
|
||||
"signature": [
|
||||
"{ timestamp: string; cluster_uuid: string; cluster_name: string; version: string; cluster_stats: Pick<estypes.ClusterStatsResponse, \"status\" | \"indices\" | \"nodes\" | \"cluster_uuid\" | \"timestamp\">; collection: string; stack_stats: { data: DataTelemetryPayload | undefined; kibana: { count: number; indices: number; os: {}; versions: { version: string; count: number; }[]; plugins: { [plugin: string]: Record<string, unknown>; }; } | undefined; }; }"
|
||||
"{ timestamp: string; cluster_uuid: string; cluster_name: string; version: string; cluster_stats: Pick<",
|
||||
"ClusterStatsResponse",
|
||||
", \"status\" | \"indices\" | \"nodes\" | \"cluster_uuid\" | \"timestamp\">; collection: string; stack_stats: { data: ",
|
||||
{
|
||||
"pluginId": "telemetry",
|
||||
"scope": "server",
|
||||
"docId": "kibTelemetryPluginApi",
|
||||
"section": "def-server.DataTelemetryPayload",
|
||||
"text": "DataTelemetryPayload"
|
||||
},
|
||||
" | undefined; kibana: { count: number; indices: number; os: {}; versions: { version: string; count: number; }[]; plugins: { [plugin: string]: Record<string, unknown>; }; } | undefined; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry/server/telemetry_collection/get_local_stats.ts",
|
||||
|
|
@ -719,7 +760,9 @@
|
|||
"path": "src/plugins/telemetry/server/plugin.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -756,7 +799,9 @@
|
|||
"path": "src/plugins/telemetry/server/plugin.ts",
|
||||
"lineNumber": 68
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
|||
|
|
@ -84,13 +84,17 @@
|
|||
"label": "esClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.ElasticsearchClient",
|
||||
"text": "ElasticsearchClient"
|
||||
}
|
||||
"Pick<",
|
||||
"KibanaClient",
|
||||
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
|
||||
"TransportRequestParams",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): ",
|
||||
"TransportRequestPromise",
|
||||
"<",
|
||||
"ApiResponse",
|
||||
"<Record<string, any>, unknown>>; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
|
|
@ -106,15 +110,307 @@
|
|||
"label": "soClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"{ get: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; delete: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsDeleteOptions",
|
||||
"text": "SavedObjectsDeleteOptions"
|
||||
},
|
||||
") => Promise<{}>; create: <T = unknown>(type: string, attributes: T, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkCreateObject",
|
||||
"text": "SavedObjectsBulkCreateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; checkConflicts: (objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsObject",
|
||||
"text": "SavedObjectsCheckConflictsObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
||||
"text": "SavedObjectsCheckConflictsResponse"
|
||||
},
|
||||
">; find: <T = unknown, A = unknown>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkGetObject",
|
||||
"text": "SavedObjectsBulkGetObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsResolveResponse",
|
||||
"text": "SavedObjectsResolveResponse"
|
||||
},
|
||||
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"<T>) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
||||
},
|
||||
">; updateObjectsSpaces: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
||||
},
|
||||
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
||||
},
|
||||
">; bulkUpdate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateObject",
|
||||
"text": "SavedObjectsBulkUpdateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
||||
"text": "SavedObjectsBulkUpdateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
||||
"text": "SavedObjectsBulkUpdateResponse"
|
||||
},
|
||||
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
||||
"text": "SavedObjectsRemoveReferencesToOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
||||
"text": "SavedObjectsRemoveReferencesToResponse"
|
||||
},
|
||||
">; openPointInTimeForType: (type: string | string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
||||
"text": "SavedObjectsOpenPointInTimeOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
||||
"text": "SavedObjectsOpenPointInTimeResponse"
|
||||
},
|
||||
">; closePointInTime: (id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
||||
"text": "SavedObjectsClosePointInTimeResponse"
|
||||
},
|
||||
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
||||
"text": "ISavedObjectsPointInTimeFinder"
|
||||
},
|
||||
"<T, A>; errors: typeof ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsErrorHelpers",
|
||||
"text": "SavedObjectsErrorHelpers"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
|
|
@ -371,7 +667,27 @@
|
|||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
"id": "def-server.collectionConfig",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "collectionConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"CollectionStrategyConfig",
|
||||
"<T>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
"lineNumber": 20
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
|
|
@ -395,7 +711,41 @@
|
|||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
"id": "def-server.optInStatus",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "optInStatus",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/plugin.ts",
|
||||
"lineNumber": 165
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
"id": "def-server.config",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"UnencryptedStatsGetterConfig",
|
||||
" | ",
|
||||
"EncryptedStatsGetterConfig"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/plugin.ts",
|
||||
"lineNumber": 165
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
|
|
@ -439,7 +789,9 @@
|
|||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
"lineNumber": 24
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -480,7 +832,41 @@
|
|||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
"lineNumber": 28
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
"id": "def-server.optInStatus",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "optInStatus",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/plugin.ts",
|
||||
"lineNumber": 165
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
"id": "def-server.config",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"UnencryptedStatsGetterConfig",
|
||||
" | ",
|
||||
"EncryptedStatsGetterConfig"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_collection_manager/server/plugin.ts",
|
||||
"lineNumber": 165
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "telemetryCollectionManager",
|
||||
|
|
@ -524,7 +910,9 @@
|
|||
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
||||
"lineNumber": 30
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
"label": "ESLicense",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"estypes.LicenseInformation"
|
||||
"LicenseInformation"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
|
||||
|
|
|
|||
|
|
@ -229,7 +229,23 @@
|
|||
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "telemetryManagementSection",
|
||||
"id": "def-public.enabled",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "enabled",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
|
||||
"lineNumber": 38
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
|
|
@ -207,6 +207,25 @@
|
|||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -226,6 +245,25 @@
|
|||
"lineNumber": 11
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -236,15 +274,36 @@
|
|||
"label": "AlertConditions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.LazyExoticComponent<(<ConditionProps extends unknown, ActionGroupIds extends string>({ headline, actionGroups, onInitializeConditionsFor, onResetConditionsFor, includeBuiltInActionGroups, children, }: React.PropsWithChildren<",
|
||||
"React.ExoticComponent<React.PropsWithChildren<",
|
||||
"AlertConditionsProps",
|
||||
"<ConditionProps, ActionGroupIds>>) => JSX.Element)>"
|
||||
"<unknown, string>>> & { readonly _result: <ConditionProps extends unknown, ActionGroupIds extends string>({ headline, actionGroups, onInitializeConditionsFor, onResetConditionsFor, includeBuiltInActionGroups, children, }: React.PropsWithChildren<",
|
||||
"AlertConditionsProps",
|
||||
"<ConditionProps, ActionGroupIds>>) => JSX.Element; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx",
|
||||
"lineNumber": 13
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 359
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -255,15 +314,36 @@
|
|||
"label": "AlertConditionsGroup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.LazyExoticComponent<(<ConditionProps extends unknown>({ actionGroup, onResetConditionsFor, children, ...otherProps }: React.PropsWithChildren<",
|
||||
"React.ExoticComponent<React.PropsWithChildren<",
|
||||
"AlertConditionsGroupProps",
|
||||
"<ConditionProps>>) => JSX.Element | null)>"
|
||||
"<unknown>>> & { readonly _result: <ConditionProps extends unknown>({ actionGroup, onResetConditionsFor, children, ...otherProps }: React.PropsWithChildren<",
|
||||
"AlertConditionsGroupProps",
|
||||
"<ConditionProps>>) => JSX.Element | null; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx",
|
||||
"lineNumber": 14
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 359
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -283,6 +363,25 @@
|
|||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -302,6 +401,25 @@
|
|||
"lineNumber": 11
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -321,6 +439,25 @@
|
|||
"lineNumber": 14
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -340,6 +477,25 @@
|
|||
"lineNumber": 12
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -797,6 +953,25 @@
|
|||
"lineNumber": 11
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -889,6 +1064,25 @@
|
|||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -908,6 +1102,25 @@
|
|||
"lineNumber": 17
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -927,6 +1140,25 @@
|
|||
"lineNumber": 13
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -946,6 +1178,25 @@
|
|||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
|
||||
"lineNumber": 16
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
@ -1296,7 +1547,26 @@
|
|||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 239
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.alertParams",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "alertParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Params"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 239
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -1320,7 +1590,26 @@
|
|||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 240
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 359
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -1449,7 +1738,42 @@
|
|||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 221
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.property",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "property",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Key"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 221
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.value",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "value",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Params[Key] | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 221
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -1459,7 +1783,7 @@
|
|||
"label": "setAlertProperty",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"<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<",
|
||||
"<Prop extends \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">(key: Prop, value: Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -1467,13 +1791,56 @@
|
|||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void"
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 222
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.key",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "key",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Prop"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 223
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.value",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "value",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
"lineNumber": 224
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -1958,7 +2325,27 @@
|
|||
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.crumbs",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "crumbs",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"EuiBreadcrumb",
|
||||
"[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
|
||||
"lineNumber": 40
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -1968,11 +2355,13 @@
|
|||
"label": "actionTypeRegistry",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"TypeRegistry",
|
||||
"<",
|
||||
"{ get: (id: string) => ",
|
||||
"ActionTypeModel",
|
||||
"<unknown, unknown, any>>, \"get\" | \"register\" | \"list\" | \"has\">"
|
||||
"<unknown, unknown, any>; register: (objectType: ",
|
||||
"ActionTypeModel",
|
||||
"<unknown, unknown, any>) => void; list: () => ",
|
||||
"ActionTypeModel",
|
||||
"<unknown, unknown, any>[]; has: (id: string) => boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
|
||||
|
|
@ -1988,9 +2377,7 @@
|
|||
"label": "alertTypeRegistry",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"TypeRegistry",
|
||||
"<",
|
||||
"{ get: (id: string) => ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
|
|
@ -1998,7 +2385,23 @@
|
|||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<Record<string, unknown>>>, \"get\" | \"register\" | \"list\" | \"has\">"
|
||||
"<Record<string, unknown>>; register: (objectType: ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<Record<string, unknown>>) => void; list: () => ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<Record<string, unknown>>[]; has: (id: string) => boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
|
||||
|
|
@ -2092,7 +2495,7 @@
|
|||
"label": "errors",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
|
|
@ -2191,6 +2594,7 @@
|
|||
"label": "ActionGroupWithCondition",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2198,7 +2602,7 @@
|
|||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds> & { conditions?: T | undefined; isRequired?: false | undefined; } | ",
|
||||
"<ActionGroupIds> & { conditions?: T | undefined; isRequired?: false | undefined; }) | (",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2206,7 +2610,7 @@
|
|||
"section": "def-common.ActionGroup",
|
||||
"text": "ActionGroup"
|
||||
},
|
||||
"<ActionGroupIds> & { conditions: T; isRequired: true; }"
|
||||
"<ActionGroupIds> & { conditions: T; isRequired: true; })"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/alert_conditions.tsx",
|
||||
|
|
@ -2223,7 +2627,13 @@
|
|||
"label": "ActionTypeRegistryContract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ get: (id: string) => ActionTypeModel<ActionConnector, ActionParams, any>; register: (objectType: ActionTypeModel<ActionConnector, ActionParams, any>) => void; list: () => ActionTypeModel<ActionConnector, ActionParams, any>[]; has: (id: string) => boolean; }"
|
||||
"{ get: (id: string) => ",
|
||||
"ActionTypeModel",
|
||||
"<ActionConnector, ActionParams, any>; register: (objectType: ",
|
||||
"ActionTypeModel",
|
||||
"<ActionConnector, ActionParams, any>) => void; list: () => ",
|
||||
"ActionTypeModel",
|
||||
"<ActionConnector, ActionParams, any>[]; has: (id: string) => boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
|
|
@ -2257,7 +2667,15 @@
|
|||
"label": "Alert",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ enabled: boolean; id: string; name: string; params: Record<string, unknown>; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: ",
|
||||
"{ enabled: boolean; id: string; name: string; params: Record<string, unknown>; actions: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertAction",
|
||||
"text": "AlertAction"
|
||||
},
|
||||
"[]; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2265,7 +2683,7 @@
|
|||
"section": "def-common.IntervalSchedule",
|
||||
"text": "IntervalSchedule"
|
||||
},
|
||||
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ",
|
||||
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2307,7 +2725,31 @@
|
|||
"label": "AlertTypeRegistryContract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ get: (id: string) => AlertTypeModel<Record<string, unknown>>; register: (objectType: AlertTypeModel<Record<string, unknown>>) => void; list: () => AlertTypeModel<Record<string, unknown>>[]; has: (id: string) => boolean; }"
|
||||
"{ get: (id: string) => ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<Record<string, unknown>>; register: (objectType: ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<Record<string, unknown>>) => void; list: () => ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<Record<string, unknown>>[]; has: (id: string) => boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
||||
|
|
@ -3461,13 +3903,56 @@
|
|||
"ConnectorAddFlyoutProps",
|
||||
", \"onClose\" | \"consumer\" | \"actionTypes\" | \"onTestConnector\" | \"reloadConnectors\">) => React.ReactElement<",
|
||||
"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>)>"
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 49
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ onClose: () => void; consumer?: string | undefined; actionTypes?: ",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "common",
|
||||
"docId": "kibActionsPluginApi",
|
||||
"section": "def-common.ActionType",
|
||||
"text": "ActionType"
|
||||
},
|
||||
"[] | undefined; onTestConnector?: ((connector: ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.ActionConnector",
|
||||
"text": "ActionConnector"
|
||||
},
|
||||
"<Record<string, unknown>, Record<string, unknown>>) => void) | undefined; reloadConnectors?: (() => Promise<void | ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.ActionConnector",
|
||||
"text": "ActionConnector"
|
||||
},
|
||||
"<Record<string, unknown>, Record<string, unknown>>[]>) | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -3481,13 +3966,50 @@
|
|||
"ConnectorEditFlyoutProps",
|
||||
", \"onClose\" | \"consumer\" | \"reloadConnectors\" | \"initialConnector\" | \"tab\">) => React.ReactElement<",
|
||||
"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>)>"
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 52
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ onClose: () => void; consumer?: string | undefined; reloadConnectors?: (() => Promise<void | ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.ActionConnector",
|
||||
"text": "ActionConnector"
|
||||
},
|
||||
"<Record<string, unknown>, Record<string, unknown>>[]>) | undefined; initialConnector: ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.ActionConnector",
|
||||
"text": "ActionConnector"
|
||||
},
|
||||
"<Record<string, unknown>, Record<string, unknown>>; tab?: ",
|
||||
"EditConectorTabs",
|
||||
" | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 53
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -3507,7 +4029,42 @@
|
|||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 55
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ onClose: (reason: ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertFlyoutCloseReason",
|
||||
"text": "AlertFlyoutCloseReason"
|
||||
},
|
||||
") => void; metadata?: Record<string, any> | undefined; onSave?: (() => Promise<void>) | undefined; alertTypeId?: string | undefined; consumer: string; canChangeTrigger?: boolean | undefined; initialValues?: Partial<Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Record<string, unknown>>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">> | undefined; reloadAlerts?: (() => Promise<void>) | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
|
|
@ -3527,7 +4084,42 @@
|
|||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 58
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "triggersActionsUi",
|
||||
"id": "def-public.props",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ onClose: (reason: ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertFlyoutCloseReason",
|
||||
"text": "AlertFlyoutCloseReason"
|
||||
},
|
||||
") => void; metadata?: Record<string, any> | undefined; onSave?: (() => Promise<void>) | undefined; reloadAlerts?: (() => Promise<void>) | undefined; initialAlert: Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<Record<string, unknown>>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
||||
"lineNumber": 59
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
@ -3911,9 +4503,17 @@
|
|||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ timeSeriesQuery: typeof ",
|
||||
"timeSeriesQuery",
|
||||
"; }"
|
||||
"{ timeSeriesQuery: (params: ",
|
||||
"TimeSeriesQueryParameters",
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "common",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-common.TimeSeriesResult",
|
||||
"text": "TimeSeriesResult"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/triggers_actions_ui/server/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -96,7 +96,9 @@
|
|||
"label": "triggers",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"TriggerRegistry"
|
||||
"Map<string, ",
|
||||
"TriggerInternal",
|
||||
"<any>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
|
||||
|
|
@ -112,7 +114,17 @@
|
|||
"label": "actions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ActionRegistry"
|
||||
"Map<string, ",
|
||||
"ActionInternal",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
|
||||
|
|
@ -128,7 +140,7 @@
|
|||
"label": "triggerToActions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"TriggerToActionsRegistry"
|
||||
"Map<string, string[]>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/ui_actions/public/service/ui_actions_service.ts",
|
||||
|
|
@ -2308,7 +2320,14 @@
|
|||
"\nAction methods are executed with Context from trigger + {@link ActionExecutionMeta}"
|
||||
],
|
||||
"signature": [
|
||||
"Context & ActionExecutionMeta"
|
||||
"Context & ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionExecutionMeta",
|
||||
"text": "ActionExecutionMeta"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/ui_actions/public/actions/action.ts",
|
||||
|
|
@ -2325,7 +2344,8 @@
|
|||
"label": "PresentableGrouping",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"PresentableGroup<Context>[]"
|
||||
"PresentableGroup",
|
||||
"<Context>[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/ui_actions/public/util/presentable.ts",
|
||||
|
|
@ -2562,8 +2582,22 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly addTriggerAction: (triggerId: string, action: ",
|
||||
"UiActionsActionDefinition",
|
||||
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A>(definition: A) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(definition: A) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
|
|
@ -2599,9 +2633,31 @@
|
|||
"label": "UiActionsStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly clear: () => void; readonly fork: () => UiActionsService; readonly addTriggerAction: (triggerId: string, action: ",
|
||||
"UiActionsActionDefinition",
|
||||
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A>(definition: A) => ",
|
||||
"{ readonly clear: () => void; readonly fork: () => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.UiActionsService",
|
||||
"text": "UiActionsService"
|
||||
},
|
||||
"; readonly addTriggerAction: (triggerId: string, action: ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(definition: A) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
|
|
@ -2620,7 +2676,42 @@
|
|||
"text": "Trigger"
|
||||
},
|
||||
") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ",
|
||||
"TriggerContract"
|
||||
"TriggerContract",
|
||||
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: <T extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(id: string) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<",
|
||||
"ActionContext",
|
||||
"<T>>; readonly getTriggerActions: (triggerId: string) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<object>[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/ui_actions/public/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -318,7 +318,8 @@
|
|||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
}
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
|
||||
|
|
@ -504,12 +505,13 @@
|
|||
"label": "CollectConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.UiComponent",
|
||||
"text": "UiComponent"
|
||||
"section": "def-common.UiComponentInstance",
|
||||
"text": "UiComponentInstance"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
|
|
@ -525,7 +527,9 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
|
||||
"lineNumber": 55
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -535,7 +539,7 @@
|
|||
"label": "ReactCollectConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.FC<",
|
||||
"React.FunctionComponent<",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "public",
|
||||
|
|
@ -549,7 +553,42 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -565,7 +604,26 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
|
||||
"lineNumber": 57
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Context"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -581,7 +639,42 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
|
||||
"lineNumber": 58
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.config",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Config"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Context"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -591,13 +684,31 @@
|
|||
"label": "migrations",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.MigrateFunctionsObject",
|
||||
"text": "MigrateFunctionsObject"
|
||||
}
|
||||
"section": "def-common.MigrateFunction",
|
||||
"text": "MigrateFunction"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.SerializableState",
|
||||
"text": "SerializableState"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.SerializableState",
|
||||
"text": "SerializableState"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
|
||||
|
|
@ -1094,7 +1205,8 @@
|
|||
"text": "StartContract"
|
||||
},
|
||||
", SetupDependencies, ",
|
||||
"StartDependencies"
|
||||
"StartDependencies",
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/plugin.ts",
|
||||
|
|
@ -2589,7 +2701,8 @@
|
|||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
}
|
||||
},
|
||||
">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
|
||||
|
|
@ -2927,7 +3040,26 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
|
||||
"lineNumber": 70
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Context"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
|
||||
"lineNumber": 22
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -2939,12 +3071,13 @@
|
|||
"\n`UiComponent` that collections config for this drilldown. You can create\na React component and transform it `UiComponent` using `uiToReactComponent`\nhelper from `kibana_utils` plugin.\n\n```tsx\nimport React from 'react';\nimport { uiToReactComponent } from 'src/plugins/kibana_utils';\nimport { CollectConfigProps } from 'src/plugins/kibana_utils/public';\n\ntype Props = CollectConfigProps<Config>;\n\nconst ReactCollectConfig: React.FC<Props> = () => {\n return <div>Collecting config...'</div>;\n};\n\nexport const CollectConfig = uiToReactComponent(ReactCollectConfig);\n```"
|
||||
],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.UiComponent",
|
||||
"text": "UiComponent"
|
||||
"section": "def-common.UiComponentInstance",
|
||||
"text": "UiComponentInstance"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
|
|
@ -2960,7 +3093,9 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
|
||||
"lineNumber": 91
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -2978,7 +3113,42 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
|
||||
"lineNumber": 97
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.config",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Config"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Context"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
|
||||
"lineNumber": 27
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -3014,7 +3184,9 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
|
||||
"lineNumber": 108
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
|
|
@ -3425,15 +3597,49 @@
|
|||
"label": "uiActions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"{ readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.ActionDefinition",
|
||||
"text": "ActionDefinition"
|
||||
},
|
||||
"<object>>(definition: A) => ",
|
||||
{
|
||||
"pluginId": "uiActions",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsPluginApi",
|
||||
"section": "def-public.Action",
|
||||
"text": "Action"
|
||||
},
|
||||
"<",
|
||||
"ActionContext",
|
||||
"<A>>; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly getActionFactory: (actionFactoryId: string) => ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-public.StartContract",
|
||||
"text": "StartContract"
|
||||
"section": "def-public.ActionFactory",
|
||||
"text": "ActionFactory"
|
||||
},
|
||||
", \"attachAction\" | \"detachAction\" | \"registerAction\" | \"unregisterAction\" | \"hasAction\" | \"getActionFactory\" | \"hasActionFactory\">"
|
||||
"<",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.SerializableState",
|
||||
"text": "SerializableState"
|
||||
},
|
||||
", object, ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "public",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-public.BaseActionFactoryContext",
|
||||
"text": "BaseActionFactoryContext"
|
||||
},
|
||||
">; readonly hasActionFactory: (actionFactoryId: string) => boolean; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
|
||||
|
|
@ -3455,7 +3661,26 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"C"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -3615,7 +3840,15 @@
|
|||
"label": "DynamicActionsState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ events: SerializedEvent[]; }"
|
||||
"{ events: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/common/types.ts",
|
||||
|
|
@ -3651,7 +3884,23 @@
|
|||
"\nSerialized representation of a triggers-action pair, used to persist in storage."
|
||||
],
|
||||
"signature": [
|
||||
"{ eventId: string; triggers: string[]; action: SerializedAction; }"
|
||||
"{ eventId: string; triggers: string[]; action: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedAction",
|
||||
"text": "SerializedAction"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.SerializableState",
|
||||
"text": "SerializableState"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/common/types.ts",
|
||||
|
|
@ -3668,7 +3917,7 @@
|
|||
"label": "UrlDrilldownConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ url: { format?: 'handlebars_v1'; template: string;}; openInNewTab: boolean; encodeUrl?: boolean | undefined; }"
|
||||
"{ url: { format?: \"handlebars_v1\" | undefined; template: string; }; openInNewTab: boolean; encodeUrl?: boolean | undefined; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
|
||||
|
|
@ -3749,7 +3998,8 @@
|
|||
"text": "UiActionsService"
|
||||
},
|
||||
">>,Pick<",
|
||||
"UiActionsServiceEnhancements"
|
||||
"UiActionsServiceEnhancements",
|
||||
", \"telemetry\" | \"extract\" | \"inject\" | \"getActionFactory\" | \"hasActionFactory\" | \"getActionFactories\">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/public/plugin.ts",
|
||||
|
|
@ -3765,7 +4015,7 @@
|
|||
"label": "DrilldownManager",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.FC<",
|
||||
"React.FunctionComponent<",
|
||||
"PublicDrilldownManagerProps",
|
||||
">"
|
||||
],
|
||||
|
|
@ -3773,7 +4023,42 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/public/plugin.ts",
|
||||
"lineNumber": 60
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"lineNumber": 554
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
@ -3829,7 +4114,23 @@
|
|||
"label": "actionFactories",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ActionFactoryRegistry"
|
||||
"Map<string, ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "server",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-server.ActionFactory",
|
||||
"text": "ActionFactory"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
},
|
||||
">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/server/plugin.ts",
|
||||
|
|
@ -4180,7 +4481,15 @@
|
|||
"label": "DynamicActionsState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ events: SerializedEvent[]; }"
|
||||
"{ events: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/common/types.ts",
|
||||
|
|
@ -4216,7 +4525,23 @@
|
|||
"\nSerialized representation of a triggers-action pair, used to persist in storage."
|
||||
],
|
||||
"signature": [
|
||||
"{ eventId: string; triggers: string[]; action: SerializedAction; }"
|
||||
"{ eventId: string; triggers: string[]; action: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedAction",
|
||||
"text": "SerializedAction"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.SerializableState",
|
||||
"text": "SerializableState"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/common/types.ts",
|
||||
|
|
@ -4270,7 +4595,41 @@
|
|||
"path": "x-pack/plugins/ui_actions_enhanced/server/plugin.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uiActionsEnhanced",
|
||||
"id": "def-server.definition",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "definition",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "server",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-server.ActionFactoryDefinition",
|
||||
"text": "ActionFactoryDefinition"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/server/plugin.ts",
|
||||
"lineNumber": 15
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -4334,7 +4693,15 @@
|
|||
"label": "DynamicActionsState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ events: SerializedEvent[]; }"
|
||||
"{ events: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedEvent",
|
||||
"text": "SerializedEvent"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/common/types.ts",
|
||||
|
|
@ -4370,7 +4737,23 @@
|
|||
"\nSerialized representation of a triggers-action pair, used to persist in storage."
|
||||
],
|
||||
"signature": [
|
||||
"{ eventId: string; triggers: string[]; action: SerializedAction; }"
|
||||
"{ eventId: string; triggers: string[]; action: ",
|
||||
{
|
||||
"pluginId": "uiActionsEnhanced",
|
||||
"scope": "common",
|
||||
"docId": "kibUiActionsEnhancedPluginApi",
|
||||
"section": "def-common.SerializedAction",
|
||||
"text": "SerializedAction"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.SerializableState",
|
||||
"text": "SerializableState"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/ui_actions_enhanced/common/types.ts",
|
||||
|
|
|
|||
|
|
@ -111,7 +111,26 @@
|
|||
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "uptime",
|
||||
"id": "def-server.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"KibanaRouteOptions"
|
||||
],
|
||||
"source": {
|
||||
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
|
||||
"lineNumber": 25
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -252,7 +252,23 @@
|
|||
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "urlForwarding",
|
||||
"id": "def-public.legacyPath",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "legacyPath",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
||||
"lineNumber": 19
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -285,7 +301,15 @@
|
|||
"label": "UrlForwardingStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ForwardDefinition[]; }"
|
||||
"{ navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
|
||||
{
|
||||
"pluginId": "urlForwarding",
|
||||
"scope": "public",
|
||||
"docId": "kibUrlForwardingPluginApi",
|
||||
"section": "def-public.ForwardDefinition",
|
||||
"text": "ForwardDefinition"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@
|
|||
"\nThe React component to be tracked."
|
||||
],
|
||||
"signature": [
|
||||
"React.ReactNode"
|
||||
"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 | null | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/components/track_application_view/types.ts",
|
||||
|
|
@ -168,7 +168,76 @@
|
|||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 75
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.appName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "appName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 76
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.type",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"METRIC_TYPE",
|
||||
".COUNT | ",
|
||||
"METRIC_TYPE",
|
||||
".LOADED | ",
|
||||
"METRIC_TYPE",
|
||||
".CLICK"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 77
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.eventNames",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "eventNames",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | string[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 78
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.count",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "count",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 79
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
@ -207,7 +276,76 @@
|
|||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 86
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.appName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "appName",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 87
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.type",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"METRIC_TYPE",
|
||||
".COUNT | ",
|
||||
"METRIC_TYPE",
|
||||
".LOADED | ",
|
||||
"METRIC_TYPE",
|
||||
".CLICK"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 88
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.eventNames",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "eventNames",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | string[]"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 89
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-public.count",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "count",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
||||
"lineNumber": 90
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
@ -271,14 +409,12 @@
|
|||
"\nThe options to extend the context provided to the `fetch` method: {@link CollectorOptionsFetchExtendedContext}."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptionsFetchExtendedContext",
|
||||
"text": "CollectorOptionsFetchExtendedContext"
|
||||
},
|
||||
"<boolean>"
|
||||
"ICollectorOptionsFetchExtendedContext",
|
||||
"<boolean> | (",
|
||||
"ICollectorOptionsFetchExtendedContext",
|
||||
"<boolean> & Required<Pick<",
|
||||
"ICollectorOptionsFetchExtendedContext",
|
||||
"<true>, \"kibanaRequest\">>)"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
|
|
@ -311,20 +447,72 @@
|
|||
"\nThe actual logic that reports the Usage collection.\nIt will be called on every collection request.\nWhatever is returned in this method will be passed through as-is under\nthe {@link ICollector.type} key.\n"
|
||||
],
|
||||
"signature": [
|
||||
"(this: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorFetchMethod",
|
||||
"text": "CollectorFetchMethod"
|
||||
"section": "def-server.ICollector",
|
||||
"text": "ICollector"
|
||||
},
|
||||
"<boolean, TFetchReturn, ExtraOptions>"
|
||||
"<TFetchReturn, {}> & ExtraOptions, context: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorFetchContext",
|
||||
"text": "CollectorFetchContext"
|
||||
},
|
||||
"<boolean>) => TFetchReturn | Promise<TFetchReturn>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
"lineNumber": 192
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.context",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ esClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.ElasticsearchClient",
|
||||
"text": "ElasticsearchClient"
|
||||
},
|
||||
"; soClient: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; } & (WithKibanaRequest extends true ? { kibanaRequest?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any> | undefined; } : {})"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
"lineNumber": 110
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
|
|
@ -342,7 +530,9 @@
|
|||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
"lineNumber": 196
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -455,7 +645,32 @@
|
|||
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.IncrementCounterParams",
|
||||
"text": "IncrementCounterParams"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
||||
"lineNumber": 45
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -581,7 +796,31 @@
|
|||
"\nThe context for the `fetch` method: It includes the most commonly used clients in the collectors (ES and SO clients).\nBoth are scoped based on the request and the context:\n- When users are requesting a sample of data, it is scoped to their role to avoid exposing data they shouldn't read\n- When building the telemetry data payload to report to the remote cluster, the requests are scoped to the `kibana` internal user\n"
|
||||
],
|
||||
"signature": [
|
||||
"{ esClient: ElasticsearchClient; soClient: SavedObjectsClientContract; } & (WithKibanaRequest extends true ? { kibanaRequest?: KibanaRequest<unknown, unknown, unknown, any> | undefined; } : {})"
|
||||
"{ esClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.ElasticsearchClient",
|
||||
"text": "ElasticsearchClient"
|
||||
},
|
||||
"; soClient: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClient",
|
||||
"text": "SavedObjectsClient"
|
||||
},
|
||||
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; } & (WithKibanaRequest extends true ? { kibanaRequest?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any> | undefined; } : {})"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
|
|
@ -600,7 +839,15 @@
|
|||
"\nThe fetch method has the context of the Collector itself\n(this has access to all the properties of the collector like the logger)\nand the the first parameter is {@link CollectorFetchContext}."
|
||||
],
|
||||
"signature": [
|
||||
"(context: ",
|
||||
"(this: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.ICollector",
|
||||
"text": "ICollector"
|
||||
},
|
||||
"<TReturn, {}> & ExtraOptions, context: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
|
|
@ -627,7 +874,39 @@
|
|||
"\nOptions to instantiate a collector"
|
||||
],
|
||||
"signature": [
|
||||
"{ type: string; isReady: () => Promise<boolean> | boolean; schema?: MakeSchemaFrom<TFetchReturn> | undefined; fetch: CollectorFetchMethod<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: CollectorOptionsFetchExtendedContext<WithKibanaRequest>; } : { extendFetchContext?: CollectorOptionsFetchExtendedContext<WithKibanaRequest> | undefined; })"
|
||||
"{ type: string; isReady: () => boolean | Promise<boolean>; schema?: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.MakeSchemaFrom",
|
||||
"text": "MakeSchemaFrom"
|
||||
},
|
||||
"<TFetchReturn> | undefined; fetch: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorFetchMethod",
|
||||
"text": "CollectorFetchMethod"
|
||||
},
|
||||
"<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptionsFetchExtendedContext",
|
||||
"text": "CollectorOptionsFetchExtendedContext"
|
||||
},
|
||||
"<WithKibanaRequest>; } : { extendFetchContext?: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptionsFetchExtendedContext",
|
||||
"text": "CollectorOptionsFetchExtendedContext"
|
||||
},
|
||||
"<WithKibanaRequest> | undefined; })"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
|
|
@ -646,7 +925,10 @@
|
|||
"\nThe options to extend the context provided to the `fetch` method."
|
||||
],
|
||||
"signature": [
|
||||
"ICollectorOptionsFetchExtendedContext<WithKibanaRequest> & (WithKibanaRequest extends true ? Required<Pick<ICollectorOptionsFetchExtendedContext<WithKibanaRequest>, \"kibanaRequest\">> : {})"
|
||||
"ICollectorOptionsFetchExtendedContext",
|
||||
"<WithKibanaRequest> & (WithKibanaRequest extends true ? Required<Pick<",
|
||||
"ICollectorOptionsFetchExtendedContext",
|
||||
"<WithKibanaRequest>, \"kibanaRequest\">> : {})"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
|
|
@ -665,7 +947,11 @@
|
|||
"\nThe `schema` property in {@link CollectorOptions} must match the output of\nthe `fetch` method. This type helps ensure that is correct"
|
||||
],
|
||||
"signature": [
|
||||
"{ [Key in keyof Required<Base>]: Required<Base>[Key] extends (infer U)[] ? { type: 'array'; items: RecursiveMakeSchemaFrom<U>; } : RecursiveMakeSchemaFrom<Required<Base>[Key]>; }"
|
||||
"{ [Key in keyof Required<Base>]: Required<Base>[Key] extends (infer U)[] ? { type: \"array\"; items: ",
|
||||
"RecursiveMakeSchemaFrom",
|
||||
"<U>; } : ",
|
||||
"RecursiveMakeSchemaFrom",
|
||||
"<Required<Base>[Key]>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
||||
|
|
@ -735,7 +1021,15 @@
|
|||
"section": "def-server.CollectorOptionsFetchExtendedContext",
|
||||
"text": "CollectorOptionsFetchExtendedContext"
|
||||
},
|
||||
"<WithKibanaRequest> | undefined; }) & Required<Pick<CollectorOptions<TFetchReturn, boolean, {}>, \"schema\">>"
|
||||
"<WithKibanaRequest> | undefined; }) & Required<Pick<",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptions",
|
||||
"text": "CollectorOptions"
|
||||
},
|
||||
"<TFetchReturn, boolean, {}>, \"schema\">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/collector/usage_collector.ts",
|
||||
|
|
@ -754,7 +1048,16 @@
|
|||
"\nThe structure of the SavedObjects of type \"usage-counters\""
|
||||
],
|
||||
"signature": [
|
||||
"SavedObject<UsageCountersSavedObjectAttributes>"
|
||||
"SavedObject",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.UsageCountersSavedObjectAttributes",
|
||||
"text": "UsageCountersSavedObjectAttributes"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
||||
|
|
@ -803,7 +1106,23 @@
|
|||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 33
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
|
|
@ -829,7 +1148,23 @@
|
|||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 37
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
|
|
@ -863,7 +1198,66 @@
|
|||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.options",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ type: string; isReady: () => boolean | Promise<boolean>; schema?: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.MakeSchemaFrom",
|
||||
"text": "MakeSchemaFrom"
|
||||
},
|
||||
"<TFetchReturn> | undefined; fetch: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorFetchMethod",
|
||||
"text": "CollectorFetchMethod"
|
||||
},
|
||||
"<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptionsFetchExtendedContext",
|
||||
"text": "CollectorOptionsFetchExtendedContext"
|
||||
},
|
||||
"<WithKibanaRequest>; } : { extendFetchContext?: ",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptionsFetchExtendedContext",
|
||||
"text": "CollectorOptionsFetchExtendedContext"
|
||||
},
|
||||
"<WithKibanaRequest> | undefined; }) & Required<Pick<",
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.CollectorOptions",
|
||||
"text": "CollectorOptions"
|
||||
},
|
||||
"<TFetchReturn, boolean, {}>, \"schema\">>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 47
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
|
|
@ -889,7 +1283,33 @@
|
|||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 53
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.collector",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "collector",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "usageCollection",
|
||||
"scope": "server",
|
||||
"docId": "kibUsageCollectionPluginApi",
|
||||
"section": "def-server.ICollector",
|
||||
"text": "ICollector"
|
||||
},
|
||||
"<TFetchReturn, ExtraOptions>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 54
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
|
|
@ -915,7 +1335,23 @@
|
|||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 59
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "usageCollection",
|
||||
"id": "def-server.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/usage_collection/server/plugin.ts",
|
||||
"lineNumber": 60
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
|
|
@ -155,7 +155,65 @@
|
|||
"path": "src/plugins/vis_type_timeseries/server/plugin.ts",
|
||||
"lineNumber": 55
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visTypeTimeseries",
|
||||
"id": "def-server.requestContext",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "requestContext",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DataRequestHandlerContext"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/vis_type_timeseries/server/plugin.ts",
|
||||
"lineNumber": 56
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visTypeTimeseries",
|
||||
"id": "def-server.fakeRequest",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "fakeRequest",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/vis_type_timeseries/server/plugin.ts",
|
||||
"lineNumber": 57
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visTypeTimeseries",
|
||||
"id": "def-server.options",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/vis_type_timeseries/server/plugin.ts",
|
||||
"lineNumber": 59
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
|||
|
|
@ -377,20 +377,93 @@
|
|||
"label": "toExpressionAst",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(vis: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisToExpressionAst",
|
||||
"text": "VisToExpressionAst"
|
||||
"section": "def-public.Vis",
|
||||
"text": "Vis"
|
||||
},
|
||||
"<TVisParams>"
|
||||
"<TVisParams>, params: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisToExpressionAstParams",
|
||||
"text": "VisToExpressionAstParams"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionAstExpression",
|
||||
"text": "ExpressionAstExpression"
|
||||
},
|
||||
" | Promise<",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionAstExpression",
|
||||
"text": "ExpressionAstExpression"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
||||
"lineNumber": 44
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.vis",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "vis",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.Vis",
|
||||
"text": "Vis"
|
||||
},
|
||||
"<TVisParams>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisToExpressionAstParams",
|
||||
"text": "VisToExpressionAstParams"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
|
|
@ -501,8 +574,7 @@
|
|||
"section": "def-public.PersistedState",
|
||||
"text": "PersistedState"
|
||||
},
|
||||
" extends ",
|
||||
"EventEmitter"
|
||||
" extends EventEmitter"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
||||
|
|
@ -1808,8 +1880,7 @@
|
|||
"label": "group",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"node_modules/utility-types/dist/utility-types",
|
||||
"$Values<Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>>"
|
||||
"\"buckets\" | \"metrics\" | \"none\""
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
||||
|
|
@ -1980,7 +2051,7 @@
|
|||
"label": "tooltip",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ReactNode"
|
||||
"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 | null | undefined"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
||||
|
|
@ -2806,9 +2877,137 @@
|
|||
"label": "timefilter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"Timefilter",
|
||||
", \"isTimeRangeSelectorEnabled\" | \"isAutoRefreshSelectorEnabled\" | \"isTimeTouched\" | \"getEnabledUpdated$\" | \"getTimeUpdate$\" | \"getRefreshIntervalUpdate$\" | \"getAutoRefreshFetch$\" | \"getFetch$\" | \"getTime\" | \"getAbsoluteTime\" | \"setTime\" | \"getRefreshInterval\" | \"setRefreshInterval\" | \"createFilter\" | \"getBounds\" | \"calculateBounds\" | \"getActiveBounds\" | \"enableTimeRangeSelector\" | \"disableTimeRangeSelector\" | \"enableAutoRefreshSelector\" | \"disableAutoRefreshSelector\" | \"getTimeDefaults\" | \"getRefreshIntervalDefaults\">"
|
||||
"{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ",
|
||||
"Observable",
|
||||
"<boolean>; getTimeUpdate$: () => ",
|
||||
"Observable",
|
||||
"<unknown>; getRefreshIntervalUpdate$: () => ",
|
||||
"Observable",
|
||||
"<unknown>; getAutoRefreshFetch$: () => ",
|
||||
"Observable",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.AutoRefreshDoneFn",
|
||||
"text": "AutoRefreshDoneFn"
|
||||
},
|
||||
">; getFetch$: () => ",
|
||||
"Observable",
|
||||
"<unknown>; getTime: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"; getAbsoluteTime: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"; setTime: (time: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-public.InputTimeRange",
|
||||
"text": "InputTimeRange"
|
||||
},
|
||||
") => void; getRefreshInterval: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
"; setRefreshInterval: (refreshInterval: Partial<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
">) => void; createFilter: (indexPattern: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
},
|
||||
", timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataPluginApi",
|
||||
"section": "def-common.RangeFilter",
|
||||
"text": "RangeFilter"
|
||||
},
|
||||
" | undefined; getBounds: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRangeBounds",
|
||||
"text": "TimeRangeBounds"
|
||||
},
|
||||
"; calculateBounds: (timeRange: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRangeBounds",
|
||||
"text": "TimeRangeBounds"
|
||||
},
|
||||
"; getActiveBounds: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRangeBounds",
|
||||
"text": "TimeRangeBounds"
|
||||
},
|
||||
" | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
"; getRefreshIntervalDefaults: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
|
|
@ -3404,20 +3603,93 @@
|
|||
"\nShould be provided to expand base visualization expression with\ncustom exprsesion chain, including render expression.\nExplicit renderer should be registered in expressions plugin to render your visualization."
|
||||
],
|
||||
"signature": [
|
||||
"(vis: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisToExpressionAst",
|
||||
"text": "VisToExpressionAst"
|
||||
"section": "def-public.Vis",
|
||||
"text": "Vis"
|
||||
},
|
||||
"<TVisParams>"
|
||||
"<TVisParams>, params: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisToExpressionAstParams",
|
||||
"text": "VisToExpressionAstParams"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionAstExpression",
|
||||
"text": "ExpressionAstExpression"
|
||||
},
|
||||
" | Promise<",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionAstExpression",
|
||||
"text": "ExpressionAstExpression"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
||||
"lineNumber": 148
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.vis",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "vis",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.Vis",
|
||||
"text": "Vis"
|
||||
},
|
||||
"<TVisParams>"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"lineNumber": 50
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisToExpressionAstParams",
|
||||
"text": "VisToExpressionAstParams"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
|
|
@ -3513,7 +3785,7 @@
|
|||
"\nHave the \"defaults\" prop with default params for a visualization.\nTODO: ideally should have next type: { defaults: TVisParams } , but currently\nhave incosistencies in legacy visLib visualizations"
|
||||
],
|
||||
"signature": [
|
||||
"Record<string, any>"
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
||||
|
|
@ -3905,7 +4177,15 @@
|
|||
"label": "ExpressionValueVisDimension",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ type: \"vis_dimension\"; } & { accessor: number | DatatableColumn; format: { id?: string; params: Record<string, any>;}; }"
|
||||
"{ type: \"vis_dimension\"; } & { accessor: number | ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.DatatableColumn",
|
||||
"text": "DatatableColumn"
|
||||
},
|
||||
"; format: { id?: string | undefined; params: Record<string, any>; }; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/expression_functions/vis_dimension.ts",
|
||||
|
|
@ -4061,7 +4341,146 @@
|
|||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.OverlayRef",
|
||||
"text": "OverlayRef"
|
||||
}
|
||||
},
|
||||
" | undefined; transferCustomizationsToUiState: () => void; hasInspector: () => boolean; onContainerLoading: () => void; onContainerRender: () => void; onContainerError: (error: ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "public",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-public.ExpressionRenderError",
|
||||
"text": "ExpressionRenderError"
|
||||
},
|
||||
") => void; reload: () => Promise<void>; supportedTriggers: () => string[]; inputIsRefType: (input: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
") => input is ",
|
||||
"VisualizeByReferenceInput",
|
||||
"; getInputAsValueType: () => Promise<",
|
||||
"VisualizeByValueInput",
|
||||
">; getInputAsRefType: () => Promise<",
|
||||
"VisualizeByReferenceInput",
|
||||
">; readonly runtimeId: number; readonly isContainer: boolean; fatalError?: Error | undefined; getIsContainer: () => this is ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IContainer",
|
||||
"text": "IContainer"
|
||||
},
|
||||
"<{}, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerInput",
|
||||
"text": "ContainerInput"
|
||||
},
|
||||
"<{}>, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerOutput",
|
||||
"text": "ContainerOutput"
|
||||
},
|
||||
">; getUpdated$: () => Readonly<",
|
||||
"Observable",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
" | ",
|
||||
"VisualizeOutput",
|
||||
">>; getInput$: () => Readonly<",
|
||||
"Observable",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
">>; getOutput$: () => Readonly<",
|
||||
"Observable",
|
||||
"<",
|
||||
"VisualizeOutput",
|
||||
">>; getOutput: () => Readonly<",
|
||||
"VisualizeOutput",
|
||||
">; getInput: () => Readonly<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
">; getTitle: () => string; getRoot: () => ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IEmbeddable",
|
||||
"text": "IEmbeddable"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableInput",
|
||||
"text": "EmbeddableInput"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableOutput",
|
||||
"text": "EmbeddableOutput"
|
||||
},
|
||||
"> | ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IContainer",
|
||||
"text": "IContainer"
|
||||
},
|
||||
"<{}, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerInput",
|
||||
"text": "ContainerInput"
|
||||
},
|
||||
"<{}>, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerOutput",
|
||||
"text": "ContainerOutput"
|
||||
},
|
||||
">; updateInput: (changes: Partial<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
">) => void; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/index.ts",
|
||||
|
|
@ -4117,7 +4536,124 @@
|
|||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerInput",
|
||||
"text": "ContainerInput"
|
||||
}
|
||||
},
|
||||
"<{}>, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerOutput",
|
||||
"text": "ContainerOutput"
|
||||
},
|
||||
"> | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ErrorEmbeddable",
|
||||
"text": "ErrorEmbeddable"
|
||||
},
|
||||
" | ",
|
||||
"VisualizeEmbeddable",
|
||||
" | ",
|
||||
"DisabledLabEmbeddable",
|
||||
" | undefined>; isEditable: () => Promise<boolean>; getDisplayName: () => string; createFromSavedObject: (savedObjectId: string, input: Partial<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
"> & { id: string; }, parent?: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IContainer",
|
||||
"text": "IContainer"
|
||||
},
|
||||
"<{}, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerInput",
|
||||
"text": "ContainerInput"
|
||||
},
|
||||
"<{}>, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerOutput",
|
||||
"text": "ContainerOutput"
|
||||
},
|
||||
"> | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ErrorEmbeddable",
|
||||
"text": "ErrorEmbeddable"
|
||||
},
|
||||
" | ",
|
||||
"VisualizeEmbeddable",
|
||||
" | ",
|
||||
"DisabledLabEmbeddable",
|
||||
">; readonly savedObjectMetaData: ",
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectMetaData",
|
||||
"text": "SavedObjectMetaData"
|
||||
},
|
||||
"<VisualizationAttributes>; extract: (_state: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableStateWithType",
|
||||
"text": "EmbeddableStateWithType"
|
||||
},
|
||||
") => { state: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableStateWithType",
|
||||
"text": "EmbeddableStateWithType"
|
||||
},
|
||||
"; references: ",
|
||||
"SavedObjectReference",
|
||||
"[]; }; inject: (_state: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableStateWithType",
|
||||
"text": "EmbeddableStateWithType"
|
||||
},
|
||||
", references: ",
|
||||
"SavedObjectReference",
|
||||
"[]) => ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableStateWithType",
|
||||
"text": "EmbeddableStateWithType"
|
||||
},
|
||||
"; getCurrentAppId: () => Promise<string | undefined>; checkTitle: (props: ",
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.OnSaveProps",
|
||||
"text": "OnSaveProps"
|
||||
},
|
||||
") => Promise<true>; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/index.ts",
|
||||
|
|
@ -4291,7 +4827,24 @@
|
|||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisTypeAlias",
|
||||
"text": "VisTypeAlias"
|
||||
}
|
||||
},
|
||||
"[]; unRegisterAlias: (visTypeAliasName: string) => void; getByGroup: (group: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisGroups",
|
||||
"text": "VisGroups"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.BaseVisType",
|
||||
"text": "BaseVisType"
|
||||
},
|
||||
"<any>[]; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
|
|
@ -4370,7 +4923,54 @@
|
|||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"lineNumber": 80
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.visType",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "visType",
|
||||
"description": [],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"lineNumber": 80
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.visState",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "visState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.SerializedVis",
|
||||
"text": "SerializedVis"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.VisParams",
|
||||
"text": "VisParams"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"lineNumber": 80
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
|
|
@ -4410,7 +5010,32 @@
|
|||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"lineNumber": 81
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.savedVis",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "savedVis",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.ISavedVis",
|
||||
"text": "ISavedVis"
|
||||
}
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts",
|
||||
"lineNumber": 31
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
|
|
@ -4449,7 +5074,41 @@
|
|||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"lineNumber": 82
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.vis",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "vis",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.SerializedVis",
|
||||
"text": "SerializedVis"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.VisParams",
|
||||
"text": "VisParams"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts",
|
||||
"lineNumber": 51
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
|
|
@ -4459,14 +5118,34 @@
|
|||
"label": "showNewVisModal",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"showNewVisModal"
|
||||
"({ editorParams, onClose, originatingApp, outsideVisualizeApp, showAggsSelection, selectedVisType, }?: ",
|
||||
"ShowNewVisModalParams",
|
||||
") => () => void"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"lineNumber": 83
|
||||
},
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.__0",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ShowNewVisModalParams"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/wizard/show_new_vis.tsx",
|
||||
"lineNumber": 42
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
|
|
@ -4509,7 +5188,58 @@
|
|||
"text": "SavedObjectLoader"
|
||||
},
|
||||
" & { findListItems: (search: string, sizeOrOptions?: number | ",
|
||||
"FindListItemsOptions"
|
||||
"FindListItemsOptions",
|
||||
" | undefined) => any; }) | undefined, attributeService?: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.AttributeService",
|
||||
"text": "AttributeService"
|
||||
},
|
||||
"<",
|
||||
"VisualizeSavedObjectAttributes",
|
||||
", ",
|
||||
"VisualizeByValueInput",
|
||||
", ",
|
||||
"VisualizeByReferenceInput",
|
||||
"> | undefined, parent?: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IContainer",
|
||||
"text": "IContainer"
|
||||
},
|
||||
"<{}, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerInput",
|
||||
"text": "ContainerInput"
|
||||
},
|
||||
"<{}>, ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ContainerOutput",
|
||||
"text": "ContainerOutput"
|
||||
},
|
||||
"> | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ErrorEmbeddable",
|
||||
"text": "ErrorEmbeddable"
|
||||
},
|
||||
" | ",
|
||||
"VisualizeEmbeddable",
|
||||
" | ",
|
||||
"DisabledLabEmbeddable",
|
||||
">; }"
|
||||
],
|
||||
"source": {
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
|
|
|
|||
|
|
@ -118,3 +118,35 @@ it('Function inside interface has a label', () => {
|
|||
expect(fn?.label).toBe('aFn');
|
||||
expect(fn?.type).toBe(TypeKind.FunctionKind);
|
||||
});
|
||||
|
||||
it('Test ReactElement signature', () => {
|
||||
const node = nodes.find((n) => getNodeName(n) === 'AReactElementFn');
|
||||
expect(node).toBeDefined();
|
||||
const def = buildApiDeclaration({
|
||||
node: node!,
|
||||
plugins,
|
||||
log,
|
||||
currentPluginId: plugins[0].manifest.id,
|
||||
scope: ApiScope.CLIENT,
|
||||
captureReferences: false,
|
||||
});
|
||||
expect(def.signature).toBeDefined();
|
||||
expect(def.signature!.length).toBe(3);
|
||||
// There is a terrible hack to achieve this, but without it, ReactElement<Props> expands to include the second default generic type
|
||||
// (ReactElement<Props, string | (any) crazy code here with lots of anys that comes from react types >) and
|
||||
// it looks awful.
|
||||
expect(def.signature![2]).toBe('>');
|
||||
expect(def.signature!).toMatchInlineSnapshot(`
|
||||
Array [
|
||||
"() => React.ReactElement<",
|
||||
Object {
|
||||
"docId": "kibPluginAPluginApi",
|
||||
"pluginId": "pluginA",
|
||||
"scope": "public",
|
||||
"section": "def-public.MyProps",
|
||||
"text": "MyProps",
|
||||
},
|
||||
">",
|
||||
]
|
||||
`);
|
||||
});
|
||||
|
|
|
|||
|
|
@ -0,0 +1,66 @@
|
|||
/*
|
||||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
||||
* or more contributor license agreements. Licensed under the Elastic License
|
||||
* 2.0 and the Server Side Public License, v 1; you may not use this file except
|
||||
* in compliance with, at your election, the Elastic License 2.0 or the Server
|
||||
* Side Public License, v 1.
|
||||
*/
|
||||
|
||||
import { KibanaPlatformPlugin, ToolingLog } from '@kbn/dev-utils';
|
||||
import { Node, Signature } from 'ts-morph';
|
||||
import { AnchorLink, ApiDeclaration } from '../types';
|
||||
import { buildApiDeclaration } from './build_api_declaration';
|
||||
import { buildBasicApiDeclaration } from './build_basic_api_declaration';
|
||||
import { getJSDocParamComment, getJSDocReturnTagComment } from './js_doc_utils';
|
||||
|
||||
export function buildCallSignatureDec({
|
||||
signature,
|
||||
node,
|
||||
plugins,
|
||||
captureReferences,
|
||||
currentPluginId,
|
||||
anchorLink,
|
||||
log,
|
||||
name,
|
||||
}: {
|
||||
signature: Signature;
|
||||
name: string;
|
||||
plugins: KibanaPlatformPlugin[];
|
||||
anchorLink: AnchorLink;
|
||||
log: ToolingLog;
|
||||
captureReferences: boolean;
|
||||
currentPluginId: string;
|
||||
node: Node;
|
||||
}) {
|
||||
return {
|
||||
...buildBasicApiDeclaration({
|
||||
node,
|
||||
plugins,
|
||||
anchorLink,
|
||||
apiName: name,
|
||||
currentPluginId,
|
||||
captureReferences,
|
||||
log,
|
||||
}),
|
||||
returnComment: getJSDocReturnTagComment(node),
|
||||
children: signature.getParameters().reduce((kids, p) => {
|
||||
if (p.getDeclarations().length === 1) {
|
||||
kids.push({
|
||||
...buildApiDeclaration({
|
||||
node: p.getDeclarations()[0],
|
||||
log,
|
||||
captureReferences,
|
||||
plugins,
|
||||
scope: anchorLink.scope,
|
||||
name: p.getName(),
|
||||
currentPluginId,
|
||||
}),
|
||||
description: getJSDocParamComment(node, p.getName()),
|
||||
});
|
||||
} else {
|
||||
log.warning(`Losing information on parameter ${p.getName()}`);
|
||||
}
|
||||
return kids;
|
||||
}, [] as ApiDeclaration[]),
|
||||
};
|
||||
}
|
||||
|
|
@ -20,6 +20,7 @@ import { AnchorLink, ApiDeclaration, TypeKind } from '../types';
|
|||
import { getArrowFunctionDec } from './build_arrow_fn_dec';
|
||||
import { buildApiDeclaration } from './build_api_declaration';
|
||||
import { buildBasicApiDeclaration } from './build_basic_api_declaration';
|
||||
import { buildCallSignatureDec } from './build_call_signature_dec';
|
||||
|
||||
/**
|
||||
* Special handling for objects and arrow functions which are variable or property node types.
|
||||
|
|
@ -45,8 +46,9 @@ export function buildVariableDec(
|
|||
captureReferences: boolean
|
||||
): ApiDeclaration {
|
||||
const initializer = node.getInitializer();
|
||||
// Recursively list object properties as children.
|
||||
|
||||
if (initializer && Node.isObjectLiteralExpression(initializer)) {
|
||||
// Recursively list object properties as children.
|
||||
return {
|
||||
...buildBasicApiDeclaration({
|
||||
node,
|
||||
|
|
@ -88,6 +90,23 @@ export function buildVariableDec(
|
|||
);
|
||||
}
|
||||
|
||||
if (node.getType().getCallSignatures().length > 0) {
|
||||
if (node.getType().getCallSignatures().length > 1) {
|
||||
log.warning(`Not handling more than one call signature for node ${node.getName()}`);
|
||||
} else {
|
||||
return buildCallSignatureDec({
|
||||
signature: node.getType().getCallSignatures()[0],
|
||||
log,
|
||||
captureReferences,
|
||||
plugins,
|
||||
anchorLink,
|
||||
currentPluginId,
|
||||
name: node.getName(),
|
||||
node,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return buildBasicApiDeclaration({
|
||||
currentPluginId,
|
||||
anchorLink,
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue