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

Add support for building a deprecation list with usage (#99154)

Browse source 
* Add support for building a deprecation list with usage

* Update API docs
This commit is contained in:
Stacey Gammon 2021-05-06 15:29:47 -04:00 • committed by GitHub
parent 7ed6e36156
commit d5ebbac4f7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
138 changed files with 158917 additions and 104052 deletions
Download patch file Download diff file Expand all files Collapse all files

1360
api_docs/actions.json
View file

File diff suppressed because it is too large Load diff

444
api_docs/advanced_settings.json
View file

@ -3,201 +3,229 @@
"client": {
"classes": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry",
"type": "Class",
"tags": [],
"label": "ComponentRegistry",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.componentType",
"type": "Object",
"label": "componentType",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 28
},
"signature": [
"{ [key: string]: Id; }"
]
},
{
"id": "def-public.ComponentRegistry.defaultRegistry",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title",
"type": "Function",
"label": "advanced_settings_page_title",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 30
},
"signature": [
"() => JSX.Element"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle",
"type": "Function",
"label": "advanced_settings_page_subtitle",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 31
},
"signature": [
"() => null"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer",
"type": "Function",
"label": "advanced_settings_page_footer",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 32
},
"signature": [
"() => null"
]
}
],
"description": [],
"label": "defaultRegistry",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 29
}
},
{
"id": "def-public.ComponentRegistry.registry",
"type": "Object",
"tags": [],
"children": [],
"description": [],
"label": "registry",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 35
}
},
{
"id": "def-public.ComponentRegistry.setup",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.setup.componentType",
"type": "Object",
"label": "componentType",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 72
},
"signature": [
"{ [key: string]: Id; }"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.setup.register",
"type": "Function",
"label": "register",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 73
},
"signature": [
"(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"
]
}
],
"description": [],
"label": "setup",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 71
}
},
{
"id": "def-public.ComponentRegistry.start",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.start.componentType",
"type": "Object",
"label": "componentType",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 77
},
"signature": [
"{ [key: string]: Id; }"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.start.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 78
},
"signature": [
"(id: Id) => React.ComponentType<Record<string, any> | undefined>"
]
}
],
"description": [],
"label": "start",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 76
}
}
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.componentType",
"type": "Object",
"tags": [],
"label": "componentType",
"description": [],
"signature": [
"{ [key: string]: Id; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry",
"type": "Object",
"tags": [],
"label": "defaultRegistry",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title",
"type": "Function",
"tags": [],
"label": "advanced_settings_page_title",
"description": [],
"signature": [
"() => JSX.Element"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle",
"type": "Function",
"tags": [],
"label": "advanced_settings_page_subtitle",
"description": [],
"signature": [
"() => null"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer",
"type": "Function",
"tags": [],
"label": "advanced_settings_page_footer",
"description": [],
"signature": [
"() => null"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 32
},
"deprecated": false
}
]
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.registry",
"type": "Object",
"tags": [],
"label": "registry",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 35
},
"deprecated": false,
"children": []
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup",
"type": "Object",
"tags": [],
"label": "setup",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 71
},
"deprecated": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.componentType",
"type": "Object",
"tags": [],
"label": "componentType",
"description": [],
"signature": [
"{ [key: string]: Id; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 72
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.register",
"type": "Function",
"tags": [],
"label": "register",
"description": [],
"signature": [
"(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 73
},
"deprecated": false
}
]
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start",
"type": "Object",
"tags": [],
"label": "start",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 76
},
"deprecated": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start.componentType",
"type": "Object",
"tags": [],
"label": "componentType",
"description": [],
"signature": [
"{ [key: string]: Id; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 77
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(id: Id) => React.ComponentType<Record<string, any> | undefined>"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 78
},
"deprecated": false
}
]
}
],
"initialIsOpen": false
}
],
"functions": [
{
"tags": [],
"parentPluginId": "advancedSettings",
"id": "def-public.LazyField",
"type": "Function",
"tags": [],
"label": "LazyField",
"description": [
"\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."
],
"source": {
"path": "src/plugins/advanced_settings/public/index.ts",
"lineNumber": 20
},
"signature": [
"React.LazyExoticComponent<typeof ",
"Field",
">"
],
"source": {
"path": "src/plugins/advanced_settings/public/index.ts",
"lineNumber": 20
},
"deprecated": false,
"initialIsOpen": false
}
],
@ -206,60 +234,68 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsSetup",
"type": "Interface",
"tags": [],
"label": "AdvancedSettingsSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AdvancedSettingsSetup.component",
"type": "Object",
"label": "component",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 16
},
"signature": [
"{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void; }"
]
}
],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsSetup.component",
"type": "Object",
"tags": [],
"label": "component",
"description": [],
"signature": [
"{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsStart",
"type": "Interface",
"tags": [],
"label": "AdvancedSettingsStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AdvancedSettingsStart.component",
"type": "Object",
"label": "component",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 19
},
"signature": [
"{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType<Record<string, any> | undefined>; }"
]
}
],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsStart.component",
"type": "Object",
"tags": [],
"label": "component",
"description": [],
"signature": [
"{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType<Record<string, any> | undefined>; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 19
},
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}

2462
api_docs/alerting.json
View file

File diff suppressed because it is too large Load diff

420
api_docs/apm.json
View file

@ -5,53 +5,61 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "apm",
"id": "def-public.ConfigSchema",
"type": "Interface",
"tags": [],
"label": "ConfigSchema",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "apm",
"id": "def-public.ConfigSchema.serviceMapEnabled",
"type": "boolean",
"tags": [],
"label": "serviceMapEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 15
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-public.ConfigSchema.profilingEnabled",
"type": "boolean",
"tags": [],
"label": "profilingEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 16
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-public.ConfigSchema.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [],
"signature": [
"{ enabled: boolean; }"
],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 17
},
"signature": [
"{ enabled: boolean; }"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 14
},
"initialIsOpen": false
}
],
@ -59,34 +67,38 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "apm",
"id": "def-public.ApmPluginSetup",
"type": "Type",
"label": "ApmPluginSetup",
"tags": [],
"label": "ApmPluginSetup",
"description": [],
"signature": [
"{ ruleRegistry: FormatterRuleRegistry<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>; }"
],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
"lineNumber": 48
},
"signature": [
"{ ruleRegistry: FormatterRuleRegistry<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>; }"
],
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "apm",
"id": "def-public.ApmPluginStart",
"type": "Type",
"label": "ApmPluginStart",
"tags": [],
"label": "ApmPluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
"lineNumber": 51
},
"signature": [
"void"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
@ -94,6 +106,7 @@
"server": {
"classes": [
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin",
"type": "Class",
"tags": [],
@ -128,21 +141,35 @@
", ",
"APMPluginStartDependencies"
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 50
},
"deprecated": false,
"children": [
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 60
},
"deprecated": false,
"children": [
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initContext",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -153,24 +180,23 @@
},
"<unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 60
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 60
}
"returnComment": []
},
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
@ -189,13 +215,19 @@
"<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
"SearchAggregatedTransactionSetting"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 64
},
"deprecated": false,
"children": [
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -208,40 +240,42 @@
"APMPluginStartDependencies",
", unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 65
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"isRequired": true,
"description": [],
"signature": [
"Pick<",
"APMPluginSetupDependencies",
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 66
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 64
}
"returnComment": []
},
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
@ -253,13 +287,19 @@
},
") => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 200
},
"deprecated": false,
"children": [
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -269,49 +309,46 @@
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 200
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 200
}
"returnComment": []
},
{
"parentPluginId": "apm",
"id": "def-server.APMPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 219
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 50
},
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "apm",
"id": "def-server.mergeConfigs",
"type": "Function",
"tags": [],
"label": "mergeConfigs",
"description": [],
"signature": [
"(apmOssConfig: Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>, apmConfig: Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
@ -319,66 +356,74 @@
"SearchAggregatedTransactionSetting",
"; 'xpack.apm.metricsInterval': number; }"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 59
},
"deprecated": false,
"children": [
{
"parentPluginId": "apm",
"id": "def-server.mergeConfigs.$1",
"type": "Object",
"tags": [],
"label": "apmOssConfig",
"isRequired": true,
"description": [],
"signature": [
"Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 60
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "apm",
"id": "def-server.mergeConfigs.$2",
"type": "Object",
"tags": [],
"label": "apmConfig",
"isRequired": true,
"description": [],
"signature": [
"Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 61
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 59
},
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources",
"type": "Interface",
"tags": [],
"label": "APMRouteHandlerResources",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 45
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 46
},
"signature": [
{
"pluginId": "core",
@ -388,76 +433,86 @@
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
]
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.context",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ApmPluginRequestHandlerContext"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 47
},
"signature": [
"ApmPluginRequestHandlerContext"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ query: { _inspect: boolean; }; }"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 48
},
"signature": [
"{ query: { _inspect: boolean; }; }"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 53
},
"signature": [
"{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
"SearchAggregatedTransactionSetting",
"; 'xpack.apm.metricsInterval': number; }"
]
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 53
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
"Logger"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 54
},
"signature": [
"Logger"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.core",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 55
},
"signature": [
"{ setup: ",
{
@ -476,18 +531,20 @@
"text": "CoreStart"
},
">; }"
]
},
{
"tags": [],
"id": "def-server.APMRouteHandlerResources.plugins",
"type": "Object",
"label": "plugins",
"description": [],
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 59
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.plugins",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"{ data: { setup: ",
{
@ -529,71 +586,75 @@
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
}
]
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 59
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMRouteHandlerResources.apmRuleRegistry",
"type": "Object",
"tags": [],
"label": "apmRuleRegistry",
"description": [],
"signature": [
"RuleRegistry",
"<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 65
},
"signature": [
"RuleRegistry",
"<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 45
},
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "apm",
"id": "def-server.ProcessorEvent",
"type": "Enum",
"label": "ProcessorEvent",
"tags": [],
"label": "ProcessorEvent",
"description": [],
"source": {
"path": "x-pack/plugins/apm/common/processor_event.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "apm",
"id": "def-server.APMConfig",
"type": "Type",
"label": "APMConfig",
"tags": [],
"label": "APMConfig",
"description": [],
"signature": [
"{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }"
],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 56
},
"signature": [
"{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "apm",
"id": "def-server.APMServerRouteRepository",
"type": "Type",
"label": "APMServerRouteRepository",
"tags": [],
"label": "APMServerRouteRepository",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts",
"lineNumber": 60
},
"signature": [
"ServerRouteRepository<APMRouteHandlerResources, ",
"APMRouteCreateOptions",
@ -606,90 +667,106 @@
"<\"GET /api/apm/index_pattern/dynamic\", undefined, APMRouteHandlerResources, { dynamicIndexPattern: ",
"IndexPatternTitleAndFields"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts",
"lineNumber": 60
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "apm",
"id": "def-server.APMXPackConfig",
"type": "Type",
"label": "APMXPackConfig",
"tags": [],
"label": "APMXPackConfig",
"description": [],
"signature": [
"{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }"
],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 55
},
"signature": [
"{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "apm",
"id": "def-server.InspectResponse",
"type": "Type",
"label": "InspectResponse",
"tags": [],
"label": "InspectResponse",
"description": [],
"signature": [
"{ response: any; duration: number; requestType: string; requestParams: Record<string, unknown>; esError: Error; }[]"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 26
},
"signature": [
"{ response: any; duration: number; requestType: string; requestParams: Record<string, unknown>; esError: Error; }[]"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "apm",
"id": "def-server.APMPluginSetup",
"type": "Interface",
"tags": [],
"label": "APMPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 47
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "apm",
"id": "def-server.APMPluginSetup.config$",
"type": "Object",
"tags": [],
"label": "config$",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 48
},
"signature": [
"Observable",
"<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
"SearchAggregatedTransactionSetting",
"; 'xpack.apm.metricsInterval': number; }>"
]
},
{
"tags": [],
"id": "def-server.APMPluginSetup.getApmIndices",
"type": "Function",
"label": "getApmIndices",
"description": [],
],
"source": {
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 49
"lineNumber": 48
},
"deprecated": false
},
{
"parentPluginId": "apm",
"id": "def-server.APMPluginSetup.getApmIndices",
"type": "Function",
"tags": [],
"label": "getApmIndices",
"description": [],
"signature": [
"() => Promise<",
"ApmIndicesConfig",
">"
]
},
{
"tags": [],
"id": "def-server.APMPluginSetup.createApmEventClient",
"type": "Function",
"label": "createApmEventClient",
"description": [],
],
"source": {
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 50
"lineNumber": 49
},
"deprecated": false
},
{
"parentPluginId": "apm",
"id": "def-server.APMPluginSetup.createApmEventClient",
"type": "Function",
"tags": [],
"label": "createApmEventClient",
"description": [],
"signature": [
"(params: { debug?: boolean | undefined; request: ",
{
@ -707,13 +784,14 @@
"InferSearchResponseOf",
"<TypeOfProcessorEvent<",
"ValuesType"
]
],
"source": {
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 50
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/apm/server/types.ts",
"lineNumber": 47
},
"lifecycle": "setup",
"initialIsOpen": true
}

797
api_docs/apm_oss.json
View file

File diff suppressed because it is too large Load diff

86
api_docs/banners.json
View file

@ -21,22 +21,25 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "banners",
"id": "def-common.BannerConfiguration",
"type": "Interface",
"tags": [],
"label": "BannerConfiguration",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "banners",
"id": "def-common.BannerConfiguration.placement",
"type": "CompoundType",
"tags": [],
"label": "placement",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 16
},
"signature": [
{
"pluginId": "banners",
@ -45,76 +48,88 @@
"section": "def-common.BannerPlacement",
"text": "BannerPlacement"
}
]
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "banners",
"id": "def-common.BannerConfiguration.textContent",
"type": "string",
"tags": [],
"label": "textContent",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 17
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "banners",
"id": "def-common.BannerConfiguration.textColor",
"type": "string",
"tags": [],
"label": "textColor",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 18
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "banners",
"id": "def-common.BannerConfiguration.backgroundColor",
"type": "string",
"tags": [],
"label": "backgroundColor",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 19
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"parentPluginId": "banners",
"id": "def-common.BannerInfoResponse",
"type": "Interface",
"tags": [],
"label": "BannerInfoResponse",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "banners",
"id": "def-common.BannerInfoResponse.allowed",
"type": "boolean",
"tags": [],
"label": "allowed",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 9
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "banners",
"id": "def-common.BannerInfoResponse.banner",
"type": "Object",
"tags": [],
"label": "banner",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 10
},
"signature": [
{
"pluginId": "banners",
@ -123,31 +138,34 @@
"section": "def-common.BannerConfiguration",
"text": "BannerConfiguration"
}
]
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 10
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "banners",
"id": "def-common.BannerPlacement",
"type": "Type",
"label": "BannerPlacement",
"tags": [],
"label": "BannerPlacement",
"description": [],
"signature": [
"\"top\" | \"disabled\""
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 13
},
"signature": [
"\"top\" | \"disabled\""
],
"deprecated": false,
"initialIsOpen": false
}
],

22
api_docs/beats_management.json
View file

@ -23,32 +23,31 @@
"enums": [],
"misc": [
{
"parentPluginId": "beatsManagement",
"id": "def-common.BeatsManagementConfigType",
"type": "Type",
"label": "BeatsManagementConfigType",
"tags": [],
"label": "BeatsManagementConfigType",
"description": [],
"signature": [
"{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }"
],
"source": {
"path": "x-pack/plugins/beats_management/common/index.ts",
"lineNumber": 23
},
"signature": [
"{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"parentPluginId": "beatsManagement",
"id": "def-common.beatsManagementConfigSchema",
"type": "Object",
"tags": [],
"label": "beatsManagementConfigSchema",
"description": [],
"source": {
"path": "x-pack/plugins/beats_management/common/index.ts",
"lineNumber": 12
},
"signature": [
"ObjectType",
"<{ enabled: ",
@ -60,6 +59,11 @@
"<string>; enrollmentTokensTtlInSeconds: ",
"Type"
],
"source": {
"path": "x-pack/plugins/beats_management/common/index.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
}
]

945
api_docs/bfetch.json
View file

File diff suppressed because it is too large Load diff

68
api_docs/canvas.json
View file

@ -5,22 +5,25 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "canvas",
"id": "def-public.WithKibanaProps",
"type": "Interface",
"tags": [],
"label": "WithKibanaProps",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "canvas",
"id": "def-public.WithKibanaProps.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 16
},
"signature": [
"{ services: ",
{
@ -35,13 +38,14 @@
" & { canvas: ",
"CanvasServices",
"; }; }"
]
],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 15
},
"initialIsOpen": false
}
],
@ -49,38 +53,40 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "canvas",
"id": "def-public.CanvasSetup",
"type": "Type",
"tags": [],
"label": "CanvasSetup",
"tags": [
"public"
],
"description": [
"\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces."
],
"signature": [
"CanvasApi"
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 68
},
"signature": [
"CanvasApi"
],
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "canvas",
"id": "def-public.CanvasStart",
"type": "Type",
"label": "CanvasStart",
"tags": [],
"label": "CanvasStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 69
},
"signature": [
"void"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
@ -101,28 +107,32 @@
"misc": [],
"objects": [
{
"parentPluginId": "canvas",
"id": "def-common.UI_SETTINGS",
"type": "Object",
"tags": [],
"label": "UI_SETTINGS",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/common/index.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "canvas",
"id": "def-common.UI_SETTINGS.ENABLE_LABS_UI",
"type": "string",
"tags": [],
"label": "ENABLE_LABS_UI",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/common/index.ts",
"lineNumber": 9
}
},
"deprecated": false
}
],
"description": [],
"label": "UI_SETTINGS",
"source": {
"path": "x-pack/plugins/canvas/common/index.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
]

5218
api_docs/cases.json
View file

File diff suppressed because it is too large Load diff

2297
api_docs/charts.json
View file

File diff suppressed because it is too large Load diff

314
api_docs/cloud.json
View file

@ -5,101 +5,115 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType",
"type": "Interface",
"tags": [],
"label": "CloudConfigType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CloudConfigType.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.cname",
"type": "string",
"label": "cname",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.base_url",
"type": "string",
"label": "base_url",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 20
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.profile_url",
"type": "string",
"label": "profile_url",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.deployment_url",
"type": "string",
"label": "deployment_url",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 22
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.organization_url",
"type": "string",
"label": "organization_url",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 23
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType.cname",
"type": "string",
"tags": [],
"label": "cname",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType.base_url",
"type": "string",
"tags": [],
"label": "base_url",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType.profile_url",
"type": "string",
"tags": [],
"label": "profile_url",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType.deployment_url",
"type": "string",
"tags": [],
"label": "deployment_url",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "cloud",
"id": "def-public.CloudConfigType.organization_url",
"type": "string",
"tags": [],
"label": "organization_url",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 23
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
@ -107,112 +121,128 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "cloud",
"id": "def-public.CloudSetup",
"type": "Interface",
"tags": [],
"label": "CloudSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 35
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.cloudId",
"type": "string",
"tags": [],
"label": "cloudId",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 36
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.cname",
"type": "string",
"tags": [],
"label": "cname",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 37
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.baseUrl",
"type": "string",
"tags": [],
"label": "baseUrl",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 38
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.deploymentUrl",
"type": "string",
"tags": [],
"label": "deploymentUrl",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 39
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.profileUrl",
"type": "string",
"tags": [],
"label": "profileUrl",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 40
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.organizationUrl",
"type": "string",
"tags": [],
"label": "organizationUrl",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 41
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-public.CloudSetup.isCloudEnabled",
"type": "boolean",
"tags": [],
"label": "isCloudEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 42
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 35
},
"lifecycle": "setup",
"initialIsOpen": true
}
@ -225,70 +255,80 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "cloud",
"id": "def-server.CloudSetup",
"type": "Interface",
"tags": [],
"label": "CloudSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.cloudId",
"type": "string",
"tags": [],
"label": "cloudId",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 20
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.deploymentId",
"type": "string",
"tags": [],
"label": "deploymentId",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.isCloudEnabled",
"type": "boolean",
"tags": [],
"label": "isCloudEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 22
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.apm",
"type": "Object",
"tags": [],
"label": "apm",
"description": [],
"signature": [
"{ url?: string | undefined; secretToken?: string | undefined; }"
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 23
},
"signature": [
"{ url?: string | undefined; secretToken?: string | undefined; }"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 19
},
"lifecycle": "setup",
"initialIsOpen": true
}

24
api_docs/console.json
View file

@ -16,38 +16,38 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "console",
"id": "def-server.ConsoleSetup",
"type": "Type",
"tags": [],
"label": "ConsoleSetup",
"tags": [
"public"
],
"description": [],
"signature": [
"{ addExtensionSpecFilePath: (path: string) => void; }"
],
"source": {
"path": "src/plugins/console/server/types.ts",
"lineNumber": 13
},
"signature": [
"{ addExtensionSpecFilePath: (path: string) => void; }"
],
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "console",
"id": "def-server.ConsoleStart",
"type": "Type",
"tags": [],
"label": "ConsoleStart",
"tags": [
"public"
],
"description": [],
"signature": [
"{ addProcessorDefinition: (processor: unknown) => void; }"
],
"source": {
"path": "src/plugins/console/server/types.ts",
"lineNumber": 18
},
"signature": [
"{ addProcessorDefinition: (processor: unknown) => void; }"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}

20075
api_docs/core.json
View file

File diff suppressed because one or more lines are too long

1821
api_docs/core_application.json
View file

File diff suppressed because it is too large Load diff

2104
api_docs/core_chrome.json
View file

File diff suppressed because it is too large Load diff

5340
api_docs/core_http.json
View file

File diff suppressed because it is too large Load diff

11251
api_docs/core_saved_objects.json
View file

File diff suppressed because it is too large Load diff

1822
api_docs/dashboard.json
View file

File diff suppressed because it is too large Load diff

740
api_docs/dashboard_enhanced.json
View file

File diff suppressed because it is too large Load diff

126
api_docs/dashboard_mode.json
View file

@ -11,6 +11,7 @@
"server": {
"classes": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin",
"type": "Class",
"tags": [],
@ -34,21 +35,35 @@
},
"<void, void, object, object>"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -59,24 +74,23 @@
},
"<unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30
}
"returnComment": []
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
@ -88,13 +102,19 @@
},
"<object, unknown>, { security }: DashboardModeServerSetupDependencies) => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -105,38 +125,40 @@
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{ security }",
"isRequired": true,
"description": [],
"signature": [
"DashboardModeServerSetupDependencies"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
}
"returnComment": []
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
@ -148,13 +170,19 @@
},
") => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -164,41 +192,35 @@
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60
}
"returnComment": []
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 62
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 26
},
"initialIsOpen": false
}
],
@ -216,28 +238,32 @@
"misc": [],
"objects": [
{
"parentPluginId": "dashboardMode",
"id": "def-common.UI_SETTINGS",
"type": "Object",
"tags": [],
"label": "UI_SETTINGS",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "dashboardMode",
"id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES",
"type": "string",
"tags": [],
"label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 9
}
},
"deprecated": false
}
],
"description": [],
"label": "UI_SETTINGS",
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
]

24602
api_docs/data.json
View file

File diff suppressed because it is too large Load diff

240
api_docs/data_autocomplete.json
View file

@ -5,24 +5,25 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic",
"type": "Interface",
"tags": [],
"label": "QuerySuggestionBasic",
"description": [],
"tags": [
"public"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 36
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 37
},
"signature": [
{
"pluginId": "data",
@ -31,80 +32,94 @@
"section": "def-public.QuerySuggestionTypes",
"text": "QuerySuggestionTypes"
}
]
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 37
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | JSX.Element | undefined"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 38
},
"signature": [
"string | JSX.Element | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic.end",
"type": "number",
"tags": [],
"label": "end",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 39
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic.start",
"type": "number",
"tags": [],
"label": "start",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 40
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 41
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionBasic.cursorIndex",
"type": "number",
"tags": [],
"label": "cursorIndex",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 42
},
"signature": [
"number | undefined"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 36
},
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestionField",
"type": "Interface",
"tags": [],
"label": "QuerySuggestionField",
"description": [],
"signature": [
{
"pluginId": "data",
@ -122,21 +137,19 @@
"text": "QuerySuggestionBasic"
}
],
"description": [],
"tags": [
"public"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 46
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionField.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 47
},
"signature": [
{
"pluginId": "data",
@ -146,18 +159,20 @@
"text": "QuerySuggestionTypes"
},
".Field"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionField.field",
"type": "Object",
"label": "field",
"description": [],
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 48
"lineNumber": 47
},
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestionField.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "data",
@ -166,45 +181,49 @@
"section": "def-common.IFieldType",
"text": "IFieldType"
}
]
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 48
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs",
"type": "Interface",
"tags": [],
"label": "QuerySuggestionGetFnArgs",
"description": [],
"tags": [
"public"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.language",
"type": "string",
"tags": [],
"label": "language",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 25
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.indexPatterns",
"type": "Array",
"tags": [],
"label": "indexPatterns",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 26
},
"signature": [
{
"pluginId": "data",
@ -214,135 +233,145 @@
"text": "IIndexPattern"
},
"[]"
]
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 27
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.selectionStart",
"type": "number",
"tags": [],
"label": "selectionStart",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 28
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.selectionEnd",
"type": "number",
"tags": [],
"label": "selectionEnd",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 29
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.signal",
"type": "Object",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"AbortSignal | undefined"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 30
},
"signature": [
"AbortSignal | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.useTimeRange",
"type": "CompoundType",
"tags": [],
"label": "useTimeRange",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 31
},
"signature": [
"boolean | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFnArgs.boolFilter",
"type": "Any",
"tags": [],
"label": "boolFilter",
"description": [],
"signature": [
"any"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 32
},
"signature": [
"any"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 24
},
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestionTypes",
"type": "Enum",
"label": "QuerySuggestionTypes",
"tags": [],
"label": "QuerySuggestionTypes",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "data",
"id": "def-public.AutocompleteStart",
"type": "Type",
"tags": [],
"label": "AutocompleteStart",
"tags": [
"public"
],
"description": [],
"signature": [
"{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"
],
"source": {
"path": "src/plugins/data/public/autocomplete/autocomplete_service.ts",
"lineNumber": 96
},
"signature": [
"{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestion",
"type": "Type",
"tags": [],
"label": "QuerySuggestion",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "data",
@ -360,18 +389,20 @@
"text": "QuerySuggestionField"
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 52
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-public.QuerySuggestionGetFn",
"type": "Type",
"label": "QuerySuggestionGetFn",
"tags": [],
"label": "QuerySuggestionGetFn",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 19
},
"signature": [
"(args: ",
{
@ -391,6 +422,11 @@
},
"[]> | undefined"
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 19
},
"deprecated": false,
"initialIsOpen": false
}
],

165
api_docs/data_enhanced.json
View file

@ -7,50 +7,56 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "dataEnhanced",
"id": "def-public.ENHANCED_ES_SEARCH_STRATEGY",
"type": "string",
"tags": [],
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"signature": [
"\"ese\""
],
"source": {
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
"lineNumber": 11
},
"signature": [
"\"ese\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "dataEnhanced",
"id": "def-public.EQL_SEARCH_STRATEGY",
"type": "string",
"tags": [],
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"signature": [
"\"eql\""
],
"source": {
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
"lineNumber": 14
},
"signature": [
"\"eql\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "dataEnhanced",
"id": "def-public.DataEnhancedStart",
"type": "Type",
"label": "DataEnhancedStart",
"tags": [],
"label": "DataEnhancedStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/data_enhanced/public/plugin.ts",
"lineNumber": 37
},
"signature": [
"void"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
@ -58,6 +64,7 @@
"server": {
"classes": [
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin",
"type": "Class",
"tags": [],
@ -85,21 +92,35 @@
"DataEnhancedStartDependencies",
">"
],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -110,24 +131,23 @@
},
"<Readonly<{} & { search: Readonly<{} & { sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; pageSize: number; trackingInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 26
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 26
}
"returnComment": []
},
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
@ -143,13 +163,19 @@
"DataEnhancedSetupDependencies",
") => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -162,38 +188,40 @@
"DataEnhancedStartDependencies",
", unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 31
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "deps",
"isRequired": true,
"description": [],
"signature": [
"DataEnhancedSetupDependencies"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 31
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 31
}
"returnComment": []
},
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
@ -207,13 +235,19 @@
"DataEnhancedStartDependencies",
") => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 54
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -223,55 +257,52 @@
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 54
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "{ taskManager }",
"isRequired": true,
"description": [],
"signature": [
"DataEnhancedStartDependencies"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 54
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 54
}
"returnComment": []
},
{
"parentPluginId": "dataEnhanced",
"id": "def-server.EnhancedDataServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 60
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 20
},
"initialIsOpen": false
}
],
@ -280,33 +311,37 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "dataEnhanced",
"id": "def-server.ENHANCED_ES_SEARCH_STRATEGY",
"type": "string",
"tags": [],
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"signature": [
"\"ese\""
],
"source": {
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
"lineNumber": 11
},
"signature": [
"\"ese\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "dataEnhanced",
"id": "def-server.EQL_SEARCH_STRATEGY",
"type": "string",
"tags": [],
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"signature": [
"\"eql\""
],
"source": {
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
"lineNumber": 14
},
"signature": [
"\"eql\""
],
"deprecated": false,
"initialIsOpen": false
}
],

3262
api_docs/data_field_formats.json
View file

File diff suppressed because it is too large Load diff

5874
api_docs/data_index_patterns.json
View file

File diff suppressed because it is too large Load diff

2348
api_docs/data_query.json
View file

File diff suppressed because it is too large Load diff

19619
api_docs/data_search.json
View file

File diff suppressed because one or more lines are too long

395
api_docs/data_ui.json
View file

File diff suppressed because one or more lines are too long

2424
api_docs/deprecations.mdx Normal file
View file

File diff suppressed because it is too large Load diff

119
api_docs/dev_tools.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin",
"type": "Class",
"tags": [],
@ -34,11 +35,19 @@
},
", void, object, object>"
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 35
},
"deprecated": false,
"children": [
{
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(coreSetup: ",
{
@ -54,13 +63,19 @@
"DevToolApp",
"; }"
],
"description": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "coreSetup",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -71,84 +86,84 @@
},
"<object, unknown>"
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin.setup.$2.urlForwarding",
"type": "Object",
"tags": [],
"label": "{ urlForwarding }",
"description": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43
}
},
{
"id": "def-public.DevToolsPlugin.setup.$2.urlForwarding",
"type": "Object",
"label": "{ urlForwarding }",
"tags": [],
"description": [],
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin.setup.$2.urlForwarding.urlForwarding",
"type": "Object",
"tags": [],
"label": "urlForwarding",
"description": [],
"signature": [
"{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43
},
"signature": [
"{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43
}
]
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43
}
"returnComment": []
},
{
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 84
}
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "devTools",
"id": "def-public.DevToolsPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 104
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 35
},
"initialIsOpen": false
}
],
@ -158,36 +173,40 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "devTools",
"id": "def-public.DevToolsSetup",
"type": "Interface",
"tags": [],
"label": "DevToolsSetup",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "devTools",
"id": "def-public.DevToolsSetup.register",
"type": "Function",
"tags": [],
"label": "register",
"description": [
"\nRegister a developer tool. It will be available\nin the dev tools app under a separate tab.\n\nRegistering dev tools works almost similar to registering\napplications in the core application service,\nbut they will be rendered with a frame containing tabs\nto switch between the tools."
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 32
},
"signature": [
"(devTool: ",
"CreateDevToolArgs",
") => ",
"DevToolApp"
]
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 32
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 21
},
"lifecycle": "setup",
"initialIsOpen": true
}

715
api_docs/discover.json
View file

File diff suppressed because it is too large Load diff

560
api_docs/discover_enhanced.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin",
"type": "Class",
"tags": [],
@ -42,17 +43,19 @@
},
">"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 40
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 43
},
"signature": [
{
"pluginId": "discoverEnhanced",
@ -61,22 +64,36 @@
"section": "def-common.Config",
"text": "Config"
}
]
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 43
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45
},
"deprecated": false,
"children": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "context",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -87,24 +104,23 @@
},
"<object>"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45
}
"returnComment": []
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
@ -132,13 +148,19 @@
},
") => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 49
},
"deprecated": false,
"children": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -157,17 +179,20 @@
},
", unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 50
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{ uiActions, share }",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "discoverEnhanced",
@ -177,24 +202,23 @@
"text": "DiscoverEnhancedSetupDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 51
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 49
}
"returnComment": []
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
@ -214,13 +238,19 @@
},
") => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71
},
"deprecated": false,
"children": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -230,17 +260,20 @@
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "discoverEnhanced",
@ -250,44 +283,39 @@
"text": "DiscoverEnhancedStartDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71
}
"returnComment": []
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 73
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 40
},
"initialIsOpen": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction",
"type": "Class",
"tags": [],
@ -318,101 +346,105 @@
"<",
"ExploreDataChartActionContext"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 32
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 35
},
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 37
},
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"200"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 39
},
"signature": [
"200"
]
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [],
"signature": [
"(context: ",
"ExploreDataChartActionContext",
") => Promise<boolean>"
],
"description": [],
"children": [
{
"id": "def-public.ExploreDataChartAction.isCompatible.$1",
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
"ExploreDataChartActionContext"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 41
}
},
{
"id": "def-public.ExploreDataChartAction.getUrl",
"type": "Function",
},
"deprecated": false,
"children": [
{
"id": "def-public.ExploreDataChartAction.getUrl.$1",
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.isCompatible.$1",
"type": "Object",
"tags": [],
"label": "context",
"isRequired": true,
"description": [],
"signature": [
"ExploreDataChartActionContext"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 47
}
"lineNumber": 41
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.getUrl",
"type": "Function",
"tags": [],
"label": "getUrl",
"description": [],
"signature": [
"(context: ",
"ExploreDataChartActionContext",
@ -426,23 +458,37 @@
},
">"
],
"description": [],
"label": "getUrl",
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 46
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataChartAction.getUrl.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ExploreDataChartActionContext"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 47
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataContextMenuAction",
"type": "Class",
"tags": [],
@ -470,68 +516,67 @@
},
"<EmbeddableQueryContext>"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataContextMenuAction.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"ACTION_EXPLORE_DATA\""
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 37
},
"signature": [
"\"ACTION_EXPLORE_DATA\""
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataContextMenuAction.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"ACTION_EXPLORE_DATA\""
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 39
},
"signature": [
"\"ACTION_EXPLORE_DATA\""
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataContextMenuAction.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"200"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 41
},
"signature": [
"200"
]
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataContextMenuAction.getUrl",
"type": "Function",
"children": [
{
"id": "def-public.ExploreDataContextMenuAction.getUrl.$1",
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
"EmbeddableQueryContext"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 43
}
}
],
"tags": [],
"label": "getUrl",
"description": [],
"signature": [
"(context: EmbeddableQueryContext) => Promise<",
{
@ -543,42 +588,58 @@
},
">"
],
"description": [],
"label": "getUrl",
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 43
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.ExploreDataContextMenuAction.getUrl.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"EmbeddableQueryContext"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 43
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 34
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedSetupDependencies",
"type": "Interface",
"tags": [],
"label": "DiscoverEnhancedSetupDependencies",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedSetupDependencies.discover",
"type": "Object",
"tags": [],
"label": "discover",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 25
},
"signature": [
{
"pluginId": "discover",
@ -587,18 +648,20 @@
"section": "def-public.DiscoverSetup",
"text": "DiscoverSetup"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 26
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedSetupDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
@ -607,32 +670,36 @@
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
]
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedSetupDependencies.kibanaLegacy",
"type": "Object",
"tags": [],
"label": "kibanaLegacy",
"description": [],
"signature": [
"{} | undefined"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 27
},
"signature": [
"{} | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedSetupDependencies.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 28
},
"signature": [
{
"pluginId": "share",
@ -642,18 +709,20 @@
"text": "SharePluginSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.uiActions",
"type": "Object",
"label": "uiActions",
"description": [],
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 29
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedSetupDependencies.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"Pick<",
{
@ -664,32 +733,36 @@
"text": "UiActionsService"
},
", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">"
]
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 29
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 24
},
"initialIsOpen": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedStartDependencies",
"type": "Interface",
"tags": [],
"label": "DiscoverEnhancedStartDependencies",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 32
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedStartDependencies.discover",
"type": "Object",
"tags": [],
"label": "discover",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 33
},
"signature": [
{
"pluginId": "discover",
@ -698,18 +771,20 @@
"section": "def-public.DiscoverStart",
"text": "DiscoverStart"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 34
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedStartDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
@ -718,34 +793,38 @@
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.kibanaLegacy",
"type": "Object",
"label": "kibanaLegacy",
"description": [],
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 35
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedStartDependencies.kibanaLegacy",
"type": "Object",
"tags": [],
"label": "kibanaLegacy",
"description": [],
"signature": [
"{ dashboardConfig: ",
"DashboardConfig",
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; } | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.share",
"type": "CompoundType",
"label": "share",
"description": [],
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 36
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedStartDependencies.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [],
"signature": [
{
"pluginId": "share",
@ -755,18 +834,20 @@
"text": "SharePluginStart"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.uiActions",
"type": "Object",
"label": "uiActions",
"description": [],
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 37
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "discoverEnhanced",
"id": "def-public.DiscoverEnhancedStartDependencies.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"Pick<",
{
@ -787,13 +868,14 @@
"text": "UiActionsService"
},
">>"
]
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 37
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 32
},
"initialIsOpen": false
}
],
@ -814,31 +896,35 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-common.Config",
"type": "Interface",
"tags": [],
"label": "Config",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Config.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/common/config.ts",
"lineNumber": 9
},
"signature": [
"{ exploreDataInChart: { enabled: boolean; }; exploreDataInContextMenu: { enabled: boolean; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/common/config.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"parentPluginId": "discoverEnhanced",
"id": "def-common.Config.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"{ exploreDataInChart: { enabled: boolean; }; exploreDataInContextMenu: { enabled: boolean; }; }"
],
"source": {
"path": "x-pack/plugins/discover_enhanced/common/config.ts",
"lineNumber": 9
},
"deprecated": false
}
],
"initialIsOpen": false
}
],

7110
api_docs/embeddable.json
View file

File diff suppressed because it is too large Load diff

195
api_docs/embeddable_enhanced.json
View file

@ -4,24 +4,12 @@
"classes": [],
"functions": [
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.isEnhancedEmbeddable",
"type": "Function",
"children": [
{
"id": "def-public.isEnhancedEmbeddable.$1",
"type": "Uncategorized",
"label": "maybeEnhancedEmbeddable",
"isRequired": true,
"signature": [
"E"
],
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 12
}
}
],
"tags": [],
"label": "isEnhancedEmbeddable",
"description": [],
"signature": [
"<E>(maybeEnhancedEmbeddable: E) => maybeEnhancedEmbeddable is ",
{
@ -57,35 +45,55 @@
},
"> ? E : never>"
],
"description": [],
"label": "isEnhancedEmbeddable",
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 11
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.isEnhancedEmbeddable.$1",
"type": "Uncategorized",
"tags": [],
"label": "maybeEnhancedEmbeddable",
"description": [],
"signature": [
"E"
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 12
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.EnhancedEmbeddableContext",
"type": "Interface",
"tags": [],
"label": "EnhancedEmbeddableContext",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "embeddableEnhanced",
"id": "def-public.EnhancedEmbeddableContext.embeddable",
"type": "CompoundType",
"tags": [],
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 21
},
"signature": [
{
"pluginId": "embeddableEnhanced",
@ -119,32 +127,36 @@
"text": "EmbeddableOutput"
},
">>"
]
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 21
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.SetupDependencies",
"type": "Interface",
"tags": [],
"label": "SetupDependencies",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "embeddableEnhanced",
"id": "def-public.SetupDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 35
},
"signature": [
{
"pluginId": "embeddable",
@ -153,18 +165,20 @@
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
]
},
{
"tags": [],
"id": "def-public.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 36
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"tags": [],
"label": "uiActionsEnhanced",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
@ -173,32 +187,36 @@
"section": "def-public.SetupContract",
"text": "SetupContract"
}
]
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 36
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 34
},
"initialIsOpen": false
},
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.StartDependencies",
"type": "Interface",
"tags": [],
"label": "StartDependencies",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 39
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "embeddableEnhanced",
"id": "def-public.StartDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 40
},
"signature": [
{
"pluginId": "embeddable",
@ -207,18 +225,20 @@
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
]
},
{
"tags": [],
"id": "def-public.StartDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 41
"lineNumber": 40
},
"deprecated": false
},
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.StartDependencies.uiActionsEnhanced",
"type": "Object",
"tags": [],
"label": "uiActionsEnhanced",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
@ -227,28 +247,26 @@
"section": "def-public.StartContract",
"text": "StartContract"
}
]
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 41
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 39
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "embeddableEnhanced",
"id": "def-public.drilldownGrouping",
"type": "Array",
"tags": [],
"label": "drilldownGrouping",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts",
"lineNumber": 12
},
"signature": [
{
"pluginId": "uiActions",
@ -283,50 +301,61 @@
},
"> | undefined; }>"
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddableEnhanced",
"id": "def-public.EnhancedEmbeddable",
"type": "Type",
"label": "EnhancedEmbeddable",
"tags": [],
"label": "EnhancedEmbeddable",
"description": [],
"signature": [
"E & { enhancements: { dynamicActions: DynamicActionManager;}; }"
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 11
},
"signature": [
"E & { enhancements: { dynamicActions: DynamicActionManager;}; }"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "embeddableEnhanced",
"id": "def-public.SetupContract",
"type": "Interface",
"tags": [],
"label": "SetupContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 45
},
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "embeddableEnhanced",
"id": "def-public.StartContract",
"type": "Interface",
"tags": [],
"label": "StartContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 48
},
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}

432
api_docs/encrypted_saved_objects.json
View file

@ -11,6 +11,7 @@
"server": {
"classes": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError",
"type": "Class",
"tags": [],
@ -26,123 +27,143 @@
},
" extends Error"
],
"children": [
{
"id": "def-server.EncryptionError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.EncryptionError.Unnamed.$1",
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 18
}
},
{
"id": "def-server.EncryptionError.Unnamed.$2",
"type": "string",
"label": "attributeName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 19
}
},
{
"id": "def-server.EncryptionError.Unnamed.$3",
"type": "Enum",
"label": "operation",
"isRequired": true,
"signature": [
"EncryptionErrorOperation"
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 20
}
},
{
"id": "def-server.EncryptionError.Unnamed.$4",
"type": "Object",
"label": "cause",
"isRequired": false,
"signature": [
"Error | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 21
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 17
}
},
{
"id": "def-server.EncryptionError.toJSON",
"type": "Function",
"label": "toJSON",
"signature": [
"() => { message: string; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 30
}
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 16
},
"deprecated": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 18
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "attributeName",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 19
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$3",
"type": "Enum",
"tags": [],
"label": "operation",
"description": [],
"signature": [
"EncryptionErrorOperation"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 20
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.Unnamed.$4",
"type": "Object",
"tags": [],
"label": "cause",
"description": [],
"signature": [
"Error | undefined"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 21
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptionError.toJSON",
"type": "Function",
"tags": [],
"label": "toJSON",
"description": [],
"signature": [
"() => { message: string; }"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 30
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsClient",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"lineNumber": 40
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser",
"type": "Function",
"tags": [],
"label": "getDecryptedAsInternalUser",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"lineNumber": 41
},
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
@ -155,70 +176,79 @@
" | undefined) => Promise<",
"SavedObject",
"<T>>"
]
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"lineNumber": 41
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"lineNumber": 40
},
"initialIsOpen": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectTypeRegistration",
"description": [
"\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.EncryptedSavedObjectTypeRegistration.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 34
}
},
{
"tags": [],
"id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt",
"type": "Object",
"label": "attributesToEncrypt",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 35
},
"signature": [
"ReadonlySet<string | ",
"AttributeToEncrypt",
">"
]
},
{
"tags": [],
"id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD",
"type": "Object",
"label": "attributesToExcludeFromAAD",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 36
},
"signature": [
"ReadonlySet<string> | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 33
},
"deprecated": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt",
"type": "Object",
"tags": [],
"label": "attributesToEncrypt",
"description": [],
"signature": [
"ReadonlySet<string | ",
"AttributeToEncrypt",
">"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD",
"type": "Object",
"tags": [],
"label": "attributesToExcludeFromAAD",
"description": [],
"signature": [
"ReadonlySet<string> | undefined"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 36
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
@ -226,16 +256,23 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt",
"type": "boolean",
"tags": [],
"label": "canEncrypt",
"description": [
"\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`."
@ -243,18 +280,16 @@
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 35
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.registerType",
"type": "Function",
"tags": [],
"label": "registerType",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 36
},
"signature": [
"(typeRegistration: ",
{
@ -265,70 +300,79 @@
"text": "EncryptedSavedObjectTypeRegistration"
},
") => void"
]
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 36
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration",
"type": "Function",
"tags": [],
"label": "createMigration",
"description": [],
"signature": [
"CreateEncryptedSavedObjectsMigrationFn"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 37
},
"signature": [
"CreateEncryptedSavedObjectsMigrationFn"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 31
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart",
"type": "Interface",
"tags": [],
"label": "EncryptedSavedObjectsPluginStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError",
"type": "Function",
"label": "isEncryptionError",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 41
},
"signature": [
"(error: Error) => boolean"
]
},
{
"tags": [],
"id": "def-server.EncryptedSavedObjectsPluginStart.getClient",
"type": "Function",
"label": "getClient",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 42
},
"signature": [
"ClientInstanciator"
]
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 40
},
"deprecated": false,
"children": [
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError",
"type": "Function",
"tags": [],
"label": "isEncryptionError",
"description": [],
"signature": [
"(error: Error) => boolean"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 41
},
"deprecated": false
},
{
"parentPluginId": "encryptedSavedObjects",
"id": "def-server.EncryptedSavedObjectsPluginStart.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"ClientInstanciator"
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 42
},
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}

22
api_docs/enterprise_search.json
View file

@ -15,32 +15,31 @@
"enums": [],
"misc": [
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.ConfigType",
"type": "Type",
"label": "ConfigType",
"tags": [],
"label": "ConfigType",
"description": [],
"signature": [
"{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"
],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 24
},
"signature": [
"{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"parentPluginId": "enterpriseSearch",
"id": "def-server.configSchema",
"type": "Object",
"tags": [],
"label": "configSchema",
"description": [],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 17
},
"signature": [
"ObjectType",
"<{ host: ",
@ -52,6 +51,11 @@
"<number>; accessCheckTimeoutWarning: ",
"Type"
],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
}
]

1574
api_docs/es_ui_shared.json
View file

File diff suppressed because it is too large Load diff

1405
api_docs/event_log.json
View file

File diff suppressed because it is too large Load diff

25858
api_docs/expressions.json
View file

File diff suppressed because it is too large Load diff

2870
api_docs/features.json
View file

File diff suppressed because it is too large Load diff

166
api_docs/file_data_visualizer.json
View file

@ -8,18 +8,20 @@
"misc": [],
"objects": [],
"start": {
"parentPluginId": "fileDataVisualizer",
"id": "def-public.FileDataVisualizerPluginStart",
"type": "Type",
"label": "FileDataVisualizerPluginStart",
"tags": [],
"label": "FileDataVisualizerPluginStart",
"description": [],
"signature": [
"{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/public/plugin.ts",
"lineNumber": 33
},
"signature": [
"{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
@ -37,252 +39,288 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState",
"type": "Interface",
"tags": [],
"label": "DataVisualizerTableState",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 15
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 16
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.sortField",
"type": "string",
"tags": [],
"label": "sortField",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 17
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.sortDirection",
"type": "string",
"tags": [],
"label": "sortDirection",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 18
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.visibleFieldTypes",
"type": "Array",
"tags": [],
"label": "visibleFieldTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 19
},
"signature": [
"string[]"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.visibleFieldNames",
"type": "Array",
"tags": [],
"label": "visibleFieldNames",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 20
},
"signature": [
"string[]"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.DataVisualizerTableState.showDistributions",
"type": "boolean",
"tags": [],
"label": "showDistributions",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 21
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 14
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES",
"type": "number",
"tags": [],
"label": "ABSOLUTE_MAX_FILE_SIZE_BYTES",
"description": [],
"signature": [
"1073741274"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 14
},
"signature": [
"1073741274"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.FILE_SIZE_DISPLAY_FORMAT",
"type": "string",
"tags": [],
"label": "FILE_SIZE_DISPLAY_FORMAT",
"description": [],
"signature": [
"\"0,0.[0] b\""
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 15
},
"signature": [
"\"0,0.[0] b\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.INDEX_META_DATA_CREATED_BY",
"type": "string",
"tags": [],
"label": "INDEX_META_DATA_CREATED_BY",
"description": [],
"signature": [
"\"file-data-visualizer\""
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 19
},
"signature": [
"\"file-data-visualizer\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fileDataVisualizer",
"id": "def-common.InputData",
"type": "Type",
"label": "InputData",
"tags": [],
"label": "InputData",
"description": [],
"signature": [
"any[]"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 10
},
"signature": [
"any[]"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "fileDataVisualizer",
"id": "def-common.JobFieldType",
"type": "Type",
"label": "JobFieldType",
"tags": [],
"label": "JobFieldType",
"description": [],
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\""
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 12
},
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.MAX_FILE_SIZE",
"type": "string",
"tags": [],
"label": "MAX_FILE_SIZE",
"description": [],
"signature": [
"\"100MB\""
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"100MB\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.MAX_FILE_SIZE_BYTES",
"type": "number",
"tags": [],
"label": "MAX_FILE_SIZE_BYTES",
"description": [],
"signature": [
"104857600"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 12
},
"signature": [
"104857600"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.MB",
"type": "number",
"tags": [],
"label": "MB",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.UI_SETTING_MAX_FILE_SIZE",
"type": "string",
"tags": [],
"label": "UI_SETTING_MAX_FILE_SIZE",
"description": [],
"signature": [
"\"fileUpload:maxFileSize\""
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 8
},
"signature": [
"\"fileUpload:maxFileSize\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"parentPluginId": "fileDataVisualizer",
"id": "def-common.JOB_FIELD_TYPES",
"type": "Object",
"tags": [],
"label": "JOB_FIELD_TYPES",
"description": [],
"signature": [
"{ readonly BOOLEAN: \"boolean\"; readonly DATE: \"date\"; readonly GEO_POINT: \"geo_point\"; readonly GEO_SHAPE: \"geo_shape\"; readonly IP: \"ip\"; readonly KEYWORD: \"keyword\"; readonly NUMBER: \"number\"; readonly TEXT: \"text\"; readonly UNKNOWN: \"unknown\"; }"
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 21
},
"signature": [
"{ readonly BOOLEAN: \"boolean\"; readonly DATE: \"date\"; readonly GEO_POINT: \"geo_point\"; readonly GEO_SHAPE: \"geo_shape\"; readonly IP: \"ip\"; readonly KEYWORD: \"keyword\"; readonly NUMBER: \"number\"; readonly TEXT: \"text\"; readonly UNKNOWN: \"unknown\"; }"
],
"deprecated": false,
"initialIsOpen": false
}
]

1391
api_docs/file_upload.json
View file

File diff suppressed because it is too large Load diff

14290
api_docs/fleet.json
View file

File diff suppressed because it is too large Load diff

949
api_docs/global_search.json
View file

File diff suppressed because it is too large Load diff

974
api_docs/home.json
View file

File diff suppressed because it is too large Load diff

108
api_docs/index_lifecycle_management.json
View file

@ -5,77 +5,87 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "indexLifecycleManagement",
"id": "def-public.IlmUrlGeneratorState",
"type": "Interface",
"tags": [],
"label": "IlmUrlGeneratorState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IlmUrlGeneratorState.page",
"type": "CompoundType",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 22
},
"signature": [
"\"policies_list\" | \"policy_edit\" | \"policy_create\""
]
},
{
"tags": [],
"id": "def-public.IlmUrlGeneratorState.policyName",
"type": "string",
"label": "policyName",
"description": [],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 23
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IlmUrlGeneratorState.absolute",
"type": "CompoundType",
"label": "absolute",
"description": [],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 24
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "indexLifecycleManagement",
"id": "def-public.IlmUrlGeneratorState.page",
"type": "CompoundType",
"tags": [],
"label": "page",
"description": [],
"signature": [
"\"policies_list\" | \"policy_edit\" | \"policy_create\""
],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "indexLifecycleManagement",
"id": "def-public.IlmUrlGeneratorState.policyName",
"type": "string",
"tags": [],
"label": "policyName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 23
},
"deprecated": false
},
{
"parentPluginId": "indexLifecycleManagement",
"id": "def-public.IlmUrlGeneratorState.absolute",
"type": "CompoundType",
"tags": [],
"label": "absolute",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 24
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "indexLifecycleManagement",
"id": "def-public.ILM_URL_GENERATOR_ID",
"type": "string",
"tags": [],
"label": "ILM_URL_GENERATOR_ID",
"description": [],
"signature": [
"\"ILM_URL_GENERATOR_ID\""
],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 19
},
"signature": [
"\"ILM_URL_GENERATOR_ID\""
],
"deprecated": false,
"initialIsOpen": false
}
],

1836
api_docs/index_management.json
View file

File diff suppressed because it is too large Load diff

445
api_docs/index_pattern_field_editor.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor",
"type": "Class",
"tags": [],
@ -22,37 +23,49 @@
"FormatEditorState",
" & S, any>"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 71
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.formatId",
"type": "string",
"tags": [],
"label": "formatId",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 75
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.state",
"type": "CompoundType",
"tags": [],
"label": "state",
"description": [],
"signature": [
"FormatEditorState",
" & S"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 76
},
"signature": [
"FormatEditorState",
" & S"
]
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps",
"type": "Function",
"tags": [],
"label": "getDerivedStateFromProps",
"description": [],
"signature": [
"typeof ",
{
@ -64,119 +77,130 @@
},
".getDerivedStateFromProps"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 78
},
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$1",
"type": "Object",
"tags": [],
"label": "nextProps",
"isRequired": true,
"description": [],
"signature": [
"FormatEditorProps",
"<{}>"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 78
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$2",
"type": "Object",
"tags": [],
"label": "state",
"isRequired": true,
"description": [],
"signature": [
"FormatEditorState"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 78
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 78
}
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.onChange",
"type": "Function",
"children": [
{
"id": "def-public.DefaultFormatEditor.onChange.$1",
"type": "Object",
"label": "newParams",
"isRequired": true,
"signature": [
"{}"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 90
}
}
],
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"(newParams?: {}) => void"
],
"description": [],
"label": "onChange",
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 90
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.onChange.$1",
"type": "Object",
"tags": [],
"label": "newParams",
"description": [],
"signature": [
"{}"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 90
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"() => JSX.Element"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 99
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 71
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext",
"type": "Interface",
"tags": [],
"label": "FieldEditorContext",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext.indexPattern",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 28
},
"signature": [
{
"pluginId": "data",
@ -185,36 +209,40 @@
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
]
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 28
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext.fieldTypeToProcess",
"type": "CompoundType",
"tags": [],
"label": "fieldTypeToProcess",
"description": [
"\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""
],
"signature": [
"InternalFieldType"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 33
},
"signature": [
"InternalFieldType"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldEditorContext.search",
"type": "Object",
"tags": [],
"label": "search",
"description": [
"The search service from the data plugin"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 35
},
"signature": [
{
"pluginId": "data",
@ -223,96 +251,36 @@
"section": "def-public.ISearchStart",
"text": "ISearchStart"
}
]
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 35
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 27
},
"initialIsOpen": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions",
"type": "Interface",
"tags": [],
"label": "OpenFieldDeleteModalOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.OpenFieldDeleteModalOptions.ctx",
"type": "Object",
"label": "ctx",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 25
},
"signature": [
"{ indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"; }"
]
},
{
"tags": [],
"id": "def-public.OpenFieldDeleteModalOptions.onDelete",
"type": "Function",
"label": "onDelete",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 28
},
"signature": [
"((fieldNames: string[]) => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.OpenFieldDeleteModalOptions.fieldName",
"type": "CompoundType",
"label": "fieldName",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 29
},
"signature": [
"string | string[]"
]
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 24
},
"initialIsOpen": false
},
{
"id": "def-public.OpenFieldEditorOptions",
"type": "Interface",
"label": "OpenFieldEditorOptions",
"description": [],
"tags": [],
"deprecated": false,
"children": [
{
"tags": [],
"id": "def-public.OpenFieldEditorOptions.ctx",
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.ctx",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 28
},
"signature": [
"{ indexPattern: ",
{
@ -323,18 +291,92 @@
"text": "IndexPattern"
},
"; }"
]
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 25
},
"deprecated": false
},
{
"tags": [],
"id": "def-public.OpenFieldEditorOptions.onSave",
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.onDelete",
"type": "Function",
"label": "onSave",
"tags": [],
"label": "onDelete",
"description": [],
"signature": [
"((fieldNames: string[]) => void) | undefined"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.fieldName",
"type": "CompoundType",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | string[]"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"lineNumber": 29
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions",
"type": "Interface",
"tags": [],
"label": "OpenFieldEditorOptions",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.ctx",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
"{ indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"; }"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 31
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [],
"signature": [
"((field: ",
{
@ -345,27 +387,30 @@
"text": "IndexPatternField"
},
") => void) | undefined"
]
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 31
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 32
},
"signature": [
"string | undefined"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 27
},
"initialIsOpen": false
}
],
@ -373,16 +418,25 @@
"misc": [],
"objects": [],
"start": {
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart",
"type": "Interface",
"tags": [],
"label": "PluginStart",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openEditor",
"type": "Function",
"tags": [],
"label": "openEditor",
"description": [],
"signature": [
"(options: ",
{
@ -394,13 +448,19 @@
},
") => () => void"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openEditor.$1",
"type": "Object",
"tags": [],
"label": "options",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
@ -410,24 +470,23 @@
"text": "OpenFieldEditorOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 27
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 27
}
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openDeleteModal",
"type": "Function",
"tags": [],
"label": "openDeleteModal",
"description": [],
"signature": [
"(options: ",
{
@ -439,13 +498,19 @@
},
") => () => void"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 28
},
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openDeleteModal.$1",
"type": "Object",
"tags": [],
"label": "options",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
@ -455,30 +520,23 @@
"text": "OpenFieldDeleteModalOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 28
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 28
}
"returnComment": []
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.fieldFormatEditors",
"type": "Object",
"tags": [],
"label": "fieldFormatEditors",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 29
},
"signature": [
"{ getAll: () => typeof ",
{
@ -497,43 +555,48 @@
"text": "DefaultFormatEditor"
},
" | undefined; }"
]
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 29
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.userPermissions",
"type": "Object",
"tags": [],
"label": "userPermissions",
"description": [],
"signature": [
"{ editIndexPattern: () => boolean; }"
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 30
},
"signature": [
"{ editIndexPattern: () => boolean; }"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider",
"type": "Function",
"tags": [],
"label": "DeleteRuntimeFieldProvider",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 33
},
"signature": [
"React.FunctionComponent<",
"Props",
">"
]
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 33
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 26
},
"lifecycle": "start",
"initialIsOpen": true
}

528
api_docs/index_pattern_management.json
View file

File diff suppressed because it is too large Load diff

197
api_docs/infra.json
View file

@ -4,38 +4,43 @@
"classes": [],
"functions": [
{
"parentPluginId": "infra",
"id": "def-public.LazyLogStreamWrapper",
"type": "Function",
"children": [
{
"id": "def-public.LazyLogStreamWrapper.$1",
"type": "CompoundType",
"label": "props",
"isRequired": true,
"signature": [
"React.PropsWithChildren<",
"LogStreamProps",
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx",
"lineNumber": 13
}
}
],
"tags": [],
"label": "LazyLogStreamWrapper",
"description": [],
"signature": [
"(props: React.PropsWithChildren<",
"LogStreamProps",
">) => JSX.Element"
],
"description": [],
"label": "LazyLogStreamWrapper",
"source": {
"path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx",
"lineNumber": 13
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "infra",
"id": "def-public.LazyLogStreamWrapper.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"React.PropsWithChildren<",
"LogStreamProps",
">"
],
"source": {
"path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx",
"lineNumber": 13
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
@ -43,138 +48,156 @@
"interfaces": [],
"enums": [
{
"parentPluginId": "infra",
"id": "def-public.InfraFormatterType",
"type": "Enum",
"label": "InfraFormatterType",
"tags": [],
"label": "InfraFormatterType",
"description": [],
"source": {
"path": "x-pack/plugins/infra/public/lib/lib.ts",
"lineNumber": 147
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "infra",
"id": "def-public.InfraAppId",
"type": "Type",
"label": "InfraAppId",
"tags": [],
"label": "InfraAppId",
"description": [],
"signature": [
"\"metrics\" | \"logs\""
],
"source": {
"path": "x-pack/plugins/infra/public/index.ts",
"lineNumber": 29
},
"signature": [
"\"metrics\" | \"logs\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "infra",
"id": "def-public.FORMATTERS",
"type": "Object",
"tags": [],
"label": "FORMATTERS",
"description": [],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "infra",
"id": "def-public.FORMATTERS.number",
"type": "Function",
"tags": [],
"label": "number",
"description": [],
"signature": [
"(val: number) => string"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 16
},
"signature": [
"(val: number) => string"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "infra",
"id": "def-public.FORMATTERS.abbreviatedNumber",
"type": "Function",
"tags": [],
"label": "abbreviatedNumber",
"description": [
"// Because the implimentation for formatting large numbers is the same as formatting\n// bytes we are re-using the same code, we just format the number using the abbreviated number format."
],
"signature": [
"(bytes: number) => string"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 19
},
"signature": [
"(bytes: number) => string"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "infra",
"id": "def-public.FORMATTERS.bytes",
"type": "Function",
"tags": [],
"label": "bytes",
"description": [
"// bytes in bytes formatted string out"
],
"signature": [
"(bytes: number) => string"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 21
},
"signature": [
"(bytes: number) => string"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "infra",
"id": "def-public.FORMATTERS.bits",
"type": "Function",
"tags": [],
"label": "bits",
"description": [
"// bytes in bits formatted string out"
],
"signature": [
"(bytes: number) => string"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 23
},
"signature": [
"(bytes: number) => string"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "infra",
"id": "def-public.FORMATTERS.percent",
"type": "Function",
"tags": [],
"label": "percent",
"description": [],
"signature": [
"(val: number) => string"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 24
},
"signature": [
"(val: number) => string"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "infra",
"id": "def-public.FORMATTERS.highPercision",
"type": "Function",
"tags": [],
"label": "highPercision",
"description": [],
"signature": [
"(val: number) => string"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 25
},
"signature": [
"(val: number) => string"
]
"deprecated": false
}
],
"description": [],
"label": "FORMATTERS",
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 15
},
"initialIsOpen": false
}
]
@ -186,65 +209,73 @@
"enums": [],
"misc": [
{
"parentPluginId": "infra",
"id": "def-server.InfraConfig",
"type": "Type",
"label": "InfraConfig",
"tags": [],
"label": "InfraConfig",
"description": [],
"signature": [
"{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; container?: string | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }"
],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 65
},
"signature": [
"{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; container?: string | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext",
"type": "Type",
"label": "InfraRequestHandlerContext",
"tags": [],
"label": "InfraRequestHandlerContext",
"description": [],
"signature": [
"InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext"
],
"source": {
"path": "x-pack/plugins/infra/server/types.ts",
"lineNumber": 24
},
"signature": [
"InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "infra",
"id": "def-server.InfraPluginSetup",
"type": "Interface",
"tags": [],
"label": "InfraPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration",
"type": "Function",
"label": "defineInternalSourceConfiguration",
"description": [],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 76
},
"signature": [
"(sourceId: string, sourceProperties: ",
"InfraStaticSourceConfiguration",
") => void"
]
}
],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 75
},
"deprecated": false,
"children": [
{
"parentPluginId": "infra",
"id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration",
"type": "Function",
"tags": [],
"label": "defineInternalSourceConfiguration",
"description": [],
"signature": [
"(sourceId: string, sourceProperties: ",
"InfraStaticSourceConfiguration",
") => void"
],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 76
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}

146
api_docs/ingest_pipelines.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGenerator",
"type": "Class",
"tags": [],
@ -26,77 +27,71 @@
},
"<\"INGEST_PIPELINES_APP_URL_GENERATOR\">"
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 55
},
"deprecated": false,
"children": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGenerator.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.IngestPipelinesUrlGenerator.Unnamed.$1",
"type": "Function",
"label": "getAppBasePath",
"isRequired": true,
"signature": [
"(absolute: boolean) => Promise<string>"
],
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 57
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 57
}
},
"deprecated": false,
"children": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGenerator.Unnamed.$1",
"type": "Function",
"tags": [],
"label": "getAppBasePath",
"description": [],
"signature": [
"(absolute: boolean) => Promise<string>"
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 57
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"tags": [],
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGenerator.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 59
},
"signature": [
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
]
"deprecated": false
},
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGenerator.createUrl",
"type": "Function",
"children": [
{
"id": "def-public.IngestPipelinesUrlGenerator.createUrl.$1",
"type": "CompoundType",
"label": "state",
"isRequired": true,
"signature": [
{
"pluginId": "ingestPipelines",
"scope": "public",
"docId": "kibIngestPipelinesPluginApi",
"section": "def-public.IngestPipelinesUrlGeneratorState",
"text": "IngestPipelinesUrlGeneratorState"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 61
}
}
],
"tags": [],
"label": "createUrl",
"description": [],
"signature": [
"(state: ",
{
@ -108,20 +103,39 @@
},
") => Promise<string>"
],
"description": [],
"label": "createUrl",
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 61
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGenerator.createUrl.$1",
"type": "CompoundType",
"tags": [],
"label": "state",
"description": [],
"signature": [
{
"pluginId": "ingestPipelines",
"scope": "public",
"docId": "kibIngestPipelinesPluginApi",
"section": "def-public.IngestPipelinesUrlGeneratorState",
"text": "IngestPipelinesUrlGeneratorState"
}
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 61
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 55
},
"initialIsOpen": false
}
],
@ -129,44 +143,45 @@
"interfaces": [],
"enums": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.INGEST_PIPELINES_PAGES",
"type": "Enum",
"label": "INGEST_PIPELINES_PAGES",
"tags": [],
"label": "INGEST_PIPELINES_PAGES",
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"parentPluginId": "ingestPipelines",
"id": "def-public.INGEST_PIPELINES_APP_ULR_GENERATOR",
"type": "string",
"tags": [],
"label": "INGEST_PIPELINES_APP_ULR_GENERATOR",
"description": [],
"signature": [
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 20
},
"signature": [
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesUrlGeneratorState",
"type": "Type",
"label": "IngestPipelinesUrlGeneratorState",
"tags": [],
"label": "IngestPipelinesUrlGeneratorState",
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 49
},
"signature": [
"PipelinesListUrlGeneratorState",
" | ",
@ -176,6 +191,11 @@
" | ",
"PipelineCreateUrlGeneratorState"
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 49
},
"deprecated": false,
"initialIsOpen": false
}
],

1584
api_docs/inspector.json
View file

File diff suppressed because it is too large Load diff

1830
api_docs/kibana_legacy.json
View file

File diff suppressed because it is too large Load diff

3567
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

9249
api_docs/kibana_utils.json
View file

File diff suppressed because it is too large Load diff

2422
api_docs/lens.json
View file

File diff suppressed because it is too large Load diff

131
api_docs/license_api_guard.json
View file

@ -11,78 +11,97 @@
"server": {
"classes": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License",
"type": "Class",
"tags": [],
"label": "License",
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 33
},
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"({ pluginName, logger }: SetupSettings) => void"
],
"description": [],
"children": [
{
"id": "def-server.License.setup.$1",
"type": "Object",
"label": "{ pluginName, logger }",
"isRequired": true,
"signature": [
"SetupSettings"
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 41
}
},
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.setup.$1",
"type": "Object",
"tags": [],
"label": "{ pluginName, logger }",
"description": [],
"signature": [
"SetupSettings"
],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 41
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"({ pluginId, minimumLicenseType, licensing }: StartSettings) => void"
],
"description": [],
"children": [
{
"id": "def-server.License.start.$1",
"type": "Object",
"label": "{ pluginId, minimumLicenseType, licensing }",
"isRequired": true,
"signature": [
"StartSettings"
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 46
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 46
}
},
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.start.$1",
"type": "Object",
"tags": [],
"label": "{ pluginId, minimumLicenseType, licensing }",
"description": [],
"signature": [
"StartSettings"
],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 46
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.guardApiRoute",
"type": "Function",
"tags": [],
"label": "guardApiRoute",
"description": [],
"signature": [
"<Context extends ",
{
@ -113,13 +132,19 @@
"<T>) => ",
"KibanaResponse"
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 92
},
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.guardApiRoute.$1",
"type": "Function",
"tags": [],
"label": "handler",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -149,36 +174,30 @@
"text": "ErrorHttpResponseOptions"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 93
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 92
}
"returnComment": []
},
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.isEsSecurityEnabled",
"type": "boolean",
"label": "isEsSecurityEnabled",
"tags": [],
"label": "isEsSecurityEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 116
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 33
},
"initialIsOpen": false
}
],

28
api_docs/license_management.json
View file

@ -8,44 +8,50 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "licenseManagement",
"id": "def-public.LicenseManagementUIPluginSetup",
"type": "Interface",
"tags": [],
"label": "LicenseManagementUIPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/license_management/public/plugin.ts",
"lineNumber": 28
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "licenseManagement",
"id": "def-public.LicenseManagementUIPluginSetup.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/license_management/public/plugin.ts",
"lineNumber": 29
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/license_management/public/plugin.ts",
"lineNumber": 28
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "licenseManagement",
"id": "def-public.LicenseManagementUIPluginStart",
"type": "Type",
"label": "LicenseManagementUIPluginStart",
"tags": [],
"label": "LicenseManagementUIPluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/license_management/public/plugin.ts",
"lineNumber": 31
},
"signature": [
"void"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}

2390
api_docs/licensing.json
View file

File diff suppressed because it is too large Load diff

6548
api_docs/lists.json
View file

File diff suppressed because one or more lines are too long

616
api_docs/management.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "management",
"id": "def-public.ManagementApp",
"type": "Class",
"tags": [],
@ -19,42 +20,48 @@
" extends ",
"ManagementItem"
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementApp.mount",
"type": "Function",
"tags": [],
"label": "mount",
"description": [],
"signature": [
"Mount"
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 20
},
"signature": [
"Mount"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementApp.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 21
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementApp.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 22
},
"signature": [
{
"pluginId": "core",
@ -63,22 +70,36 @@
"section": "def-public.AppMeta",
"text": "AppMeta"
}
]
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "args",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "management",
@ -88,28 +109,21 @@
"text": "RegisterManagementAppArgs"
}
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 24
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 24
}
"returnComment": []
}
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection",
"type": "Class",
"tags": [],
@ -126,17 +140,19 @@
" extends ",
"ManagementItem"
],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementSection.apps",
"type": "Array",
"tags": [],
"label": "apps",
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "management",
@ -146,45 +162,58 @@
"text": "ManagementApp"
},
"[]"
]
],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 22
},
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "args",
"isRequired": true,
"description": [],
"signature": [
"Pick<Pick<",
"CreateManagementItemArgs",
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"title\" | \"id\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">"
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 22
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 22
}
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.registerApp",
"type": "Function",
"tags": [],
"label": "registerApp",
"description": [],
"signature": [
"(args: Pick<",
{
@ -203,13 +232,19 @@
"text": "ManagementApp"
}
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.registerApp.$1",
"type": "Object",
"tags": [],
"label": "args",
"isRequired": true,
"description": [],
"signature": [
"Pick<",
{
@ -221,24 +256,23 @@
},
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">"
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 26
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 26
}
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.getApp",
"type": "Function",
"tags": [],
"label": "getApp",
"description": [],
"signature": [
"(id: string) => ",
{
@ -250,34 +284,39 @@
},
" | undefined"
],
"description": [],
"children": [
{
"id": "def-public.ManagementSection.getApp.$1",
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 41
}
},
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.getApp.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 41
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.getAppsEnabled",
"type": "Function",
"tags": [],
"label": "getAppsEnabled",
"description": [],
"signature": [
"() => ",
{
@ -289,217 +328,235 @@
},
"[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 45
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/management/public/utils/management_section.ts",
"lineNumber": 19
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "management",
"id": "def-public.DefinedSections",
"type": "Interface",
"tags": [],
"label": "DefinedSections",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DefinedSections.ingest",
"type": "Object",
"label": "ingest",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 18
},
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
]
},
{
"tags": [],
"id": "def-public.DefinedSections.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
]
},
{
"tags": [],
"id": "def-public.DefinedSections.insightsAndAlerting",
"type": "Object",
"label": "insightsAndAlerting",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
]
},
{
"tags": [],
"id": "def-public.DefinedSections.security",
"type": "Object",
"label": "security",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 21
},
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
]
},
{
"tags": [],
"id": "def-public.DefinedSections.kibana",
"type": "Object",
"label": "kibana",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 22
},
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
]
},
{
"tags": [],
"id": "def-public.DefinedSections.stack",
"type": "Object",
"label": "stack",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 23
},
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
]
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.ingest",
"type": "Object",
"tags": [],
"label": "ingest",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.insightsAndAlerting",
"type": "Object",
"tags": [],
"label": "insightsAndAlerting",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.stack",
"type": "Object",
"tags": [],
"label": "stack",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 23
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams",
"type": "Interface",
"tags": [],
"label": "ManagementAppMountParams",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 58
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 59
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.element",
"type": "Object",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLElement"
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 60
},
"signature": [
"HTMLElement"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.setBreadcrumbs",
"type": "Function",
"tags": [],
"label": "setBreadcrumbs",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 61
},
"signature": [
"(crumbs: ",
"EuiBreadcrumb",
"[]) => void"
]
},
{
"tags": [],
"id": "def-public.ManagementAppMountParams.history",
"type": "Object",
"label": "history",
"description": [],
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 62
"lineNumber": 61
},
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
{
"pluginId": "core",
@ -509,19 +566,23 @@
"text": "ScopedHistory"
},
"<unknown>"
]
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 62
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 58
},
"initialIsOpen": false
},
{
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs",
"type": "Interface",
"tags": [],
"label": "RegisterManagementAppArgs",
"description": [],
"signature": [
{
"pluginId": "management",
@ -533,44 +594,48 @@
" extends ",
"CreateManagementItemArgs"
],
"description": [],
"tags": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 13
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.mount",
"type": "Function",
"tags": [],
"label": "mount",
"description": [],
"signature": [
"Mount"
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 14
},
"signature": [
"Mount"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 15
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 16
},
"signature": [
{
"pluginId": "core",
@ -580,75 +645,84 @@
"text": "AppMeta"
},
" | undefined"
]
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/management/public/utils/management_app.ts",
"lineNumber": 13
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "management",
"id": "def-public.MANAGEMENT_APP_ID",
"type": "string",
"tags": [],
"label": "MANAGEMENT_APP_ID",
"description": [],
"signature": [
"\"management\""
],
"source": {
"path": "src/plugins/management/common/contants.ts",
"lineNumber": 9
},
"signature": [
"\"management\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "management",
"id": "def-public.ManagementSetup",
"type": "Interface",
"tags": [],
"label": "ManagementSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ManagementSetup.sections",
"type": "Object",
"label": "sections",
"description": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 14
},
"signature": [
"SectionsServiceSetup"
]
}
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 13
},
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSetup.sections",
"type": "Object",
"tags": [],
"label": "sections",
"description": [],
"signature": [
"SectionsServiceSetup"
],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 14
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "management",
"id": "def-public.ManagementStart",
"type": "Interface",
"tags": [],
"label": "ManagementStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "src/plugins/management/public/types.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}

2329
api_docs/maps.json
View file

File diff suppressed because it is too large Load diff

773
api_docs/maps_ems.json
View file

File diff suppressed because it is too large Load diff

92
api_docs/metrics_entities.json
View file

@ -16,47 +16,53 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup",
"type": "Interface",
"tags": [],
"label": "MetricsEntitiesPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient",
"type": "Function",
"label": "getMetricsEntitiesClient",
"description": [],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 15
},
"signature": [
"GetMetricsEntitiesClientType"
]
}
],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient",
"type": "Function",
"tags": [],
"label": "getMetricsEntitiesClient",
"description": [],
"signature": [
"GetMetricsEntitiesClientType"
],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 15
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginStart",
"type": "Type",
"label": "MetricsEntitiesPluginStart",
"tags": [],
"label": "MetricsEntitiesPluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 18
},
"signature": [
"void"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
@ -68,26 +74,29 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "metricsEntities",
"id": "def-common.ELASTIC_NAME",
"type": "string",
"tags": [],
"label": "ELASTIC_NAME",
"description": [
"\nGlobal prefix for all the transform jobs"
],
"signature": [
"\"estc\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
"lineNumber": 21
},
"signature": [
"\"estc\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "metricsEntities",
"id": "def-common.METRICS_ENTITIES_TRANSFORMS",
"type": "string",
"tags": [],
"label": "METRICS_ENTITIES_TRANSFORMS",
"description": [
"\nTransforms route"
@ -96,53 +105,60 @@
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "metricsEntities",
"id": "def-common.METRICS_ENTITIES_URL",
"type": "string",
"tags": [],
"label": "METRICS_ENTITIES_URL",
"description": [
"\nBase route"
],
"signature": [
"\"/api/metrics_entities\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"/api/metrics_entities\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "metricsEntities",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"metricsEntities\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/index.ts",
"lineNumber": 8
},
"signature": [
"\"metricsEntities\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "metricsEntities",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"metrics_entities\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/index.ts",
"lineNumber": 9
},
"signature": [
"\"metrics_entities\""
],
"deprecated": false,
"initialIsOpen": false
}
],

3438
api_docs/ml.json
View file

File diff suppressed because it is too large Load diff

3
api_docs/ml.mdx
View file

@ -13,9 +13,6 @@ import mlObj from './ml.json';
## Client
### Setup
<DocDefinitionList data={[mlObj.client.setup]}/>
### Start
<DocDefinitionList data={[mlObj.client.start]}/>

116
api_docs/monitoring.json
View file

@ -13,50 +13,57 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader",
"type": "Interface",
"tags": [],
"label": "IBulkUploader",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 94
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.getKibanaStats",
"type": "Function",
"tags": [],
"label": "getKibanaStats",
"description": [],
"signature": [
"() => any"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 95
},
"signature": [
"() => any"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 96
},
"signature": [
"() => void"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 97
},
"signature": [
"(esClient: ",
{
@ -67,92 +74,103 @@
"text": "ElasticsearchClient"
},
") => void"
]
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 97
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "monitoring",
"id": "def-server.IBulkUploader.handleNotEnabled",
"type": "Function",
"tags": [],
"label": "handleNotEnabled",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 98
},
"signature": [
"() => void"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 94
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "monitoring",
"id": "def-server.KibanaSettingsCollector",
"type": "Type",
"label": "KibanaSettingsCollector",
"tags": [],
"label": "KibanaSettingsCollector",
"description": [],
"signature": [
"Collector<EmailSettingData | undefined, {}> & KibanaSettingsCollectorExtraOptions"
],
"source": {
"path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts",
"lineNumber": 53
},
"signature": [
"Collector<EmailSettingData | undefined, {}> & KibanaSettingsCollectorExtraOptions"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "monitoring",
"id": "def-server.MonitoringConfig",
"type": "Type",
"label": "MonitoringConfig",
"tags": [],
"label": "MonitoringConfig",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/config.ts",
"lineNumber": 93
},
"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; }>; }>; }"
],
"source": {
"path": "x-pack/plugins/monitoring/server/config.ts",
"lineNumber": 93
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "monitoring",
"id": "def-server.MonitoringPluginSetup",
"type": "Interface",
"tags": [],
"label": "MonitoringPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.MonitoringPluginSetup.getKibanaStats",
"type": "Function",
"label": "getKibanaStats",
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 102
},
"signature": [
"() => any"
]
}
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 101
},
"deprecated": false,
"children": [
{
"parentPluginId": "monitoring",
"id": "def-server.MonitoringPluginSetup.getKibanaStats",
"type": "Function",
"tags": [],
"label": "getKibanaStats",
"description": [],
"signature": [
"() => any"
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 102
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}

337
api_docs/navigation.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin",
"type": "Class",
"tags": [],
@ -42,21 +43,35 @@
},
", object, object>"
],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -67,24 +82,23 @@
},
"<object>"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 21
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 21
}
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
@ -103,13 +117,19 @@
"text": "NavigationPublicPluginSetup"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -120,24 +140,23 @@
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 23
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 23
}
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"({ i18n }: ",
{
@ -158,13 +177,19 @@
"text": "NavigationPublicPluginStart"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "{ i18n }",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "core",
@ -174,63 +199,63 @@
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 32
}
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "{ data }",
"isRequired": true,
"description": [],
"signature": [
"NavigationPluginStartDependencies"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 33
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 31
}
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 44
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 17
},
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenu",
"type": "Function",
"tags": [],
"label": "TopNavMenu",
"description": [],
"signature": [
"(props: ",
{
@ -242,13 +267,19 @@
},
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 64
},
"deprecated": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenu.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"isRequired": true,
"description": [],
"signature": [
{
"pluginId": "navigation",
@ -258,215 +289,234 @@
"text": "TopNavMenuProps"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 64
}
},
"deprecated": false,
"isRequired": true
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 64
},
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData",
"type": "Interface",
"tags": [],
"label": "TopNavMenuData",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 13
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 14
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 15
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.run",
"type": "Function",
"tags": [],
"label": "run",
"description": [],
"signature": [
"TopNavMenuAction"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 16
},
"signature": [
"TopNavMenuAction"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.testId",
"type": "string",
"tags": [],
"label": "testId",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.disableButton",
"type": "CompoundType",
"tags": [],
"label": "disableButton",
"description": [],
"signature": [
"boolean | (() => boolean) | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 20
},
"signature": [
"boolean | (() => boolean) | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.tooltip",
"type": "CompoundType",
"tags": [],
"label": "tooltip",
"description": [],
"signature": [
"string | (() => string | undefined) | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 21
},
"signature": [
"string | (() => string | undefined) | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.emphasize",
"type": "CompoundType",
"tags": [],
"label": "emphasize",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 22
},
"signature": [
"boolean | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.isLoading",
"type": "CompoundType",
"tags": [],
"label": "isLoading",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 23
},
"signature": [
"boolean | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.iconType",
"type": "string",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 24
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.iconSide",
"type": "CompoundType",
"tags": [],
"label": "iconSide",
"description": [],
"signature": [
"\"left\" | \"right\" | undefined"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 25
},
"signature": [
"\"left\" | \"right\" | undefined"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 13
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuProps",
"type": "Type",
"label": "TopNavMenuProps",
"tags": [],
"label": "TopNavMenuProps",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 23
},
"signature": [
"SearchBarOwnProps",
" & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; } & Pick<SearchBarProps, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"onFiltersUpdated\" | \"onRefreshChange\"> & { config?: TopNavMenuData[] | undefined; badges?: (({ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; iconSide?: \"left\" | \"right\" | undefined; color?: string | undefined; isDisabled?: boolean | undefined; closeButtonProps?: Partial<",
@ -478,58 +528,70 @@
"<WithIconOnClick, {}> & ",
"DisambiguateSet"
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 23
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPluginSetup",
"type": "Interface",
"tags": [],
"label": "NavigationPublicPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.NavigationPublicPluginSetup.registerMenuItem",
"type": "Function",
"label": "registerMenuItem",
"description": [],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 13
},
"signature": [
"(menuItem: ",
"RegisteredTopNavMenuData",
") => void"
]
}
],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPluginSetup.registerMenuItem",
"type": "Function",
"tags": [],
"label": "registerMenuItem",
"description": [],
"signature": [
"(menuItem: ",
"RegisteredTopNavMenuData",
") => void"
],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 13
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPluginStart",
"type": "Interface",
"tags": [],
"label": "NavigationPublicPluginStart",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 16
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPluginStart.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 17
},
"signature": [
"{ TopNavMenu: React.ComponentType<",
{
@ -540,13 +602,14 @@
"text": "TopNavMenuProps"
},
">; }"
]
],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 17
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 16
},
"lifecycle": "start",
"initialIsOpen": true
}

148
api_docs/newsfeed.json
View file

@ -5,44 +5,51 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "newsfeed",
"id": "def-public.FetchResult",
"type": "Interface",
"tags": [],
"label": "FetchResult",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 45
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.FetchResult.kibanaVersion",
"type": "string",
"tags": [],
"label": "kibanaVersion",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 46
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.FetchResult.hasNew",
"type": "boolean",
"tags": [],
"label": "hasNew",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 47
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.FetchResult.feedItems",
"type": "Array",
"tags": [],
"label": "feedItems",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 48
},
"signature": [
{
"pluginId": "newsfeed",
@ -52,189 +59,216 @@
"text": "NewsfeedItem"
},
"[]"
]
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 48
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.FetchResult.error",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | null"
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 49
},
"signature": [
"Error | null"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 45
},
"initialIsOpen": false
},
{
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem",
"type": "Interface",
"tags": [],
"label": "NewsfeedItem",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 35
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 36
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.linkText",
"type": "CompoundType",
"tags": [],
"label": "linkText",
"description": [],
"signature": [
"string | null"
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 37
},
"signature": [
"string | null"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.linkUrl",
"type": "string",
"tags": [],
"label": "linkUrl",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 38
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.badge",
"type": "CompoundType",
"tags": [],
"label": "badge",
"description": [],
"signature": [
"string | null"
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 39
},
"signature": [
"string | null"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.publishOn",
"type": "Object",
"tags": [],
"label": "publishOn",
"description": [],
"signature": [
"moment.Moment"
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 40
},
"signature": [
"moment.Moment"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.expireOn",
"type": "Object",
"tags": [],
"label": "expireOn",
"description": [],
"signature": [
"moment.Moment"
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 41
},
"signature": [
"moment.Moment"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedItem.hash",
"type": "string",
"tags": [],
"label": "hash",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 42
}
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 34
},
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedApiEndpoint",
"type": "Enum",
"label": "NewsfeedApiEndpoint",
"tags": [],
"label": "NewsfeedApiEndpoint",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/lib/api.ts",
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedPublicPluginSetup",
"type": "Type",
"label": "NewsfeedPublicPluginSetup",
"tags": [],
"label": "NewsfeedPublicPluginSetup",
"description": [],
"signature": [
"{}"
],
"source": {
"path": "src/plugins/newsfeed/public/plugin.tsx",
"lineNumber": 20
},
"signature": [
"{}"
],
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "newsfeed",
"id": "def-public.NewsfeedPublicPluginStart",
"type": "Type",
"label": "NewsfeedPublicPluginStart",
"tags": [],
"label": "NewsfeedPublicPluginStart",
"description": [],
"signature": [
"{ createNewsFeed$: (endpoint: NewsfeedApiEndpoint) => Rx.Observable<void | FetchResult | null>; }"
],
"source": {
"path": "src/plugins/newsfeed/public/plugin.tsx",
"lineNumber": 21
},
"signature": [
"{ createNewsFeed$: (endpoint: NewsfeedApiEndpoint) => Rx.Observable<void | FetchResult | null>; }"
],
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}

2866
api_docs/observability.json
View file

File diff suppressed because one or more lines are too long

84
api_docs/osquery.json
View file

@ -8,30 +8,34 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "osquery",
"id": "def-public.OsqueryPluginSetup",
"type": "Interface",
"tags": [],
"label": "OsqueryPluginSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/public/types.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "osquery",
"id": "def-public.OsqueryPluginStart",
"type": "Interface",
"tags": [],
"label": "OsqueryPluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/public/types.ts",
"lineNumber": 22
},
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
@ -44,30 +48,34 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "osquery",
"id": "def-server.OsqueryPluginSetup",
"type": "Interface",
"tags": [],
"label": "OsqueryPluginSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/server/types.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "osquery",
"id": "def-server.OsqueryPluginStart",
"type": "Interface",
"tags": [],
"label": "OsqueryPluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/osquery/server/types.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
@ -79,93 +87,105 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "osquery",
"id": "def-common.BASE_PATH",
"type": "string",
"tags": [],
"label": "BASE_PATH",
"description": [],
"signature": [
"\"/app/osquery\""
],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"/app/osquery\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "osquery",
"id": "def-common.DEFAULT_DARK_MODE",
"type": "string",
"tags": [],
"label": "DEFAULT_DARK_MODE",
"description": [],
"signature": [
"\"theme:darkMode\""
],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 9
},
"signature": [
"\"theme:darkMode\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "osquery",
"id": "def-common.DEFAULT_MAX_TABLE_QUERY_SIZE",
"type": "number",
"tags": [],
"label": "DEFAULT_MAX_TABLE_QUERY_SIZE",
"description": [],
"signature": [
"10000"
],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 8
},
"signature": [
"10000"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "osquery",
"id": "def-common.OSQUERY_INTEGRATION_NAME",
"type": "string",
"tags": [],
"label": "OSQUERY_INTEGRATION_NAME",
"description": [],
"signature": [
"\"osquery_manager\""
],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 10
},
"signature": [
"\"osquery_manager\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "osquery",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"osquery\""
],
"source": {
"path": "x-pack/plugins/osquery/common/index.ts",
"lineNumber": 10
},
"signature": [
"\"osquery\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "osquery",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"Osquery\""
],
"source": {
"path": "x-pack/plugins/osquery/common/index.ts",
"lineNumber": 11
},
"signature": [
"\"Osquery\""
],
"deprecated": false,
"initialIsOpen": false
}
],

1349
api_docs/presentation_util.json
View file

File diff suppressed because one or more lines are too long

36
api_docs/remote_clusters.json
View file

@ -8,28 +8,32 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "remoteClusters",
"id": "def-public.RemoteClustersPluginSetup",
"type": "Interface",
"tags": [],
"label": "RemoteClustersPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/remote_clusters/public/plugin.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "remoteClusters",
"id": "def-public.RemoteClustersPluginSetup.isUiEnabled",
"type": "boolean",
"tags": [],
"label": "isUiEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/remote_clusters/public/plugin.ts",
"lineNumber": 21
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/remote_clusters/public/plugin.ts",
"lineNumber": 20
},
"lifecycle": "setup",
"initialIsOpen": true
}
@ -42,28 +46,32 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "remoteClusters",
"id": "def-server.RemoteClustersPluginSetup",
"type": "Interface",
"tags": [],
"label": "RemoteClustersPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/remote_clusters/server/plugin.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "remoteClusters",
"id": "def-server.RemoteClustersPluginSetup.isUiEnabled",
"type": "boolean",
"tags": [],
"label": "isUiEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/remote_clusters/server/plugin.ts",
"lineNumber": 25
}
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/remote_clusters/server/plugin.ts",
"lineNumber": 24
},
"lifecycle": "setup",
"initialIsOpen": true
}

2169
api_docs/reporting.json
View file

File diff suppressed because it is too large Load diff

200
api_docs/rollup.json
View file

@ -23,299 +23,339 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.API_BASE_PATH",
"type": "string",
"tags": [],
"label": "API_BASE_PATH",
"description": [],
"signature": [
"\"/api/rollup\""
],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 19
},
"signature": [
"\"/api/rollup\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.CONFIG_ROLLUPS",
"type": "string",
"tags": [],
"label": "CONFIG_ROLLUPS",
"description": [],
"signature": [
"\"rollups:enableIndexPatterns\""
],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 17
},
"signature": [
"\"rollups:enableIndexPatterns\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_APP_LOAD",
"type": "string",
"tags": [],
"label": "UIM_APP_LOAD",
"description": [],
"signature": [
"\"app_load\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 10
},
"signature": [
"\"app_load\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_APP_NAME",
"type": "string",
"tags": [],
"label": "UIM_APP_NAME",
"description": [],
"signature": [
"\"rollup_jobs\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 8
},
"signature": [
"\"rollup_jobs\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_DETAIL_PANEL_HISTOGRAM_TAB_CLICK",
"type": "string",
"tags": [],
"label": "UIM_DETAIL_PANEL_HISTOGRAM_TAB_CLICK",
"description": [],
"signature": [
"\"detail_panel_histogram_tab_click\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 21
},
"signature": [
"\"detail_panel_histogram_tab_click\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_DETAIL_PANEL_JSON_TAB_CLICK",
"type": "string",
"tags": [],
"label": "UIM_DETAIL_PANEL_JSON_TAB_CLICK",
"description": [],
"signature": [
"\"detail_panel_json_tab_click\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 23
},
"signature": [
"\"detail_panel_json_tab_click\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_DETAIL_PANEL_METRICS_TAB_CLICK",
"type": "string",
"tags": [],
"label": "UIM_DETAIL_PANEL_METRICS_TAB_CLICK",
"description": [],
"signature": [
"\"detail_panel_metrics_tab_click\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 22
},
"signature": [
"\"detail_panel_metrics_tab_click\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_DETAIL_PANEL_SUMMARY_TAB_CLICK",
"type": "string",
"tags": [],
"label": "UIM_DETAIL_PANEL_SUMMARY_TAB_CLICK",
"description": [],
"signature": [
"\"detail_panel_summary_tab_click\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 19
},
"signature": [
"\"detail_panel_summary_tab_click\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_DETAIL_PANEL_TERMS_TAB_CLICK",
"type": "string",
"tags": [],
"label": "UIM_DETAIL_PANEL_TERMS_TAB_CLICK",
"description": [],
"signature": [
"\"detail_panel_terms_tab_click\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 20
},
"signature": [
"\"detail_panel_terms_tab_click\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_CREATE",
"type": "string",
"tags": [],
"label": "UIM_JOB_CREATE",
"description": [],
"signature": [
"\"job_create\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 11
},
"signature": [
"\"job_create\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_DELETE",
"type": "string",
"tags": [],
"label": "UIM_JOB_DELETE",
"description": [],
"signature": [
"\"job_delete\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 12
},
"signature": [
"\"job_delete\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_DELETE_MANY",
"type": "string",
"tags": [],
"label": "UIM_JOB_DELETE_MANY",
"description": [],
"signature": [
"\"job_delete_many\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 13
},
"signature": [
"\"job_delete_many\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_START",
"type": "string",
"tags": [],
"label": "UIM_JOB_START",
"description": [],
"signature": [
"\"job_start\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 14
},
"signature": [
"\"job_start\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_START_MANY",
"type": "string",
"tags": [],
"label": "UIM_JOB_START_MANY",
"description": [],
"signature": [
"\"job_start_many\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 15
},
"signature": [
"\"job_start_many\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_STOP",
"type": "string",
"tags": [],
"label": "UIM_JOB_STOP",
"description": [],
"signature": [
"\"job_stop\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 16
},
"signature": [
"\"job_stop\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_JOB_STOP_MANY",
"type": "string",
"tags": [],
"label": "UIM_JOB_STOP_MANY",
"description": [],
"signature": [
"\"job_stop_many\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 17
},
"signature": [
"\"job_stop_many\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.UIM_SHOW_DETAILS_CLICK",
"type": "string",
"tags": [],
"label": "UIM_SHOW_DETAILS_CLICK",
"description": [],
"signature": [
"\"show_details_click\""
],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 18
},
"signature": [
"\"show_details_click\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "rollup",
"id": "def-common.PLUGIN",
"type": "Object",
"tags": [],
"label": "PLUGIN",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.PLUGIN.ID",
"type": "string",
"tags": [],
"label": "ID",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 13
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "rollup",
"id": "def-common.PLUGIN.minimumLicenseType",
"type": "string",
"tags": [],
"label": "minimumLicenseType",
"description": [],
"signature": [
"\"basic\""
],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 14
},
"signature": [
"\"basic\""
]
"deprecated": false
}
],
"description": [],
"label": "PLUGIN",
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 12
},
"initialIsOpen": false
}
]

914
api_docs/rule_registry.json
View file

File diff suppressed because one or more lines are too long

292
api_docs/runtime_fields.json
View file

@ -4,30 +4,12 @@
"classes": [],
"functions": [
{
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeFieldEditor",
"type": "Function",
"children": [
{
"id": "def-public.RuntimeFieldEditor.$1",
"type": "Object",
"label": "{ defaultValue, onChange, docLinks, ctx }",
"isRequired": true,
"signature": [
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.Props",
"text": "Props"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
"lineNumber": 22
}
}
],
"tags": [],
"label": "RuntimeFieldEditor",
"description": [],
"signature": [
"({ defaultValue, onChange, docLinks, ctx }: ",
{
@ -39,25 +21,19 @@
},
") => JSX.Element"
],
"description": [],
"label": "RuntimeFieldEditor",
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
"lineNumber": 22
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-public.RuntimeFieldEditorFlyoutContent",
"type": "Function",
"deprecated": false,
"children": [
{
"id": "def-public.RuntimeFieldEditorFlyoutContent.$1",
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeFieldEditor.$1",
"type": "Object",
"label": "{\n onSave,\n onCancel,\n docLinks,\n defaultValue: field,\n ctx,\n}",
"isRequired": true,
"tags": [],
"label": "{ defaultValue, onChange, docLinks, ctx }",
"description": [],
"signature": [
{
"pluginId": "runtimeFields",
@ -67,13 +43,24 @@
"text": "Props"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 78
}
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
"lineNumber": 22
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeFieldEditorFlyoutContent",
"type": "Function",
"tags": [],
"label": "RuntimeFieldEditorFlyoutContent",
"description": [],
"signature": [
"({ onSave, onCancel, docLinks, defaultValue: field, ctx, }: ",
{
@ -85,60 +72,90 @@
},
") => JSX.Element"
],
"description": [],
"label": "RuntimeFieldEditorFlyoutContent",
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 78
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeFieldEditorFlyoutContent.$1",
"type": "Object",
"tags": [],
"label": "{\n onSave,\n onCancel,\n docLinks,\n defaultValue: field,\n ctx,\n}",
"description": [],
"signature": [
{
"pluginId": "runtimeFields",
"scope": "public",
"docId": "kibRuntimeFieldsPluginApi",
"section": "def-public.Props",
"text": "Props"
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 78
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "runtimeFields",
"id": "def-public.FormState",
"type": "Interface",
"tags": [],
"label": "FormState",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 39
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.FormState.isValid",
"type": "CompoundType",
"tags": [],
"label": "isValid",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 40
},
"signature": [
"boolean | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.FormState.isSubmitted",
"type": "boolean",
"tags": [],
"label": "isSubmitted",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 41
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.FormState.submit",
"type": "Function",
"tags": [],
"label": "submit",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 42
},
"signature": [
"(e?: React.FormEvent<HTMLFormElement> | React.MouseEvent<Element, MouseEvent> | undefined) => Promise<{ data: ",
{
@ -149,34 +166,38 @@
"text": "RuntimeField"
},
"; isValid: boolean; }>"
]
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 42
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
"lineNumber": 39
},
"initialIsOpen": false
},
{
"parentPluginId": "runtimeFields",
"id": "def-public.Props",
"type": "Interface",
"tags": [],
"label": "Props",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 55
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.Props.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [
"\nHandler for the \"save\" footer button"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 59
},
"signature": [
"(field: ",
{
@ -187,36 +208,40 @@
"text": "RuntimeField"
},
") => void"
]
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 59
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.Props.onCancel",
"type": "Function",
"tags": [],
"label": "onCancel",
"description": [
"\nHandler for the \"cancel\" footer button"
],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 63
},
"signature": [
"() => void"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.Props.docLinks",
"type": "Object",
"tags": [],
"label": "docLinks",
"description": [
"\nThe docLinks start service from core"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 67
},
"signature": [
{
"pluginId": "core",
@ -225,20 +250,22 @@
"section": "def-public.DocLinksStart",
"text": "DocLinksStart"
}
]
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 67
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.Props.defaultValue",
"type": "Object",
"tags": [],
"label": "defaultValue",
"description": [
"\nAn optional runtime field to edit"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 71
},
"signature": [
{
"pluginId": "runtimeFields",
@ -248,150 +275,169 @@
"text": "RuntimeField"
},
" | undefined"
]
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 71
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.Props.ctx",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [
"\nOptional context object"
],
"signature": [
"{ namesNotAllowed?: string[] | undefined; existingConcreteFields?: Field[] | undefined; } | undefined"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 75
},
"signature": [
"{ namesNotAllowed?: string[] | undefined; existingConcreteFields?: Field[] | undefined; } | undefined"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
"lineNumber": 55
},
"initialIsOpen": false
},
{
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeField",
"type": "Interface",
"tags": [],
"label": "RuntimeField",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 33
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeField.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 34
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeField.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 35
},
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeField.script",
"type": "Object",
"tags": [],
"label": "script",
"description": [],
"signature": [
"{ source: string; }"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 36
},
"signature": [
"{ source: string; }"
]
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 33
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "runtimeFields",
"id": "def-public.RUNTIME_FIELD_OPTIONS",
"type": "Array",
"tags": [],
"label": "RUNTIME_FIELD_OPTIONS",
"description": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/constants.ts",
"lineNumber": 14
},
"signature": [
"ComboBoxOption",
"<\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\">[]"
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/constants.ts",
"lineNumber": 14
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "runtimeFields",
"id": "def-public.RuntimeType",
"type": "Type",
"label": "RuntimeType",
"tags": [],
"label": "RuntimeType",
"description": [],
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 31
},
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "runtimeFields",
"id": "def-public.PluginSetup",
"type": "Interface",
"tags": [],
"label": "PluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"parentPluginId": "runtimeFields",
"id": "def-public.PluginSetup.loadEditor",
"type": "Function",
"tags": [],
"label": "loadEditor",
"description": [],
"signature": [
"() => Promise<",
"LoadEditorResponse",
">"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 18
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/runtime_fields/public/types.ts",
"lineNumber": 17
},
"lifecycle": "setup",
"initialIsOpen": true
}

2732
api_docs/saved_objects.json
View file

File diff suppressed because it is too large Load diff

1356
api_docs/saved_objects_management.json
View file

File diff suppressed because one or more lines are too long

740
api_docs/saved_objects_tagging.json
View file

File diff suppressed because it is too large Load diff

1327
api_docs/saved_objects_tagging_oss.json
View file

File diff suppressed because it is too large Load diff

1053
api_docs/security.json
View file

File diff suppressed because it is too large Load diff

216
api_docs/security_oss.json
View file

@ -8,76 +8,86 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecurityOssPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SecurityOssPluginSetup.insecureCluster",
"type": "Object",
"label": "insecureCluster",
"description": [],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 26
},
"signature": [
"InsecureClusterServiceSetup"
]
}
],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginSetup.insecureCluster",
"type": "Object",
"tags": [],
"label": "insecureCluster",
"description": [],
"signature": [
"InsecureClusterServiceSetup"
],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 26
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginStart",
"type": "Interface",
"tags": [],
"label": "SecurityOssPluginStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SecurityOssPluginStart.insecureCluster",
"type": "Object",
"label": "insecureCluster",
"description": [],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 30
},
"signature": [
"InsecureClusterServiceStart"
]
},
{
"tags": [],
"id": "def-public.SecurityOssPluginStart.anonymousAccess",
"type": "Object",
"label": "anonymousAccess",
"description": [],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 31
},
"signature": [
"{ getAccessURLParameters: () => Promise<Record<string, string> | null>; getCapabilities: () => Promise<",
"Capabilities",
">; }"
]
}
],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginStart.insecureCluster",
"type": "Object",
"tags": [],
"label": "insecureCluster",
"description": [],
"signature": [
"InsecureClusterServiceStart"
],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginStart.anonymousAccess",
"type": "Object",
"tags": [],
"label": "anonymousAccess",
"description": [],
"signature": [
"{ getAccessURLParameters: () => Promise<Record<string, string> | null>; getCapabilities: () => Promise<",
"Capabilities",
">; }"
],
"source": {
"path": "src/plugins/security_oss/public/plugin.ts",
"lineNumber": 31
},
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
@ -90,52 +100,58 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecurityOssPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/security_oss/server/plugin.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup.showInsecureClusterWarning$",
"type": "Object",
"tags": [],
"label": "showInsecureClusterWarning$",
"description": [
"\nAllows consumers to show/hide the insecure cluster warning."
],
"signature": [
"BehaviorSubject",
"<boolean>"
],
"source": {
"path": "src/plugins/security_oss/server/plugin.ts",
"lineNumber": 29
},
"signature": [
"BehaviorSubject",
"<boolean>"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup.setAnonymousAccessServiceProvider",
"type": "Function",
"tags": [],
"label": "setAnonymousAccessServiceProvider",
"description": [
"\nSet the provider function that returns a service to deal with the anonymous access."
],
"signature": [
"(provider: () => ",
"AnonymousAccessService",
") => void"
],
"source": {
"path": "src/plugins/security_oss/server/plugin.ts",
"lineNumber": 35
},
"signature": [
"(provider: () => ",
"AnonymousAccessService",
") => void"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/security_oss/server/plugin.ts",
"lineNumber": 25
},
"lifecycle": "setup",
"initialIsOpen": true
}
@ -145,47 +161,53 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "securityOss",
"id": "def-common.AppState",
"type": "Interface",
"tags": [],
"label": "AppState",
"description": [
"\nDefines Security OSS application state."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AppState.insecureClusterAlert",
"type": "Object",
"label": "insecureClusterAlert",
"description": [],
"source": {
"path": "src/plugins/security_oss/common/app_state.ts",
"lineNumber": 13
},
"signature": [
"{ displayAlert: boolean; }"
]
},
{
"tags": [],
"id": "def-common.AppState.anonymousAccess",
"type": "Object",
"label": "anonymousAccess",
"description": [],
"source": {
"path": "src/plugins/security_oss/common/app_state.ts",
"lineNumber": 14
},
"signature": [
"{ isEnabled: boolean; accessURLParameters: Record<string, string> | null; }"
]
}
],
"source": {
"path": "src/plugins/security_oss/common/app_state.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-common.AppState.insecureClusterAlert",
"type": "Object",
"tags": [],
"label": "insecureClusterAlert",
"description": [],
"signature": [
"{ displayAlert: boolean; }"
],
"source": {
"path": "src/plugins/security_oss/common/app_state.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "securityOss",
"id": "def-common.AppState.anonymousAccess",
"type": "Object",
"tags": [],
"label": "anonymousAccess",
"description": [],
"signature": [
"{ isEnabled: boolean; accessURLParameters: Record<string, string> | null; }"
],
"source": {
"path": "src/plugins/security_oss/common/app_state.ts",
"lineNumber": 14
},
"deprecated": false
}
],
"initialIsOpen": false
}
],

13402
api_docs/security_solution.json
View file

File diff suppressed because it is too large Load diff

830
api_docs/share.json
View file

File diff suppressed because it is too large Load diff

363
api_docs/snapshot_restore.json
View file

@ -22,198 +22,228 @@
"interfaces": [],
"enums": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_TYPES",
"type": "Enum",
"label": "REPOSITORY_TYPES",
"tags": [],
"label": "REPOSITORY_TYPES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.API_BASE_PATH",
"type": "string",
"tags": [],
"label": "API_BASE_PATH",
"description": [],
"signature": [
"\"/api/snapshot_restore/\""
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 23
},
"signature": [
"\"/api/snapshot_restore/\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.APP_REQUIRED_CLUSTER_PRIVILEGES",
"type": "Array",
"tags": [],
"label": "APP_REQUIRED_CLUSTER_PRIVILEGES",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 55
},
"signature": [
"string[]"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.APP_RESTORE_INDEX_PRIVILEGES",
"type": "Array",
"tags": [],
"label": "APP_RESTORE_INDEX_PRIVILEGES",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 59
},
"signature": [
"string[]"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.APP_SLM_CLUSTER_PRIVILEGES",
"type": "Array",
"tags": [],
"label": "APP_SLM_CLUSTER_PRIVILEGES",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 60
},
"signature": [
"string[]"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.DEFAULT_REPOSITORY_TYPES",
"type": "Array",
"tags": [],
"label": "DEFAULT_REPOSITORY_TYPES",
"description": [],
"signature": [
"RepositoryType",
"[]"
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 36
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN_REPOSITORY_TYPES",
"type": "Array",
"tags": [],
"label": "PLUGIN_REPOSITORY_TYPES",
"description": [],
"signature": [
"RepositoryType",
"[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PLUGIN_REPOSITORY_TYPES",
"type": "Array",
"label": "PLUGIN_REPOSITORY_TYPES",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 41
},
"signature": [
"RepositoryType",
"[]"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN",
"type": "Object",
"tags": [],
"label": "PLUGIN",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 13
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 14
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.minimumLicenseType",
"type": "string",
"tags": [],
"label": "minimumLicenseType",
"description": [],
"signature": [
"\"basic\""
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 15
},
"signature": [
"\"basic\""
]
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.getI18nName",
"type": "Function",
"children": [
{
"id": "def-common.PLUGIN.getI18nName.$1",
"type": "Any",
"label": "i18n",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16
}
}
],
"tags": [],
"label": "getI18nName",
"description": [],
"signature": [
"(i18n: any) => string"
],
"description": [],
"label": "getI18nName",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.getI18nName.$1",
"type": "Any",
"tags": [],
"label": "i18n",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 16
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"description": [],
"label": "PLUGIN",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP",
"type": "Object",
"tags": [],
"label": "REPOSITORY_PLUGINS_MAP",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 48
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorys3",
"type": "string",
"tags": [],
"label": "'repository-s3'",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 49
},
"signature": [
{
"pluginId": "snapshotRestore",
@ -223,18 +253,20 @@
"text": "REPOSITORY_TYPES"
},
".s3"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryhdfs",
"type": "string",
"label": "'repository-hdfs'",
"description": [],
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 50
"lineNumber": 49
},
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryhdfs",
"type": "string",
"tags": [],
"label": "'repository-hdfs'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
@ -244,18 +276,20 @@
"text": "REPOSITORY_TYPES"
},
".hdfs"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryazure",
"type": "string",
"label": "'repository-azure'",
"description": [],
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 51
"lineNumber": 50
},
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryazure",
"type": "string",
"tags": [],
"label": "'repository-azure'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
@ -265,18 +299,20 @@
"text": "REPOSITORY_TYPES"
},
".azure"
]
},
{
"tags": [],
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorygcs",
"type": "string",
"label": "'repository-gcs'",
"description": [],
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 52
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorygcs",
"type": "string",
"tags": [],
"label": "'repository-gcs'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
@ -286,85 +322,94 @@
"text": "REPOSITORY_TYPES"
},
".gcs"
]
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 52
},
"deprecated": false
}
],
"description": [],
"label": "REPOSITORY_PLUGINS_MAP",
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 48
},
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.TIME_UNITS.DAY",
"type": "string",
"label": "DAY",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 63
},
"signature": [
"\"d\""
]
},
{
"tags": [],
"id": "def-common.TIME_UNITS.HOUR",
"type": "string",
"label": "HOUR",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 64
},
"signature": [
"\"h\""
]
},
{
"tags": [],
"id": "def-common.TIME_UNITS.MINUTE",
"type": "string",
"label": "MINUTE",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 65
},
"signature": [
"\"m\""
]
},
{
"tags": [],
"id": "def-common.TIME_UNITS.SECOND",
"type": "string",
"label": "SECOND",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 66
},
"signature": [
"\"s\""
]
}
],
"description": [],
"label": "TIME_UNITS",
"description": [],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 62
},
"deprecated": false,
"children": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.DAY",
"type": "string",
"tags": [],
"label": "DAY",
"description": [],
"signature": [
"\"d\""
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 63
},
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.HOUR",
"type": "string",
"tags": [],
"label": "HOUR",
"description": [],
"signature": [
"\"h\""
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 64
},
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.MINUTE",
"type": "string",
"tags": [],
"label": "MINUTE",
"description": [],
"signature": [
"\"m\""
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 65
},
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.SECOND",
"type": "string",
"tags": [],
"label": "SECOND",
"description": [],
"signature": [
"\"s\""
],
"source": {
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"lineNumber": 66
},
"deprecated": false
}
],
"initialIsOpen": false
}
]

1985
api_docs/spaces.json
View file

File diff suppressed because it is too large Load diff

828
api_docs/spaces_oss.json
View file

File diff suppressed because it is too large Load diff

42
api_docs/stack_alerts.json
View file

@ -15,18 +15,20 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "stackAlerts",
"id": "def-server.ID",
"type": "string",
"tags": [],
"label": "ID",
"description": [],
"signature": [
"\".index-threshold\""
],
"source": {
"path": "x-pack/plugins/stack_alerts/server/alert_types/index_threshold/alert_type.ts",
"lineNumber": 20
},
"signature": [
"\".index-threshold\""
],
"deprecated": false,
"initialIsOpen": false
}
],
@ -39,53 +41,59 @@
"enums": [],
"misc": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.Config",
"type": "Type",
"label": "Config",
"tags": [],
"label": "Config",
"description": [],
"signature": [
"{ readonly enabled: boolean; }"
],
"source": {
"path": "x-pack/plugins/stack_alerts/common/config.ts",
"lineNumber": 14
},
"signature": [
"{ readonly enabled: boolean; }"
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "stackAlerts",
"id": "def-common.STACK_ALERTS_FEATURE_ID",
"type": "string",
"tags": [],
"label": "STACK_ALERTS_FEATURE_ID",
"description": [],
"signature": [
"\"stackAlerts\""
],
"source": {
"path": "x-pack/plugins/stack_alerts/common/index.ts",
"lineNumber": 9
},
"signature": [
"\"stackAlerts\""
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"parentPluginId": "stackAlerts",
"id": "def-common.configSchema",
"type": "Object",
"tags": [],
"label": "configSchema",
"description": [],
"source": {
"path": "x-pack/plugins/stack_alerts/common/config.ts",
"lineNumber": 10
},
"signature": [
"ObjectType",
"<{ enabled: ",
"Type",
"<boolean>; }>"
],
"source": {
"path": "x-pack/plugins/stack_alerts/common/config.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
}
]

522
api_docs/task_manager.json
View file

File diff suppressed because it is too large Load diff

542
api_docs/telemetry.json
View file

@ -5,18 +5,25 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig",
"type": "Interface",
"tags": [],
"label": "TelemetryPluginConfig",
"description": [
"\nPublic-exposed configuration"
],
"tags": [],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 82
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [
"Is the plugin enabled?"
@ -24,12 +31,14 @@
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 84
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.url",
"type": "string",
"tags": [],
"label": "url",
"description": [
"Remote telemetry service's URL"
@ -37,12 +46,14 @@
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 86
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.banner",
"type": "boolean",
"tags": [],
"label": "banner",
"description": [
"The banner is expected to be shown when needed"
@ -50,12 +61,14 @@
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 88
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.allowChangingOptInStatus",
"type": "boolean",
"tags": [],
"label": "allowChangingOptInStatus",
"description": [
"Does the cluster allow changing the opt-in/out status via the UI?"
@ -63,28 +76,32 @@
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 90
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.optIn",
"type": "CompoundType",
"tags": [],
"label": "optIn",
"description": [
"Is the cluster opted-in?"
],
"signature": [
"boolean | null"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 92
},
"signature": [
"boolean | null"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.optInStatusUrl",
"type": "string",
"tags": [],
"label": "optInStatusUrl",
"description": [
"Opt-in/out notification URL"
@ -92,92 +109,104 @@
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 94
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.sendUsageFrom",
"type": "CompoundType",
"tags": [],
"label": "sendUsageFrom",
"description": [
"Should the telemetry payloads be sent from the server or the browser?"
],
"signature": [
"\"browser\" | \"server\""
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 96
},
"signature": [
"\"browser\" | \"server\""
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.telemetryNotifyUserAboutOptInDefault",
"type": "CompoundType",
"tags": [],
"label": "telemetryNotifyUserAboutOptInDefault",
"description": [
"Should notify the user about the opt-in status?"
],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 98
},
"signature": [
"boolean | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginConfig.userCanChangeSettings",
"type": "CompoundType",
"tags": [],
"label": "userCanChangeSettings",
"description": [
"Does the user have enough privileges to change the settings?"
],
"signature": [
"boolean | undefined"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 100
},
"signature": [
"boolean | undefined"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 82
},
"initialIsOpen": false
},
{
"parentPluginId": "telemetry",
"id": "def-public.TelemetryServicePublicApis",
"type": "Interface",
"tags": [],
"label": "TelemetryServicePublicApis",
"description": [
"\nPublicly exposed APIs from the Telemetry Service"
],
"tags": [],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 36
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryServicePublicApis.getIsOptedIn",
"type": "Function",
"tags": [],
"label": "getIsOptedIn",
"description": [
"Is the cluster opted-in to telemetry?"
],
"signature": [
"() => boolean | null"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 38
},
"signature": [
"() => boolean | null"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryServicePublicApis.userCanChangeSettings",
"type": "boolean",
"tags": [],
"label": "userCanChangeSettings",
"description": [
"Is the user allowed to change the opt-in/out status?"
@ -185,61 +214,64 @@
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 40
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryServicePublicApis.getCanChangeOptInStatus",
"type": "Function",
"tags": [],
"label": "getCanChangeOptInStatus",
"description": [
"Is the cluster allowed to change the opt-in/out status?"
],
"signature": [
"() => boolean"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 42
},
"signature": [
"() => boolean"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryServicePublicApis.fetchExample",
"type": "Function",
"tags": [],
"label": "fetchExample",
"description": [
"Fetches an unencrypted telemetry payload so we can show it to the user"
],
"signature": [
"() => Promise<unknown[]>"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 44
},
"signature": [
"() => Promise<unknown[]>"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-public.TelemetryServicePublicApis.setOptIn",
"type": "Function",
"tags": [],
"label": "setOptIn",
"description": [
"\nOverwrite the opt-in status.\nIt will send a final request to the remote telemetry cluster to report about the opt-in/out change."
],
"signature": [
"(optedIn: boolean) => Promise<boolean>"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 50
},
"signature": [
"(optedIn: boolean) => Promise<boolean>"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 36
},
"initialIsOpen": false
}
],
@ -247,97 +279,29 @@
"misc": [],
"objects": [],
"start": {
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginStart",
"type": "Interface",
"tags": [],
"label": "TelemetryPluginStart",
"description": [
"\nPublic's start exposed APIs by the telemetry plugin"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.TelemetryPluginStart.telemetryService",
"type": "Object",
"label": "telemetryService",
"description": [
"{@link TelemetryServicePublicApis}"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 66
},
"signature": [
{
"pluginId": "telemetry",
"scope": "public",
"docId": "kibTelemetryPluginApi",
"section": "def-public.TelemetryServicePublicApis",
"text": "TelemetryServicePublicApis"
}
]
},
{
"tags": [],
"id": "def-public.TelemetryPluginStart.telemetryNotifications",
"type": "Object",
"label": "telemetryNotifications",
"description": [
"Notification helpers"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 68
},
"signature": [
"{ setOptedInNoticeSeen: () => Promise<void>; }"
]
},
{
"tags": [],
"id": "def-public.TelemetryPluginStart.telemetryConstants",
"type": "Object",
"label": "telemetryConstants",
"description": [
"Set of publicly exposed telemetry constants"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 73
},
"signature": [
"{ getPrivacyStatementUrl: () => string; }"
]
}
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 64
},
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"id": "def-public.TelemetryPluginSetup",
"type": "Interface",
"label": "TelemetryPluginSetup",
"description": [
"\nPublic's setup exposed APIs by the telemetry plugin"
],
"tags": [],
"deprecated": false,
"children": [
{
"tags": [],
"id": "def-public.TelemetryPluginSetup.telemetryService",
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginStart.telemetryService",
"type": "Object",
"tags": [],
"label": "telemetryService",
"description": [
"{@link TelemetryService}"
"{@link TelemetryServicePublicApis}"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 58
},
"signature": [
{
"pluginId": "telemetry",
@ -346,13 +310,93 @@
"section": "def-public.TelemetryServicePublicApis",
"text": "TelemetryServicePublicApis"
}
]
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 66
},
"deprecated": false
},
{
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginStart.telemetryNotifications",
"type": "Object",
"tags": [],
"label": "telemetryNotifications",
"description": [
"Notification helpers"
],
"signature": [
"{ setOptedInNoticeSeen: () => Promise<void>; }"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 68
},
"deprecated": false
},
{
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginStart.telemetryConstants",
"type": "Object",
"tags": [],
"label": "telemetryConstants",
"description": [
"Set of publicly exposed telemetry constants"
],
"signature": [
"{ getPrivacyStatementUrl: () => string; }"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 73
},
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginSetup",
"type": "Interface",
"tags": [],
"label": "TelemetryPluginSetup",
"description": [
"\nPublic's setup exposed APIs by the telemetry plugin"
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 56
},
"deprecated": false,
"children": [
{
"parentPluginId": "telemetry",
"id": "def-public.TelemetryPluginSetup.telemetryService",
"type": "Object",
"tags": [],
"label": "telemetryService",
"description": [
"{@link TelemetryService}"
],
"signature": [
{
"pluginId": "telemetry",
"scope": "public",
"docId": "kibTelemetryPluginApi",
"section": "def-public.TelemetryServicePublicApis",
"text": "TelemetryServicePublicApis"
}
],
"source": {
"path": "src/plugins/telemetry/public/plugin.ts",
"lineNumber": 58
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
@ -362,18 +406,25 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryBasePayload",
"type": "Interface",
"tags": [],
"label": "DataTelemetryBasePayload",
"description": [
"\nCommon counters for the {@link DataTelemetryDocument}s"
],
"tags": [],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryBasePayload.index_count",
"type": "number",
"tags": [],
"label": "index_count",
"description": [
"How many indices match the declared pattern"
@ -381,67 +432,75 @@
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 22
}
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryBasePayload.ecs_index_count",
"type": "number",
"tags": [],
"label": "ecs_index_count",
"description": [
"How many indices match the declared pattern follow ECS conventions"
],
"signature": [
"number | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 24
},
"signature": [
"number | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryBasePayload.doc_count",
"type": "number",
"tags": [],
"label": "doc_count",
"description": [
"How many documents are among all the identified indices"
],
"signature": [
"number | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 26
},
"signature": [
"number | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryBasePayload.size_in_bytes",
"type": "number",
"tags": [],
"label": "size_in_bytes",
"description": [
"Total size in bytes among all the identified indices"
],
"signature": [
"number | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 28
},
"signature": [
"number | undefined"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryDocument",
"type": "Interface",
"tags": [],
"label": "DataTelemetryDocument",
"description": [
"\nDepending on the type of index, we'll populate different keys as we identify them."
],
"signature": [
{
"pluginId": "telemetry",
@ -459,86 +518,96 @@
"text": "DataTelemetryBasePayload"
}
],
"description": [
"\nDepending on the type of index, we'll populate different keys as we identify them."
],
"tags": [],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryDocument.data_stream",
"type": "Object",
"tags": [],
"label": "data_stream",
"description": [
"For data-stream indices. Reporting their details"
],
"signature": [
"{ dataset?: string | undefined; type?: string | undefined; } | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 36
},
"signature": [
"{ dataset?: string | undefined; type?: string | undefined; } | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryDocument.package",
"type": "Object",
"tags": [],
"label": "package",
"description": [
"When available, reporting the package details"
],
"signature": [
"{ name: string; } | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 43
},
"signature": [
"{ name: string; } | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryDocument.shipper",
"type": "string",
"tags": [],
"label": "shipper",
"description": [
"What's the process indexing the data? (i.e.: \"beats\", \"logstash\")"
],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 48
},
"signature": [
"string | undefined"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryDocument.pattern_name",
"type": "CompoundType",
"tags": [],
"label": "pattern_name",
"description": [
"When the data comes from a matching index-pattern, the name of the pattern"
],
"signature": [
"\"search\" | \"logstash\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"metricbeat\" | \"apm\" | \"functionbeat\" | \"heartbeat\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"zeek\" | \"sigma_doc\" | \"ecs-corelight\" | \"suricata\" | \"wazuh\" | \"meow\" | undefined"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 50
},
"signature": [
"\"search\" | \"logstash\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"metricbeat\" | \"apm\" | \"functionbeat\" | \"heartbeat\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"zeek\" | \"sigma_doc\" | \"ecs-corelight\" | \"suricata\" | \"wazuh\" | \"meow\" | undefined"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 34
},
"initialIsOpen": false
},
{
"parentPluginId": "telemetry",
"id": "def-server.NodeUsage",
"type": "Interface",
"tags": [],
"label": "NodeUsage",
"description": [
"\nData returned by GET /_nodes/usage, but flattened as an array of {@link estypes.NodeUsageInformation}\nwith the node ID set in the field `node_id`."
],
"signature": [
{
"pluginId": "telemetry",
@ -550,15 +619,17 @@
" extends ",
"NodeUsageInformation"
],
"description": [
"\nData returned by GET /_nodes/usage, but flattened as an array of {@link estypes.NodeUsageInformation}\nwith the node ID set in the field `node_id`."
],
"tags": [],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_nodes_usage.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetry",
"id": "def-server.NodeUsage.node_id",
"type": "string",
"tags": [],
"label": "node_id",
"description": [
"\nThe Node ID as reported by ES"
@ -566,119 +637,128 @@
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_nodes_usage.ts",
"lineNumber": 21
}
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_nodes_usage.ts",
"lineNumber": 17
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "telemetry",
"id": "def-server.DataTelemetryPayload",
"type": "Type",
"label": "DataTelemetryPayload",
"tags": [],
"label": "DataTelemetryPayload",
"description": [
"\nThe Data Telemetry is reported as an array of {@link DataTelemetryDocument}"
],
"signature": [
"DataTelemetryDocument[]"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts",
"lineNumber": 56
},
"signature": [
"DataTelemetryDocument[]"
],
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "telemetry",
"id": "def-server.TelemetryLocalStats",
"type": "Type",
"label": "TelemetryLocalStats",
"tags": [],
"label": "TelemetryLocalStats",
"description": [
"\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; }; }"
],
"source": {
"path": "src/plugins/telemetry/server/telemetry_collection/get_local_stats.ts",
"lineNumber": 54
},
"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; }; }"
],
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "telemetry",
"id": "def-server.TelemetryPluginSetup",
"type": "Interface",
"tags": [],
"label": "TelemetryPluginSetup",
"description": [
"\nServer's setup exposed APIs by the telemetry plugin"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.TelemetryPluginSetup.getTelemetryUrl",
"type": "Function",
"label": "getTelemetryUrl",
"description": [
"\nResolves into the telemetry Url used to send telemetry.\nThe url is wrapped with node's [URL constructor](https://nodejs.org/api/url.html)."
],
"source": {
"path": "src/plugins/telemetry/server/plugin.ts",
"lineNumber": 56
},
"signature": [
"() => Promise<",
"URL",
">"
]
}
],
"source": {
"path": "src/plugins/telemetry/server/plugin.ts",
"lineNumber": 51
},
"deprecated": false,
"children": [
{
"parentPluginId": "telemetry",
"id": "def-server.TelemetryPluginSetup.getTelemetryUrl",
"type": "Function",
"tags": [],
"label": "getTelemetryUrl",
"description": [
"\nResolves into the telemetry Url used to send telemetry.\nThe url is wrapped with node's [URL constructor](https://nodejs.org/api/url.html)."
],
"signature": [
"() => Promise<",
"URL",
">"
],
"source": {
"path": "src/plugins/telemetry/server/plugin.ts",
"lineNumber": 56
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "telemetry",
"id": "def-server.TelemetryPluginStart",
"type": "Interface",
"tags": [],
"label": "TelemetryPluginStart",
"description": [
"\nServer's start exposed APIs by the telemetry plugin"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.TelemetryPluginStart.getIsOptedIn",
"type": "Function",
"label": "getIsOptedIn",
"description": [
"\nResolves `true` if the user has opted into send Elastic usage data.\nResolves `false` if the user explicitly opted out of sending usage data to Elastic\nor did not choose to opt-in or out -yet- after a minor or major upgrade (only when previously opted-out)."
],
"source": {
"path": "src/plugins/telemetry/server/plugin.ts",
"lineNumber": 68
},
"signature": [
"() => Promise<boolean>"
]
}
],
"source": {
"path": "src/plugins/telemetry/server/plugin.ts",
"lineNumber": 62
},
"deprecated": false,
"children": [
{
"parentPluginId": "telemetry",
"id": "def-server.TelemetryPluginStart.getIsOptedIn",
"type": "Function",
"tags": [],
"label": "getIsOptedIn",
"description": [
"\nResolves `true` if the user has opted into send Elastic usage data.\nResolves `false` if the user explicitly opted out of sending usage data to Elastic\nor did not choose to opt-in or out -yet- after a minor or major upgrade (only when previously opted-out)."
],
"signature": [
"() => Promise<boolean>"
],
"source": {
"path": "src/plugins/telemetry/server/plugin.ts",
"lineNumber": 68
},
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}

342
api_docs/telemetry_collection_manager.json
View file

@ -13,47 +13,54 @@
"functions": [],
"interfaces": [
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.ClusterDetails",
"type": "Interface",
"tags": [],
"label": "ClusterDetails",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 52
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.ClusterDetails.clusterUuid",
"type": "string",
"tags": [],
"label": "clusterUuid",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 53
}
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 52
},
"initialIsOpen": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionConfig",
"type": "Interface",
"tags": [],
"label": "StatsCollectionConfig",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 56
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionConfig.usageCollection",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 57
},
"signature": [
{
"pluginId": "usageCollection",
@ -62,18 +69,20 @@
"section": "def-server.UsageCollectionSetup",
"text": "UsageCollectionSetup"
}
]
},
{
"tags": [],
"id": "def-server.StatsCollectionConfig.esClient",
"type": "CompoundType",
"label": "esClient",
"description": [],
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 58
"lineNumber": 57
},
"deprecated": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionConfig.esClient",
"type": "CompoundType",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
{
"pluginId": "core",
@ -82,18 +91,20 @@
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
]
},
{
"tags": [],
"id": "def-server.StatsCollectionConfig.soClient",
"type": "Object",
"label": "soClient",
"description": [],
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 59
"lineNumber": 58
},
"deprecated": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionConfig.soClient",
"type": "Object",
"tags": [],
"label": "soClient",
"description": [],
"signature": [
"Pick<",
{
@ -104,18 +115,20 @@
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
]
},
{
"tags": [],
"id": "def-server.StatsCollectionConfig.kibanaRequest",
"type": "Object",
"label": "kibanaRequest",
"description": [],
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 60
"lineNumber": 59
},
"deprecated": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionConfig.kibanaRequest",
"type": "Object",
"tags": [],
"label": "kibanaRequest",
"description": [],
"signature": [
{
"pluginId": "core",
@ -125,59 +138,69 @@
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any> | undefined"
]
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 60
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 56
},
"initialIsOpen": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionContext",
"type": "Interface",
"tags": [],
"label": "StatsCollectionContext",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 77
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionContext.logger",
"type": "CompoundType",
"tags": [],
"label": "logger",
"description": [],
"signature": [
"Logger",
" | Console"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 78
},
"signature": [
"Logger",
" | Console"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsCollectionContext.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 79
}
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 77
},
"initialIsOpen": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.UsageStatsPayload",
"type": "Interface",
"tags": [],
"label": "UsageStatsPayload",
"description": [],
"signature": [
{
"pluginId": "telemetryCollectionManager",
@ -189,40 +212,38 @@
" extends ",
"BasicStatsPayload"
],
"description": [],
"tags": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 73
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.UsageStatsPayload.collectionSource",
"type": "string",
"tags": [],
"label": "collectionSource",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 74
}
},
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 73
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.ClusterDetailsGetter",
"type": "Type",
"label": "ClusterDetailsGetter",
"tags": [],
"label": "ClusterDetailsGetter",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 83
},
"signature": [
"(config: ",
{
@ -250,18 +271,20 @@
},
"[]>"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 83
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsGetter",
"type": "Type",
"label": "StatsGetter",
"tags": [],
"label": "StatsGetter",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 87
},
"signature": [
"(clustersDetails: ",
{
@ -289,139 +312,159 @@
},
") => Promise<T[]>"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 87
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.StatsGetterConfig",
"type": "Type",
"label": "StatsGetterConfig",
"tags": [],
"label": "StatsGetterConfig",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 82
},
"signature": [
"UnencryptedStatsGetterConfig",
" | ",
"EncryptedStatsGetterConfig"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 82
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginSetup",
"type": "Interface",
"tags": [],
"label": "TelemetryCollectionManagerPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginSetup.setCollectionStrategy",
"type": "Function",
"tags": [],
"label": "setCollectionStrategy",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 19
},
"signature": [
"<T extends ",
"BasicStatsPayload",
">(collectionConfig: ",
"CollectionStrategyConfig",
"<T>) => void"
]
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginSetup.getOptInStats",
"type": "Function",
"tags": [],
"label": "getOptInStats",
"description": [],
"signature": [
"(optInStatus: boolean, config: ",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.StatsGetterConfig",
"text": "StatsGetterConfig"
},
") => Promise<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginSetup.getStats",
"type": "Function",
"tags": [],
"label": "getStats",
"description": [],
"signature": [
"(optInStatus: boolean, config: ",
"{ (config: ",
"UnencryptedStatsGetterConfig",
"): Promise<",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.StatsGetterConfig",
"text": "StatsGetterConfig"
"section": "def-server.UsageStatsPayload",
"text": "UsageStatsPayload"
},
") => Promise<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
]
},
{
"tags": [],
"id": "def-server.TelemetryCollectionManagerPluginSetup.getStats",
"type": "Function",
"label": "getStats",
"description": [],
"[]>; (config: ",
"EncryptedStatsGetterConfig",
"): Promise<string[]>; }"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 23
},
"signature": [
"{ (config: ",
"UnencryptedStatsGetterConfig",
"): Promise<",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.UsageStatsPayload",
"text": "UsageStatsPayload"
},
"[]>; (config: ",
"EncryptedStatsGetterConfig",
"): Promise<string[]>; }"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginSetup.areAllCollectorsReady",
"type": "Function",
"tags": [],
"label": "areAllCollectorsReady",
"description": [],
"signature": [
"() => Promise<boolean | undefined>"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 24
},
"signature": [
"() => Promise<boolean | undefined>"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 18
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginStart",
"type": "Interface",
"tags": [],
"label": "TelemetryCollectionManagerPluginStart",
"description": [],
"tags": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginStart.getOptInStats",
"type": "Function",
"tags": [],
"label": "getOptInStats",
"description": [],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 28
},
"signature": [
"(optInStatus: boolean, config: ",
{
@ -432,18 +475,20 @@
"text": "StatsGetterConfig"
},
") => Promise<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
]
},
{
"tags": [],
"id": "def-server.TelemetryCollectionManagerPluginStart.getStats",
"type": "Function",
"label": "getStats",
"description": [],
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 29
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginStart.getStats",
"type": "Function",
"tags": [],
"label": "getStats",
"description": [],
"signature": [
"{ (config: ",
"UnencryptedStatsGetterConfig",
@ -458,27 +503,30 @@
"[]>; (config: ",
"EncryptedStatsGetterConfig",
"): Promise<string[]>; }"
]
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 29
},
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetryCollectionManager",
"id": "def-server.TelemetryCollectionManagerPluginStart.areAllCollectorsReady",
"type": "Function",
"tags": [],
"label": "areAllCollectorsReady",
"description": [],
"signature": [
"() => Promise<boolean | undefined>"
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 30
},
"signature": [
"() => Promise<boolean | undefined>"
]
"deprecated": false
}
],
"source": {
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
"lineNumber": 27
},
"lifecycle": "start",
"initialIsOpen": true
}

10
api_docs/telemetry_collection_xpack.json
View file

@ -15,18 +15,20 @@
"enums": [],
"misc": [
{
"parentPluginId": "telemetryCollectionXpack",
"id": "def-server.ESLicense",
"type": "Type",
"label": "ESLicense",
"tags": [],
"label": "ESLicense",
"description": [],
"signature": [
"estypes.LicenseInformation"
],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 10
},
"signature": [
"estypes.LicenseInformation"
],
"deprecated": false,
"initialIsOpen": false
}
],

181
api_docs/telemetry_management_section.json
View file

@ -3,6 +3,7 @@
"client": {
"classes": [
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout",
"type": "Class",
"tags": [],
@ -20,157 +21,179 @@
},
" extends React.PureComponent<Props, State, any>"
],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 40
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout._isMounted",
"type": "boolean",
"tags": [],
"label": "_isMounted",
"description": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 41
}
},
"deprecated": false
},
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.state.data",
"type": "Uncategorized",
"tags": [],
"label": "data",
"description": [],
"signature": [
"null"
],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 44
},
"signature": [
"null"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.state.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"signature": [
"true"
],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 45
},
"signature": [
"true"
]
"deprecated": false
},
{
"tags": [],
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.state.hasPrivilegeToRead",
"type": "boolean",
"tags": [],
"label": "hasPrivilegeToRead",
"description": [],
"signature": [
"false"
],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 46
},
"signature": [
"false"
]
"deprecated": false
}
],
"description": [],
"label": "state",
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 43
}
]
},
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.componentDidMount",
"type": "Function",
"tags": [],
"label": "componentDidMount",
"description": [],
"signature": [
"() => Promise<void>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 49
}
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.componentWillUnmount",
"type": "Function",
"tags": [],
"label": "componentWillUnmount",
"description": [],
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 70
}
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.renderBody",
"type": "Function",
"tags": [],
"label": "renderBody",
"description": [],
"signature": [
"({ data, isLoading, hasPrivilegeToRead }: State) => JSX.Element"
],
"description": [],
"children": [
{
"id": "def-public.OptInExampleFlyout.renderBody.$1",
"type": "Object",
"label": "{ data, isLoading, hasPrivilegeToRead }",
"isRequired": true,
"signature": [
"State"
],
"description": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 74
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 74
}
},
"deprecated": false,
"children": [
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.renderBody.$1",
"type": "Object",
"tags": [],
"label": "{ data, isLoading, hasPrivilegeToRead }",
"description": [],
"signature": [
"State"
],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 74
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.OptInExampleFlyout.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"() => JSX.Element"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 124
}
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
"lineNumber": 40
},
"initialIsOpen": false
}
],
@ -180,31 +203,35 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "telemetryManagementSection",
"id": "def-public.TelemetryManagementSectionPluginSetup",
"type": "Interface",
"tags": [],
"label": "TelemetryManagementSectionPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.TelemetryManagementSectionPluginSetup.toggleSecuritySolutionExample",
"type": "Function",
"label": "toggleSecuritySolutionExample",
"description": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
"lineNumber": 38
},
"signature": [
"(enabled: boolean) => void"
]
}
],
"source": {
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "telemetryManagementSection",
"id": "def-public.TelemetryManagementSectionPluginSetup.toggleSecuritySolutionExample",
"type": "Function",
"tags": [],
"label": "toggleSecuritySolutionExample",
"description": [],
"signature": [
"(enabled: boolean) => void"
],
"source": {
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
"lineNumber": 38
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}

58
api_docs/timelines.json
View file

@ -8,35 +8,39 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "timelines",
"id": "def-public.TimelinesPluginSetup",
"type": "Interface",
"tags": [],
"label": "TimelinesPluginSetup",
"description": [],
"tags": [],
"source": {
"path": "x-pack/plugins/timelines/public/types.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"tags": [],
"parentPluginId": "timelines",
"id": "def-public.TimelinesPluginSetup.getTimeline",
"type": "Function",
"tags": [],
"label": "getTimeline",
"description": [],
"source": {
"path": "x-pack/plugins/timelines/public/types.ts",
"lineNumber": 11
},
"signature": [
"((props: ",
"TimelineProps",
") => React.ReactElement<",
"TimelineProps",
", string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>) | undefined"
]
],
"source": {
"path": "x-pack/plugins/timelines/public/types.ts",
"lineNumber": 11
},
"deprecated": false
}
],
"source": {
"path": "x-pack/plugins/timelines/public/types.ts",
"lineNumber": 10
},
"lifecycle": "setup",
"initialIsOpen": true
}
@ -49,30 +53,34 @@
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "timelines",
"id": "def-server.TimelinesPluginSetup",
"type": "Interface",
"tags": [],
"label": "TimelinesPluginSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/timelines/server/types.ts",
"lineNumber": 9
},
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "timelines",
"id": "def-server.TimelinesPluginStart",
"type": "Interface",
"tags": [],
"label": "TimelinesPluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/timelines/server/types.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
@ -84,33 +92,37 @@
"enums": [],
"misc": [
{
"tags": [],
"parentPluginId": "timelines",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"timelines\""
],
"source": {
"path": "x-pack/plugins/timelines/common/index.ts",
"lineNumber": 8
},
"signature": [
"\"timelines\""
],
"deprecated": false,
"initialIsOpen": false
},
{
"tags": [],
"parentPluginId": "timelines",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"timelines\""
],
"source": {
"path": "x-pack/plugins/timelines/common/index.ts",
"lineNumber": 9
},
"signature": [
"\"timelines\""
],
"deprecated": false,
"initialIsOpen": false
}
],

2783
api_docs/triggers_actions_ui.json
View file

File diff suppressed because it is too large Load diff

1936
api_docs/ui_actions.json
View file

File diff suppressed because it is too large Load diff

2868
api_docs/ui_actions_enhanced.json
View file

File diff suppressed because it is too large Load diff

118
api_docs/uptime.json
View file

@ -12,38 +12,12 @@
"classes": [],
"functions": [
{
"parentPluginId": "uptime",
"id": "def-server.initServerWithKibana",
"type": "Function",
"children": [
{
"id": "def-server.initServerWithKibana.$1",
"type": "Object",
"label": "server",
"isRequired": true,
"signature": [
"UptimeCoreSetup"
],
"description": [],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
}
},
{
"id": "def-server.initServerWithKibana.$2",
"type": "Object",
"label": "plugins",
"isRequired": true,
"signature": [
"UptimeCorePlugins"
],
"description": [],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
}
}
],
"tags": [],
"label": "initServerWithKibana",
"description": [],
"signature": [
"(server: ",
"UptimeCoreSetup",
@ -51,22 +25,59 @@
"UptimeCorePlugins",
") => void"
],
"description": [],
"label": "initServerWithKibana",
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
},
"tags": [],
"deprecated": false,
"children": [
{
"parentPluginId": "uptime",
"id": "def-server.initServerWithKibana.$1",
"type": "Object",
"tags": [],
"label": "server",
"description": [],
"signature": [
"UptimeCoreSetup"
],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "uptime",
"id": "def-server.initServerWithKibana.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"UptimeCorePlugins"
],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "uptime",
"id": "def-server.KibanaServer",
"type": "Interface",
"tags": [],
"label": "KibanaServer",
"description": [],
"signature": [
{
"pluginId": "uptime",
@ -78,30 +89,31 @@
" extends ",
"Server"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.KibanaServer.route",
"type": "Function",
"label": "route",
"description": [],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 25
},
"signature": [
"(options: ",
"KibanaRouteOptions",
") => void"
]
}
],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "uptime",
"id": "def-server.KibanaServer.route",
"type": "Function",
"tags": [],
"label": "route",
"description": [],
"signature": [
"(options: ",
"KibanaRouteOptions",
") => void"
],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 25
},
"deprecated": false
}
],
"initialIsOpen": false
}
],

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