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

API DOCS Step 3/3 (#92929)

Browse source 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Stacey Gammon 2021-03-02 22:02:17 -05:00 • committed by GitHub
parent a36b64e7a8
commit 87a5b22626
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
215 changed files with 284786 additions and 111 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,6 +1,5 @@
.aws-config.json
.signing-config.json
/api_docs
.ackrc
/.es
/.chromium

1775
api_docs/actions.json Normal file
View file

File diff suppressed because it is too large Load diff

41
api_docs/actions.mdx Normal file
View file

@ -0,0 +1,41 @@
---
id: kibActionsPluginApi
slug: /kibana-dev-docs/actionsPluginApi
title: actions
image: https://source.unsplash.com/400x175/?github
summary: API docs for the actions plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import actionsObj from './actions.json';
## Server
### Setup
<DocDefinitionList data={[actionsObj.server.setup]}/>
### Start
<DocDefinitionList data={[actionsObj.server.start]}/>
### Functions
<DocDefinitionList data={actionsObj.server.functions}/>
### Interfaces
<DocDefinitionList data={actionsObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={actionsObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={actionsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={actionsObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={actionsObj.common.misc}/>

301
api_docs/advanced_settings.json Normal file
View file

@ -0,0 +1,301 @@
{
"id": "advancedSettings",
"client": {
"classes": [
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L28"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L30"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L31"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L32"
},
"signature": [
"() => null"
]
}
],
"description": [],
"label": "defaultRegistry",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L29"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L35"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L72"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L73"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L71"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L77"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L78"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L76"
}
}
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L27"
},
"initialIsOpen": false
}
],
"functions": [
{
"tags": [],
"id": "def-public.LazyField",
"type": "Function",
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/index.ts#L20"
},
"signature": [
"React.LazyExoticComponent<typeof ",
"Field",
">"
],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.AdvancedSettingsSetup",
"type": "Interface",
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L16"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L15"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.AdvancedSettingsStart",
"type": "Interface",
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L19"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L18"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

27
api_docs/advanced_settings.mdx Normal file
View file

@ -0,0 +1,27 @@
---
id: kibAdvancedSettingsPluginApi
slug: /kibana-dev-docs/advancedSettingsPluginApi
title: advancedSettings
image: https://source.unsplash.com/400x175/?github
summary: API docs for the advancedSettings plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import advancedSettingsObj from './advanced_settings.json';
## Client
### Setup
<DocDefinitionList data={[advancedSettingsObj.client.setup]}/>
### Start
<DocDefinitionList data={[advancedSettingsObj.client.start]}/>
### Functions
<DocDefinitionList data={advancedSettingsObj.client.functions}/>
### Classes
<DocDefinitionList data={advancedSettingsObj.client.classes}/>

3419
api_docs/alerts.json Normal file
View file

File diff suppressed because it is too large Load diff

49
api_docs/alerts.mdx Normal file
View file

@ -0,0 +1,49 @@
---
id: kibAlertsPluginApi
slug: /kibana-dev-docs/alertsPluginApi
title: alerts
image: https://source.unsplash.com/400x175/?github
summary: API docs for the alerts plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerts']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import alertsObj from './alerts.json';
## Client
### Setup
<DocDefinitionList data={[alertsObj.client.setup]}/>
### Start
<DocDefinitionList data={[alertsObj.client.start]}/>
## Server
### Functions
<DocDefinitionList data={alertsObj.server.functions}/>
### Interfaces
<DocDefinitionList data={alertsObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={alertsObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={alertsObj.common.objects}/>
### Functions
<DocDefinitionList data={alertsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={alertsObj.common.interfaces}/>
### Enums
<DocDefinitionList data={alertsObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={alertsObj.common.misc}/>

808
api_docs/apm.json Normal file
View file

@ -0,0 +1,808 @@
{
"id": "apm",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.ConfigSchema",
"type": "Interface",
"label": "ConfigSchema",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ConfigSchema.serviceMapEnabled",
"type": "boolean",
"label": "serviceMapEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L15"
}
},
{
"tags": [],
"id": "def-public.ConfigSchema.profilingEnabled",
"type": "boolean",
"label": "profilingEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L16"
}
},
{
"tags": [],
"id": "def-public.ConfigSchema.ui",
"type": "Object",
"label": "ui",
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L17"
},
"signature": [
"{ enabled: boolean; }"
]
}
],
"source": {
"path": "x-pack/plugins/apm/public/index.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L14"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"id": "def-public.ApmPluginStart",
"type": "Type",
"label": "ApmPluginStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/plugin.ts#L45"
},
"signature": [
"void"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"id": "def-server.APMPlugin",
"type": "Class",
"tags": [],
"label": "APMPlugin",
"description": [],
"signature": [
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMPlugin",
"text": "APMPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMPluginSetup",
"text": "APMPluginSetup"
},
", void, object, object>"
],
"children": [
{
"id": "def-server.APMPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "initContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L61"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L61"
}
},
{
"id": "def-server.APMPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, plugins: { apmOss: ",
{
"pluginId": "apmOss",
"scope": "server",
"docId": "kibApmOssPluginApi",
"section": "def-server.APMOSSPluginSetup",
"text": "APMOSSPluginSetup"
},
"; home: ",
{
"pluginId": "home",
"scope": "server",
"docId": "kibHomePluginApi",
"section": "def-server.HomeServerPluginSetup",
"text": "HomeServerPluginSetup"
},
"; licensing: ",
{
"pluginId": "licensing",
"scope": "server",
"docId": "kibLicensingPluginApi",
"section": "def-server.LicensingPluginSetup",
"text": "LicensingPluginSetup"
},
"; cloud?: ",
{
"pluginId": "cloud",
"scope": "server",
"docId": "kibCloudPluginApi",
"section": "def-server.CloudSetup",
"text": "CloudSetup"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L66"
}
},
{
"id": "def-server.APMPlugin.setup.plugins",
"type": "Object",
"label": "plugins",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.apmOss",
"type": "Object",
"label": "apmOss",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L68"
},
"signature": [
{
"pluginId": "apmOss",
"scope": "server",
"docId": "kibApmOssPluginApi",
"section": "def-server.APMOSSPluginSetup",
"text": "APMOSSPluginSetup"
}
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.home",
"type": "Object",
"label": "home",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L69"
},
"signature": [
{
"pluginId": "home",
"scope": "server",
"docId": "kibHomePluginApi",
"section": "def-server.HomeServerPluginSetup",
"text": "HomeServerPluginSetup"
}
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.licensing",
"type": "Object",
"label": "licensing",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 70,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L70"
},
"signature": [
{
"pluginId": "licensing",
"scope": "server",
"docId": "kibLicensingPluginApi",
"section": "def-server.LicensingPluginSetup",
"text": "LicensingPluginSetup"
}
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.cloud",
"type": "Object",
"label": "cloud",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L71"
},
"signature": [
{
"pluginId": "cloud",
"scope": "server",
"docId": "kibCloudPluginApi",
"section": "def-server.CloudSetup",
"text": "CloudSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.usageCollection",
"type": "Object",
"label": "usageCollection",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L72"
},
"signature": [
"Pick<",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorSet",
"text": "CollectorSet"
},
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.taskManager",
"type": "CompoundType",
"label": "taskManager",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L73"
},
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerSetupContract",
"text": "TaskManagerSetupContract"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.alerts",
"type": "Object",
"label": "alerts",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 74,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L74"
},
"signature": [
{
"pluginId": "alerts",
"scope": "server",
"docId": "kibAlertsPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L75"
},
"signature": [
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.observability",
"type": "Object",
"label": "observability",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L76"
},
"signature": [
{
"pluginId": "observability",
"scope": "server",
"docId": "kibObservabilityPluginApi",
"section": "def-server.ObservabilityPluginSetup",
"text": "ObservabilityPluginSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.features",
"type": "Object",
"label": "features",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L77"
},
"signature": [
{
"pluginId": "features",
"scope": "server",
"docId": "kibFeaturesPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
}
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.security",
"type": "Object",
"label": "security",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 78,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L78"
},
"signature": [
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.SecurityPluginSetup",
"text": "SecurityPluginSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.APMPlugin.setup.plugins.ml",
"type": "CompoundType",
"label": "ml",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 79,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L79"
},
"signature": [
{
"pluginId": "ml",
"scope": "server",
"docId": "kibMlPluginApi",
"section": "def-server.SharedServices",
"text": "SharedServices"
},
" | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L67"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L65"
}
},
{
"id": "def-server.APMPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 196,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L196"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 196,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L196"
}
},
{
"id": "def-server.APMPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 215,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L215"
}
}
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L58"
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-server.mergeConfigs",
"type": "Function",
"label": "mergeConfigs",
"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",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>) => { '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; }"
],
"description": [],
"children": [
{
"type": "Object",
"label": "apmOssConfig",
"isRequired": true,
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L60"
}
},
{
"type": "Object",
"label": "apmConfig",
"isRequired": true,
"signature": [
"Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
{
"pluginId": "apm",
"scope": "common",
"docId": "kibApmPluginApi",
"section": "def-common.SearchAggregatedTransactionSetting",
"text": "SearchAggregatedTransactionSetting"
},
"; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L61"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L59"
},
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"id": "def-server.ProcessorEvent",
"type": "Enum",
"label": "ProcessorEvent",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/apm/common/processor_event.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/common/processor_event.ts#L8"
},
"initialIsOpen": false
}
],
"misc": [
{
"id": "def-server.APMXPackConfig",
"type": "Type",
"label": "APMXPackConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L55"
},
"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; }"
],
"initialIsOpen": false
},
{
"id": "def-server.APMConfig",
"type": "Type",
"label": "APMConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
"lineNumber": 56,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L56"
},
"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; }"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-server.APMPluginSetup",
"type": "Interface",
"label": "APMPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.APMPluginSetup.config$",
"type": "Object",
"label": "config$",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L49"
},
"signature": [
"Observable",
"<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
{
"pluginId": "apm",
"scope": "common",
"docId": "kibApmPluginApi",
"section": "def-common.SearchAggregatedTransactionSetting",
"text": "SearchAggregatedTransactionSetting"
},
"; 'xpack.apm.metricsInterval': number; }>"
]
},
{
"tags": [],
"id": "def-server.APMPluginSetup.getApmIndices",
"type": "Function",
"label": "getApmIndices",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L50"
},
"signature": [
"() => Promise<",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.ApmIndicesConfig",
"text": "ApmIndicesConfig"
},
">"
]
},
{
"tags": [],
"id": "def-server.APMPluginSetup.createApmEventClient",
"type": "Function",
"label": "createApmEventClient",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L51"
},
"signature": [
"(params: { debug?: boolean | undefined; request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>; context: ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.ApmPluginRequestHandlerContext",
"text": "ApmPluginRequestHandlerContext"
},
"; }) => Promise<{ search<TParams extends ",
{
"pluginId": "apm",
"scope": "server",
"docId": "kibApmPluginApi",
"section": "def-server.APMEventESSearchRequest",
"text": "APMEventESSearchRequest"
},
">(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<",
"ESSearchResponse",
"<TypeOfProcessorEvent<",
"ValuesType"
]
}
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L48"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

38
api_docs/apm.mdx Normal file
View file

@ -0,0 +1,38 @@
---
id: kibApmPluginApi
slug: /kibana-dev-docs/apmPluginApi
title: apm
image: https://source.unsplash.com/400x175/?github
summary: API docs for the apm plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import apmObj from './apm.json';
## Client
### Start
<DocDefinitionList data={[apmObj.client.start]}/>
### Interfaces
<DocDefinitionList data={apmObj.client.interfaces}/>
## Server
### Setup
<DocDefinitionList data={[apmObj.server.setup]}/>
### Functions
<DocDefinitionList data={apmObj.server.functions}/>
### Classes
<DocDefinitionList data={apmObj.server.classes}/>
### Enums
<DocDefinitionList data={apmObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={apmObj.server.misc}/>

635
api_docs/apm_oss.json Normal file
View file

@ -0,0 +1,635 @@
{
"id": "apmOss",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.APM_STATIC_INDEX_PATTERN_ID",
"type": "string",
"label": "APM_STATIC_INDEX_PATTERN_ID",
"description": [],
"source": {
"path": "src/plugins/apm_oss/common/index_pattern_constants.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9"
},
"signature": [
"\"apm_static_index_pattern_id\""
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.ApmOssPluginSetup",
"type": "Interface",
"label": "ApmOssPluginSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "src/plugins/apm_oss/public/types.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L10"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.ApmOssPluginStart",
"type": "Interface",
"label": "ApmOssPluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "src/plugins/apm_oss/public/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L13"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"id": "def-server.createNodeAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createNodeAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createDjangoAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createDjangoAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createFlaskAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 173,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 173,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createFlaskAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 173,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createRailsAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createRailsAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createRackAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 298,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 298,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createRackAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 298,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createJsAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 393,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393"
}
}
],
"signature": [
"(apmServerUrl?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; textPre: string; commands: string[]; textPost?: undefined; })[]"
],
"description": [],
"label": "createJsAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 393,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createGoAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 492,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 492,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createGoAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 492,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createJavaAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 585,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 585,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createJavaAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 585,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createDotNetAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 631,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 631,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; commands: string[]; textPost: string; textPre?: undefined; })[]"
],
"description": [],
"label": "createDotNetAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 631,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.createPhpAgentInstructions",
"type": "Function",
"children": [
{
"type": "string",
"label": "apmServerUrl",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 705,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 705,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"
}
}
],
"signature": [
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
],
"description": [],
"label": "createPhpAgentInstructions",
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 705,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-server.APMOSSConfig",
"type": "Type",
"label": "APMOSSConfig",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/index.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/index.ts#L32"
},
"signature": [
"{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-server.APM_STATIC_INDEX_PATTERN_ID",
"type": "string",
"label": "APM_STATIC_INDEX_PATTERN_ID",
"description": [],
"source": {
"path": "src/plugins/apm_oss/common/index_pattern_constants.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9"
},
"signature": [
"\"apm_static_index_pattern_id\""
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-server.APMOSSPluginSetup",
"type": "Interface",
"label": "APMOSSPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.APMOSSPluginSetup.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/plugin.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L48"
},
"signature": [
"Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"
]
},
{
"tags": [],
"id": "def-server.APMOSSPluginSetup.config$",
"type": "Object",
"label": "config$",
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/plugin.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L49"
},
"signature": [
"Observable",
"<Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>>"
]
},
{
"id": "def-server.APMOSSPluginSetup.getRegisteredTutorialProvider",
"type": "Function",
"label": "getRegisteredTutorialProvider",
"signature": [
"() => ",
{
"pluginId": "home",
"scope": "server",
"docId": "kibHomePluginApi",
"section": "def-server.TutorialProvider",
"text": "TutorialProvider"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/apm_oss/server/plugin.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L50"
}
}
],
"source": {
"path": "src/plugins/apm_oss/server/plugin.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L47"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

35
api_docs/apm_oss.mdx Normal file
View file

@ -0,0 +1,35 @@
---
id: kibApmOssPluginApi
slug: /kibana-dev-docs/apmOssPluginApi
title: apmOss
image: https://source.unsplash.com/400x175/?github
summary: API docs for the apmOss plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmOss']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import apmOssObj from './apm_oss.json';
## Client
### Setup
<DocDefinitionList data={[apmOssObj.client.setup]}/>
### Start
<DocDefinitionList data={[apmOssObj.client.start]}/>
### Consts, variables and types
<DocDefinitionList data={apmOssObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[apmOssObj.server.setup]}/>
### Functions
<DocDefinitionList data={apmOssObj.server.functions}/>
### Consts, variables and types
<DocDefinitionList data={apmOssObj.server.misc}/>

165
api_docs/banners.json Normal file
View file

@ -0,0 +1,165 @@
{
"id": "banners",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.BannerInfoResponse",
"type": "Interface",
"label": "BannerInfoResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BannerInfoResponse.allowed",
"type": "boolean",
"label": "allowed",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L9"
}
},
{
"tags": [],
"id": "def-common.BannerInfoResponse.banner",
"type": "Object",
"label": "banner",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L10"
},
"signature": [
{
"pluginId": "banners",
"scope": "common",
"docId": "kibBannersPluginApi",
"section": "def-common.BannerConfiguration",
"text": "BannerConfiguration"
}
]
}
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L8"
},
"initialIsOpen": false
},
{
"id": "def-common.BannerConfiguration",
"type": "Interface",
"label": "BannerConfiguration",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BannerConfiguration.placement",
"type": "CompoundType",
"label": "placement",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L16"
},
"signature": [
{
"pluginId": "banners",
"scope": "common",
"docId": "kibBannersPluginApi",
"section": "def-common.BannerPlacement",
"text": "BannerPlacement"
}
]
},
{
"tags": [],
"id": "def-common.BannerConfiguration.textContent",
"type": "string",
"label": "textContent",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L17"
}
},
{
"tags": [],
"id": "def-common.BannerConfiguration.textColor",
"type": "string",
"label": "textColor",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L18"
}
},
{
"tags": [],
"id": "def-common.BannerConfiguration.backgroundColor",
"type": "string",
"label": "backgroundColor",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L19"
}
}
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L15"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-common.BannerPlacement",
"type": "Type",
"label": "BannerPlacement",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L13"
},
"signature": [
"\"disabled\" | \"header\""
],
"initialIsOpen": false
}
],
"objects": []
}
}

21
api_docs/banners.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibBannersPluginApi
slug: /kibana-dev-docs/bannersPluginApi
title: banners
image: https://source.unsplash.com/400x175/?github
summary: API docs for the banners plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import bannersObj from './banners.json';
## Common
### Interfaces
<DocDefinitionList data={bannersObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={bannersObj.common.misc}/>

69
api_docs/beats_management.json Normal file
View file

@ -0,0 +1,69 @@
{
"id": "beatsManagement",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-common.BeatsManagementConfigType",
"type": "Type",
"label": "BeatsManagementConfigType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/beats_management/common/index.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L23"
},
"signature": [
"{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-common.beatsManagementConfigSchema",
"type": "Object",
"label": "beatsManagementConfigSchema",
"description": [],
"source": {
"path": "x-pack/plugins/beats_management/common/index.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L12"
},
"signature": [
"ObjectType",
"<{ enabled: ",
"Type",
"<boolean>; defaultUserRoles: ",
"Type",
"<string[]>; encryptionKey: ",
"Type",
"<string>; enrollmentTokensTtlInSeconds: ",
"Type"
],
"initialIsOpen": false
}
]
}
}

21
api_docs/beats_management.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibBeatsManagementPluginApi
slug: /kibana-dev-docs/beatsManagementPluginApi
title: beatsManagement
image: https://source.unsplash.com/400x175/?github
summary: API docs for the beatsManagement plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'beatsManagement']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import beatsManagementObj from './beats_management.json';
## Common
### Objects
<DocDefinitionList data={beatsManagementObj.common.objects}/>
### Consts, variables and types
<DocDefinitionList data={beatsManagementObj.common.misc}/>

1209
api_docs/bfetch.json Normal file
View file

File diff suppressed because it is too large Load diff

49
api_docs/bfetch.mdx Normal file
View file

@ -0,0 +1,49 @@
---
id: kibBfetchPluginApi
slug: /kibana-dev-docs/bfetchPluginApi
title: bfetch
image: https://source.unsplash.com/400x175/?github
summary: API docs for the bfetch plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import bfetchObj from './bfetch.json';
## Client
### Start
<DocDefinitionList data={[bfetchObj.client.start]}/>
### Functions
<DocDefinitionList data={bfetchObj.client.functions}/>
### Consts, variables and types
<DocDefinitionList data={bfetchObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[bfetchObj.server.setup]}/>
### Start
<DocDefinitionList data={[bfetchObj.server.start]}/>
### Interfaces
<DocDefinitionList data={bfetchObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={bfetchObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={bfetchObj.common.functions}/>
### Classes
<DocDefinitionList data={bfetchObj.common.classes}/>
### Interfaces
<DocDefinitionList data={bfetchObj.common.interfaces}/>

120
api_docs/canvas.json Normal file
View file

@ -0,0 +1,120 @@
{
"id": "canvas",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.WithKibanaProps",
"type": "Interface",
"label": "WithKibanaProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.WithKibanaProps.kibana",
"type": "Object",
"label": "kibana",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/index.ts#L16"
},
"signature": [
"{ services: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
" & ",
{
"pluginId": "canvas",
"scope": "public",
"docId": "kibCanvasPluginApi",
"section": "def-public.CanvasStartDeps",
"text": "CanvasStartDeps"
},
" & { canvas: ",
{
"pluginId": "canvas",
"scope": "public",
"docId": "kibCanvasPluginApi",
"section": "def-public.CanvasServices",
"text": "CanvasServices"
},
"; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/index.ts#L15"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.CanvasSetup",
"type": "Type",
"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."
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/plugin.tsx#L63"
},
"signature": [
"CanvasApi"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.CanvasStart",
"type": "Type",
"label": "CanvasStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/plugin.tsx#L64"
},
"signature": [
"void"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

24
api_docs/canvas.mdx Normal file
View file

@ -0,0 +1,24 @@
---
id: kibCanvasPluginApi
slug: /kibana-dev-docs/canvasPluginApi
title: canvas
image: https://source.unsplash.com/400x175/?github
summary: API docs for the canvas plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import canvasObj from './canvas.json';
## Client
### Setup
<DocDefinitionList data={[canvasObj.client.setup]}/>
### Start
<DocDefinitionList data={[canvasObj.client.start]}/>
### Interfaces
<DocDefinitionList data={canvasObj.client.interfaces}/>

65
api_docs/case.json Normal file
View file

@ -0,0 +1,65 @@
{
"id": "case",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-server.CaseRequestContext",
"type": "Interface",
"label": "CaseRequestContext",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.CaseRequestContext.getCaseClient",
"type": "Function",
"label": "getCaseClient",
"description": [],
"source": {
"path": "x-pack/plugins/case/server/types.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/case/server/types.ts#L14"
},
"signature": [
"() => ",
{
"pluginId": "case",
"scope": "server",
"docId": "kibCasePluginApi",
"section": "def-server.CaseClient",
"text": "CaseClient"
}
]
}
],
"source": {
"path": "x-pack/plugins/case/server/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/case/server/types.ts#L13"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

18
api_docs/case.mdx Normal file
View file

@ -0,0 +1,18 @@
---
id: kibCasePluginApi
slug: /kibana-dev-docs/casePluginApi
title: case
image: https://source.unsplash.com/400x175/?github
summary: API docs for the case plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'case']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import caseObj from './case.json';
## Server
### Interfaces
<DocDefinitionList data={caseObj.server.interfaces}/>

2639
api_docs/charts.json Normal file
View file

File diff suppressed because it is too large Load diff

44
api_docs/charts.mdx Normal file
View file

@ -0,0 +1,44 @@
---
id: kibChartsPluginApi
slug: /kibana-dev-docs/chartsPluginApi
title: charts
image: https://source.unsplash.com/400x175/?github
summary: API docs for the charts plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import chartsObj from './charts.json';
## Client
### Start
<DocDefinitionList data={[chartsObj.client.start]}/>
### Objects
<DocDefinitionList data={chartsObj.client.objects}/>
### Functions
<DocDefinitionList data={chartsObj.client.functions}/>
### Interfaces
<DocDefinitionList data={chartsObj.client.interfaces}/>
### Enums
<DocDefinitionList data={chartsObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={chartsObj.client.misc}/>
## Common
### Functions
<DocDefinitionList data={chartsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={chartsObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={chartsObj.common.misc}/>

249
api_docs/cloud.json Normal file
View file

@ -0,0 +1,249 @@
{
"id": "cloud",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.CloudConfigType",
"type": "Interface",
"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": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L17"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.resetPasswordUrl",
"type": "string",
"label": "resetPasswordUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L18"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.deploymentUrl",
"type": "string",
"label": "deploymentUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L19"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudConfigType.accountUrl",
"type": "string",
"label": "accountUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L20"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L16"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.CloudSetup",
"type": "Interface",
"label": "CloudSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CloudSetup.cloudId",
"type": "string",
"label": "cloudId",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L32"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.cloudDeploymentUrl",
"type": "string",
"label": "cloudDeploymentUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L33"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.isCloudEnabled",
"type": "boolean",
"label": "isCloudEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L34"
}
},
{
"tags": [],
"id": "def-public.CloudSetup.resetPasswordUrl",
"type": "string",
"label": "resetPasswordUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L35"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.CloudSetup.accountUrl",
"type": "string",
"label": "accountUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L36"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L31"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-server.CloudSetup",
"type": "Interface",
"label": "CloudSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.CloudSetup.cloudId",
"type": "string",
"label": "cloudId",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L19"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.CloudSetup.isCloudEnabled",
"type": "boolean",
"label": "isCloudEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L20"
}
},
{
"tags": [],
"id": "def-server.CloudSetup.apm",
"type": "Object",
"label": "apm",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L21"
},
"signature": [
"{ url?: string | undefined; secretToken?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L18"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

26
api_docs/cloud.mdx Normal file
View file

@ -0,0 +1,26 @@
---
id: kibCloudPluginApi
slug: /kibana-dev-docs/cloudPluginApi
title: cloud
image: https://source.unsplash.com/400x175/?github
summary: API docs for the cloud plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import cloudObj from './cloud.json';
## Client
### Setup
<DocDefinitionList data={[cloudObj.client.setup]}/>
### Interfaces
<DocDefinitionList data={cloudObj.client.interfaces}/>
## Server
### Setup
<DocDefinitionList data={[cloudObj.server.setup]}/>

65
api_docs/console.json Normal file
View file

@ -0,0 +1,65 @@
{
"id": "console",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-server.ConsoleSetup",
"type": "Type",
"label": "ConsoleSetup",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/console/server/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/console/server/types.ts#L13"
},
"signature": [
"{ addExtensionSpecFilePath: (path: string) => void; }"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.ConsoleStart",
"type": "Type",
"label": "ConsoleStart",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/console/server/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/console/server/types.ts#L18"
},
"signature": [
"{ addProcessorDefinition: (processor: any) => void; }"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

21
api_docs/console.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibConsolePluginApi
slug: /kibana-dev-docs/consolePluginApi
title: console
image: https://source.unsplash.com/400x175/?github
summary: API docs for the console plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import consoleObj from './console.json';
## Server
### Setup
<DocDefinitionList data={[consoleObj.server.setup]}/>
### Start
<DocDefinitionList data={[consoleObj.server.start]}/>

17763
api_docs/core.json Normal file
View file

File diff suppressed because one or more lines are too long

38
api_docs/core.mdx Normal file
View file

@ -0,0 +1,38 @@
---
id: kibCorePluginApi
slug: /kibana-dev-docs/corePluginApi
title: core
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import coreObj from './core.json';
## Client
### Classes
<DocDefinitionList data={coreObj.client.classes}/>
### Interfaces
<DocDefinitionList data={coreObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={coreObj.client.misc}/>
## Server
### Objects
<DocDefinitionList data={coreObj.server.objects}/>
### Classes
<DocDefinitionList data={coreObj.server.classes}/>
### Interfaces
<DocDefinitionList data={coreObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={coreObj.server.misc}/>

2007
api_docs/core_application.json Normal file
View file

File diff suppressed because it is too large Load diff

27
api_docs/core_application.mdx Normal file
View file

@ -0,0 +1,27 @@
---
id: kibCoreApplicationPluginApi
slug: /kibana-dev-docs/core.applicationPluginApi
title: core.application
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.application plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import coreApplicationObj from './core_application.json';
## Client
### Classes
<DocDefinitionList data={coreApplicationObj.client.classes}/>
### Interfaces
<DocDefinitionList data={coreApplicationObj.client.interfaces}/>
### Enums
<DocDefinitionList data={coreApplicationObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={coreApplicationObj.client.misc}/>

2537
api_docs/core_chrome.json Normal file
View file

File diff suppressed because it is too large Load diff

21
api_docs/core_chrome.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibCoreChromePluginApi
slug: /kibana-dev-docs/core.chromePluginApi
title: core.chrome
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.chrome plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import coreChromeObj from './core_chrome.json';
## Client
### Interfaces
<DocDefinitionList data={coreChromeObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={coreChromeObj.client.misc}/>

7035
api_docs/core_http.json Normal file
View file

File diff suppressed because it is too large Load diff

38
api_docs/core_http.mdx Normal file
View file

@ -0,0 +1,38 @@
---
id: kibCoreHttpPluginApi
slug: /kibana-dev-docs/core.httpPluginApi
title: core.http
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.http plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import coreHttpObj from './core_http.json';
## Client
### Interfaces
<DocDefinitionList data={coreHttpObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={coreHttpObj.client.misc}/>
## Server
### Objects
<DocDefinitionList data={coreHttpObj.server.objects}/>
### Classes
<DocDefinitionList data={coreHttpObj.server.classes}/>
### Interfaces
<DocDefinitionList data={coreHttpObj.server.interfaces}/>
### Enums
<DocDefinitionList data={coreHttpObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={coreHttpObj.server.misc}/>

14001
api_docs/core_saved_objects.json Normal file
View file

File diff suppressed because it is too large Load diff

35
api_docs/core_saved_objects.mdx Normal file
View file

@ -0,0 +1,35 @@
---
id: kibCoreSavedObjectsPluginApi
slug: /kibana-dev-docs/core.savedObjectsPluginApi
title: core.savedObjects
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.savedObjects plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import coreSavedObjectsObj from './core_saved_objects.json';
## Client
### Classes
<DocDefinitionList data={coreSavedObjectsObj.client.classes}/>
### Interfaces
<DocDefinitionList data={coreSavedObjectsObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={coreSavedObjectsObj.client.misc}/>
## Server
### Classes
<DocDefinitionList data={coreSavedObjectsObj.server.classes}/>
### Interfaces
<DocDefinitionList data={coreSavedObjectsObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={coreSavedObjectsObj.server.misc}/>

2610
api_docs/dashboard.json Normal file
View file

File diff suppressed because it is too large Load diff

47
api_docs/dashboard.mdx Normal file
View file

@ -0,0 +1,47 @@
---
id: kibDashboardPluginApi
slug: /kibana-dev-docs/dashboardPluginApi
title: dashboard
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dashboard plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dashboardObj from './dashboard.json';
## Client
### Setup
<DocDefinitionList data={[dashboardObj.client.setup]}/>
### Start
<DocDefinitionList data={[dashboardObj.client.start]}/>
### Objects
<DocDefinitionList data={dashboardObj.client.objects}/>
### Functions
<DocDefinitionList data={dashboardObj.client.functions}/>
### Classes
<DocDefinitionList data={dashboardObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dashboardObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dashboardObj.client.misc}/>
## Common
### Functions
<DocDefinitionList data={dashboardObj.common.functions}/>
### Interfaces
<DocDefinitionList data={dashboardObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dashboardObj.common.misc}/>

1086
api_docs/dashboard_enhanced.json Normal file
View file

File diff suppressed because it is too large Load diff

49
api_docs/dashboard_enhanced.mdx Normal file
View file

@ -0,0 +1,49 @@
---
id: kibDashboardEnhancedPluginApi
slug: /kibana-dev-docs/dashboardEnhancedPluginApi
title: dashboardEnhanced
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dashboardEnhanced plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dashboardEnhancedObj from './dashboard_enhanced.json';
## Client
### Setup
<DocDefinitionList data={[dashboardEnhancedObj.client.setup]}/>
### Start
<DocDefinitionList data={[dashboardEnhancedObj.client.start]}/>
### Classes
<DocDefinitionList data={dashboardEnhancedObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dashboardEnhancedObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dashboardEnhancedObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[dashboardEnhancedObj.server.setup]}/>
### Start
<DocDefinitionList data={[dashboardEnhancedObj.server.start]}/>
### Interfaces
<DocDefinitionList data={dashboardEnhancedObj.server.interfaces}/>
## Common
### Functions
<DocDefinitionList data={dashboardEnhancedObj.common.functions}/>
### Consts, variables and types
<DocDefinitionList data={dashboardEnhancedObj.common.misc}/>

252
api_docs/dashboard_mode.json Normal file
View file

@ -0,0 +1,252 @@
{
"id": "dashboardMode",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"id": "def-server.DashboardModeServerPlugin",
"type": "Class",
"tags": [],
"label": "DashboardModeServerPlugin",
"description": [],
"signature": [
{
"pluginId": "dashboardMode",
"scope": "server",
"docId": "kibDashboardModePluginApi",
"section": "def-server.DashboardModeServerPlugin",
"text": "DashboardModeServerPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<void, void, object, object>"
],
"children": [
{
"id": "def-server.DashboardModeServerPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L30"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L30"
}
},
{
"id": "def-server.DashboardModeServerPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { security }: DashboardModeServerSetupDependencies) => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34"
}
},
{
"type": "Object",
"label": "{ security }",
"isRequired": true,
"signature": [
"DashboardModeServerSetupDependencies"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34"
}
},
{
"id": "def-server.DashboardModeServerPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L60"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L60"
}
},
{
"id": "def-server.DashboardModeServerPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 62,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L62"
}
}
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L26"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [
{
"id": "def-common.UI_SETTINGS",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES",
"type": "string",
"label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/common/constants.ts#L9"
}
}
],
"description": [],
"label": "UI_SETTINGS",
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/common/constants.ts#L8"
},
"initialIsOpen": false
}
]
}
}

23
api_docs/dashboard_mode.mdx Normal file
View file

@ -0,0 +1,23 @@
---
id: kibDashboardModePluginApi
slug: /kibana-dev-docs/dashboardModePluginApi
title: dashboardMode
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dashboardMode plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardMode']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dashboardModeObj from './dashboard_mode.json';
## Server
### Classes
<DocDefinitionList data={dashboardModeObj.server.classes}/>
## Common
### Objects
<DocDefinitionList data={dashboardModeObj.common.objects}/>

29115
api_docs/data.json Normal file
View file

File diff suppressed because it is too large Load diff

85
api_docs/data.mdx Normal file
View file

@ -0,0 +1,85 @@
---
id: kibDataPluginApi
slug: /kibana-dev-docs/dataPluginApi
title: data
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataObj from './data.json';
## Client
### Setup
<DocDefinitionList data={[dataObj.client.setup]}/>
### Start
<DocDefinitionList data={[dataObj.client.start]}/>
### Objects
<DocDefinitionList data={dataObj.client.objects}/>
### Functions
<DocDefinitionList data={dataObj.client.functions}/>
### Classes
<DocDefinitionList data={dataObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dataObj.client.interfaces}/>
### Enums
<DocDefinitionList data={dataObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[dataObj.server.setup]}/>
### Start
<DocDefinitionList data={[dataObj.server.start]}/>
### Objects
<DocDefinitionList data={dataObj.server.objects}/>
### Functions
<DocDefinitionList data={dataObj.server.functions}/>
### Classes
<DocDefinitionList data={dataObj.server.classes}/>
### Interfaces
<DocDefinitionList data={dataObj.server.interfaces}/>
### Enums
<DocDefinitionList data={dataObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={dataObj.common.objects}/>
### Functions
<DocDefinitionList data={dataObj.common.functions}/>
### Classes
<DocDefinitionList data={dataObj.common.classes}/>
### Interfaces
<DocDefinitionList data={dataObj.common.interfaces}/>
### Enums
<DocDefinitionList data={dataObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataObj.common.misc}/>

438
api_docs/data_autocomplete.json Normal file
View file

@ -0,0 +1,438 @@
{
"id": "data.autocomplete",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.QuerySuggestionGetFnArgs",
"type": "Interface",
"label": "QuerySuggestionGetFnArgs",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.language",
"type": "string",
"label": "language",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L25"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.indexPatterns",
"type": "Array",
"label": "indexPatterns",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L26"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.query",
"type": "string",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L27"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.selectionStart",
"type": "number",
"label": "selectionStart",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L28"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.selectionEnd",
"type": "number",
"label": "selectionEnd",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L29"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.signal",
"type": "Object",
"label": "signal",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L30"
},
"signature": [
"AbortSignal | undefined"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.useTimeRange",
"type": "CompoundType",
"label": "useTimeRange",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L31"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.boolFilter",
"type": "Any",
"label": "boolFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L32"
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L24"
},
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestionBasic",
"type": "Interface",
"label": "QuerySuggestionBasic",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.type",
"type": "Enum",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L37"
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionTypes",
"text": "QuerySuggestionTypes"
}
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.description",
"type": "CompoundType",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L38"
},
"signature": [
"string | JSX.Element | undefined"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.end",
"type": "number",
"label": "end",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L39"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.start",
"type": "number",
"label": "start",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L40"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L41"
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.cursorIndex",
"type": "number",
"label": "cursorIndex",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L42"
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L36"
},
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestionField",
"type": "Interface",
"label": "QuerySuggestionField",
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionField",
"text": "QuerySuggestionField"
},
" extends ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionBasic",
"text": "QuerySuggestionBasic"
}
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.QuerySuggestionField.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L47"
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionTypes",
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L48"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
]
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L46"
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.QuerySuggestionTypes",
"type": "Enum",
"label": "QuerySuggestionTypes",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L11"
},
"initialIsOpen": false
}
],
"misc": [
{
"id": "def-public.QuerySuggestion",
"type": "Type",
"label": "QuerySuggestion",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L52"
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionBasic",
"text": "QuerySuggestionBasic"
},
" | ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionField",
"text": "QuerySuggestionField"
}
],
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestionGetFn",
"type": "Type",
"label": "QuerySuggestionGetFn",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L19"
},
"signature": [
"(args: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFnArgs",
"text": "QuerySuggestionGetFnArgs"
},
") => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestion",
"text": "QuerySuggestion"
},
"[]> | undefined"
],
"initialIsOpen": false
},
{
"id": "def-public.AutocompleteStart",
"type": "Type",
"label": "AutocompleteStart",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/autocomplete_service.ts",
"lineNumber": 93,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/autocomplete_service.ts#L93"
},
"signature": [
"{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

24
api_docs/data_autocomplete.mdx Normal file
View file

@ -0,0 +1,24 @@
---
id: kibDataAutocompletePluginApi
slug: /kibana-dev-docs/data.autocompletePluginApi
title: data.autocomplete
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.autocomplete plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.autocomplete']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataAutocompleteObj from './data_autocomplete.json';
## Client
### Interfaces
<DocDefinitionList data={dataAutocompleteObj.client.interfaces}/>
### Enums
<DocDefinitionList data={dataAutocompleteObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataAutocompleteObj.client.misc}/>

980
api_docs/data_enhanced.json Normal file
View file

@ -0,0 +1,980 @@
{
"id": "dataEnhanced",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.ENHANCED_ES_SEARCH_STRATEGY",
"type": "string",
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17"
},
"signature": [
"\"ese\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.EQL_SEARCH_STRATEGY",
"type": "string",
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19"
},
"signature": [
"\"eql\""
],
"initialIsOpen": false
}
],
"objects": [],
"start": {
"id": "def-public.DataEnhancedStart",
"type": "Type",
"label": "DataEnhancedStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/public/plugin.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/public/plugin.ts#L40"
},
"signature": [
"void"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"id": "def-server.EnhancedDataServerPlugin",
"type": "Class",
"tags": [],
"label": "EnhancedDataServerPlugin",
"description": [],
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "server",
"docId": "kibDataEnhancedPluginApi",
"section": "def-server.EnhancedDataServerPlugin",
"text": "EnhancedDataServerPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<void, void, SetupDependencies, ",
"StartDependencies",
">"
],
"children": [
{
"id": "def-server.EnhancedDataServerPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<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; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L48"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L48"
}
},
{
"id": "def-server.EnhancedDataServerPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
", unknown>, deps: SetupDependencies) => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
", unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53"
}
},
{
"type": "Object",
"label": "deps",
"isRequired": true,
"signature": [
"SetupDependencies"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53"
}
},
{
"id": "def-server.EnhancedDataServerPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
", { taskManager }: ",
{
"pluginId": "dataEnhanced",
"scope": "server",
"docId": "kibDataEnhancedPluginApi",
"section": "def-server.StartDependencies",
"text": "StartDependencies"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 95,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95"
}
},
{
"type": "Object",
"label": "{ taskManager }",
"isRequired": true,
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "server",
"docId": "kibDataEnhancedPluginApi",
"section": "def-server.StartDependencies",
"text": "StartDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 95,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 95,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95"
}
},
{
"id": "def-server.EnhancedDataServerPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L101"
}
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L42"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-server.ENHANCED_ES_SEARCH_STRATEGY",
"type": "string",
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17"
},
"signature": [
"\"ese\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-server.EQL_SEARCH_STRATEGY",
"type": "string",
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19"
},
"signature": [
"\"eql\""
],
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.pollSearch",
"type": "Function",
"children": [
{
"type": "Function",
"label": "search",
"isRequired": true,
"signature": [
"() => Promise<Response>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L16"
}
},
{
"type": "Function",
"label": "cancel",
"isRequired": false,
"signature": [
"(() => void) | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L17"
}
},
{
"type": "Object",
"label": "{ pollInterval = 1000, abortSignal }",
"isRequired": true,
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.IAsyncSearchOptions",
"text": "IAsyncSearchOptions"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L18"
}
}
],
"signature": [
"<Response extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any>>(search: () => Promise<Response>, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ",
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.IAsyncSearchOptions",
"text": "IAsyncSearchOptions"
},
") => ",
"Observable",
"<Response>"
],
"description": [],
"label": "pollSearch",
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L15"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.EqlSearchStrategyRequest",
"type": "Interface",
"label": "EqlSearchStrategyRequest",
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.EqlSearchStrategyRequest",
"text": "EqlSearchStrategyRequest"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchRequest",
"text": "IKibanaSearchRequest"
},
"<",
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.EqlRequestParams",
"text": "EqlRequestParams"
},
">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EqlSearchStrategyRequest.options",
"type": "Object",
"label": "options",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L24"
},
"signature": [
"TransportRequestOptions",
" | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L23"
},
"initialIsOpen": false
},
{
"id": "def-common.IAsyncSearchOptions",
"type": "Interface",
"label": "IAsyncSearchOptions",
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.IAsyncSearchOptions",
"text": "IAsyncSearchOptions"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IAsyncSearchOptions.pollInterval",
"type": "number",
"label": "pollInterval",
"description": [
"\nThe number of milliseconds to wait between receiving a response and sending another request"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L33"
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L29"
},
"initialIsOpen": false
},
{
"id": "def-common.SearchSessionSavedObjectAttributes",
"type": "Interface",
"label": "SearchSessionSavedObjectAttributes",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.sessionId",
"type": "string",
"label": "sessionId",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L12"
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.name",
"type": "string",
"label": "name",
"description": [
"\nUser-facing session name to be displayed in session management"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L16"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.appId",
"type": "string",
"label": "appId",
"description": [
"\nApp that created the session. e.g 'discover'"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L20"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.created",
"type": "string",
"label": "created",
"description": [
"\nCreation time of the session"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L24"
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.touched",
"type": "string",
"label": "touched",
"description": [
"\nLast touch time of the session"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L28"
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.expires",
"type": "string",
"label": "expires",
"description": [
"\nExpiration time of the session. Expiration itself is managed by Elasticsearch."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L32"
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.status",
"type": "Enum",
"label": "status",
"description": [
"\nstatus"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L36"
},
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.SearchSessionStatus",
"text": "SearchSessionStatus"
}
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId",
"type": "string",
"label": "urlGeneratorId",
"description": [
"\nurlGeneratorId"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L40"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.initialState",
"type": "Object",
"label": "initialState",
"description": [
"\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L45"
},
"signature": [
"Record<string, unknown> | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.restoreState",
"type": "Object",
"label": "restoreState",
"description": [
"\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L50"
},
"signature": [
"Record<string, unknown> | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.idMapping",
"type": "Object",
"label": "idMapping",
"description": [
"\nMapping of search request hashes to their corresponsing info (async search id, etc.)"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L54"
},
"signature": [
"Record<string, ",
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.SearchSessionRequestInfo",
"text": "SearchSessionRequestInfo"
},
">"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.persisted",
"type": "boolean",
"label": "persisted",
"description": [
"\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L59"
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.realmType",
"type": "string",
"label": "realmType",
"description": [
"\nThe realm type/name & username uniquely identifies the user who created this search session"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L63"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.realmName",
"type": "string",
"label": "realmName",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L64"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.username",
"type": "string",
"label": "username",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L65"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L11"
},
"initialIsOpen": false
},
{
"id": "def-common.SearchSessionRequestInfo",
"type": "Interface",
"label": "SearchSessionRequestInfo",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.id",
"type": "string",
"label": "id",
"description": [
"\nID of the async search request"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L72"
}
},
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.strategy",
"type": "string",
"label": "strategy",
"description": [
"\nSearch strategy used to submit the search request"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L76"
}
},
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.status",
"type": "string",
"label": "status",
"description": [
"\nstatus"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L80"
}
},
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.error",
"type": "string",
"label": "error",
"description": [
"\nAn optional error. Set if status is set to error."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 84,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L84"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L68"
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-common.SearchSessionStatus",
"type": "Enum",
"label": "SearchSessionStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/status.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/status.ts#L8"
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-common.SEARCH_SESSION_TYPE",
"type": "string",
"label": "SEARCH_SESSION_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L10"
},
"signature": [
"\"search-session\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.ENHANCED_ES_SEARCH_STRATEGY",
"type": "string",
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17"
},
"signature": [
"\"ese\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.EQL_SEARCH_STRATEGY",
"type": "string",
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19"
},
"signature": [
"\"eql\""
],
"initialIsOpen": false
},
{
"id": "def-common.EqlRequestParams",
"type": "Type",
"label": "EqlRequestParams",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L21"
},
"signature": [
"EqlSearch<Record<string, unknown>>"
],
"initialIsOpen": false
},
{
"id": "def-common.EqlSearchStrategyResponse",
"type": "Type",
"label": "EqlSearchStrategyResponse",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L27"
},
"signature": [
"IKibanaSearchResponse<ApiResponse<T, ",
"Context",
">>"
],
"initialIsOpen": false
}
],
"objects": []
}
}

43
api_docs/data_enhanced.mdx Normal file
View file

@ -0,0 +1,43 @@
---
id: kibDataEnhancedPluginApi
slug: /kibana-dev-docs/dataEnhancedPluginApi
title: dataEnhanced
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dataEnhanced plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataEnhanced']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataEnhancedObj from './data_enhanced.json';
## Client
### Start
<DocDefinitionList data={[dataEnhancedObj.client.start]}/>
### Consts, variables and types
<DocDefinitionList data={dataEnhancedObj.client.misc}/>
## Server
### Classes
<DocDefinitionList data={dataEnhancedObj.server.classes}/>
### Consts, variables and types
<DocDefinitionList data={dataEnhancedObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={dataEnhancedObj.common.functions}/>
### Interfaces
<DocDefinitionList data={dataEnhancedObj.common.interfaces}/>
### Enums
<DocDefinitionList data={dataEnhancedObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataEnhancedObj.common.misc}/>

4136
api_docs/data_field_formats.json Normal file
View file

File diff suppressed because it is too large Load diff

38
api_docs/data_field_formats.mdx Normal file
View file

@ -0,0 +1,38 @@
---
id: kibDataFieldFormatsPluginApi
slug: /kibana-dev-docs/data.fieldFormatsPluginApi
title: data.fieldFormats
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.fieldFormats plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.fieldFormats']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataFieldFormatsObj from './data_field_formats.json';
## Client
### Consts, variables and types
<DocDefinitionList data={dataFieldFormatsObj.client.misc}/>
## Common
### Objects
<DocDefinitionList data={dataFieldFormatsObj.common.objects}/>
### Functions
<DocDefinitionList data={dataFieldFormatsObj.common.functions}/>
### Classes
<DocDefinitionList data={dataFieldFormatsObj.common.classes}/>
### Interfaces
<DocDefinitionList data={dataFieldFormatsObj.common.interfaces}/>
### Enums
<DocDefinitionList data={dataFieldFormatsObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataFieldFormatsObj.common.misc}/>

7182
api_docs/data_index_patterns.json Normal file
View file

File diff suppressed because it is too large Load diff

41
api_docs/data_index_patterns.mdx Normal file
View file

@ -0,0 +1,41 @@
---
id: kibDataIndexPatternsPluginApi
slug: /kibana-dev-docs/data.indexPatternsPluginApi
title: data.indexPatterns
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.indexPatterns plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.indexPatterns']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataIndexPatternsObj from './data_index_patterns.json';
## Server
### Functions
<DocDefinitionList data={dataIndexPatternsObj.server.functions}/>
### Classes
<DocDefinitionList data={dataIndexPatternsObj.server.classes}/>
### Interfaces
<DocDefinitionList data={dataIndexPatternsObj.server.interfaces}/>
## Common
### Objects
<DocDefinitionList data={dataIndexPatternsObj.common.objects}/>
### Functions
<DocDefinitionList data={dataIndexPatternsObj.common.functions}/>
### Classes
<DocDefinitionList data={dataIndexPatternsObj.common.classes}/>
### Interfaces
<DocDefinitionList data={dataIndexPatternsObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dataIndexPatternsObj.common.misc}/>

2618
api_docs/data_query.json Normal file
View file

File diff suppressed because it is too large Load diff

41
api_docs/data_query.mdx Normal file
View file

@ -0,0 +1,41 @@
---
id: kibDataQueryPluginApi
slug: /kibana-dev-docs/data.queryPluginApi
title: data.query
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.query plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataQueryObj from './data_query.json';
## Client
### Functions
<DocDefinitionList data={dataQueryObj.client.functions}/>
### Classes
<DocDefinitionList data={dataQueryObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dataQueryObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dataQueryObj.client.misc}/>
## Common
### Objects
<DocDefinitionList data={dataQueryObj.common.objects}/>
### Functions
<DocDefinitionList data={dataQueryObj.common.functions}/>
### Interfaces
<DocDefinitionList data={dataQueryObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dataQueryObj.common.misc}/>

20250
api_docs/data_search.json Normal file
View file

File diff suppressed because one or more lines are too long

61
api_docs/data_search.mdx Normal file
View file

@ -0,0 +1,61 @@
---
id: kibDataSearchPluginApi
slug: /kibana-dev-docs/data.searchPluginApi
title: data.search
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.search plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataSearchObj from './data_search.json';
## Client
### Functions
<DocDefinitionList data={dataSearchObj.client.functions}/>
### Classes
<DocDefinitionList data={dataSearchObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.client.interfaces}/>
### Enums
<DocDefinitionList data={dataSearchObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.client.misc}/>
## Server
### Functions
<DocDefinitionList data={dataSearchObj.server.functions}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={dataSearchObj.common.objects}/>
### Functions
<DocDefinitionList data={dataSearchObj.common.functions}/>
### Classes
<DocDefinitionList data={dataSearchObj.common.classes}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.common.interfaces}/>
### Enums
<DocDefinitionList data={dataSearchObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.common.misc}/>

539
api_docs/data_ui.json Normal file
View file

File diff suppressed because one or more lines are too long

24
api_docs/data_ui.mdx Normal file
View file

@ -0,0 +1,24 @@
---
id: kibDataUiPluginApi
slug: /kibana-dev-docs/data.uiPluginApi
title: data.ui
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.ui plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.ui']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import dataUiObj from './data_ui.json';
## Client
### Functions
<DocDefinitionList data={dataUiObj.client.functions}/>
### Interfaces
<DocDefinitionList data={dataUiObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dataUiObj.client.misc}/>

243
api_docs/dev_tools.json Normal file
View file

@ -0,0 +1,243 @@
{
"id": "devTools",
"client": {
"classes": [
{
"id": "def-public.DevToolsPlugin",
"type": "Class",
"tags": [],
"label": "DevToolsPlugin",
"description": [],
"signature": [
{
"pluginId": "devTools",
"scope": "public",
"docId": "kibDevToolsPluginApi",
"section": "def-public.DevToolsPlugin",
"text": "DevToolsPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "devTools",
"scope": "public",
"docId": "kibDevToolsPluginApi",
"section": "def-public.DevToolsSetup",
"text": "DevToolsSetup"
},
", void, object, object>"
],
"children": [
{
"id": "def-public.DevToolsPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(coreSetup: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ",
{
"pluginId": "devTools",
"scope": "public",
"docId": "kibDevToolsPluginApi",
"section": "def-public.CreateDevToolArgs",
"text": "CreateDevToolArgs"
},
") => ",
{
"pluginId": "devTools",
"scope": "public",
"docId": "kibDevToolsPluginApi",
"section": "def-public.DevToolApp",
"text": "DevToolApp"
},
"; }"
],
"description": [],
"children": [
{
"type": "Object",
"label": "coreSetup",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
}
},
{
"id": "def-public.DevToolsPlugin.setup.{-urlForwarding }",
"type": "Object",
"label": "{ urlForwarding }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.DevToolsPlugin.setup.{-urlForwarding }.urlForwarding",
"type": "Object",
"label": "urlForwarding",
"description": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
},
"signature": [
"{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"
]
}
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
}
},
{
"id": "def-public.DevToolsPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 84,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L84"
}
},
{
"id": "def-public.DevToolsPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L90"
}
}
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L35"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.DevToolsSetup",
"type": "Interface",
"label": "DevToolsSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DevToolsSetup.register",
"type": "Function",
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L32"
},
"signature": [
"(devTool: ",
{
"pluginId": "devTools",
"scope": "public",
"docId": "kibDevToolsPluginApi",
"section": "def-public.CreateDevToolArgs",
"text": "CreateDevToolArgs"
},
") => ",
{
"pluginId": "devTools",
"scope": "public",
"docId": "kibDevToolsPluginApi",
"section": "def-public.DevToolApp",
"text": "DevToolApp"
}
]
}
],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L21"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

21
api_docs/dev_tools.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibDevToolsPluginApi
slug: /kibana-dev-docs/devToolsPluginApi
title: devTools
image: https://source.unsplash.com/400x175/?github
summary: API docs for the devTools plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import devToolsObj from './dev_tools.json';
## Client
### Setup
<DocDefinitionList data={[devToolsObj.client.setup]}/>
### Classes
<DocDefinitionList data={devToolsObj.client.classes}/>

1153
api_docs/discover.json Normal file
View file

File diff suppressed because it is too large Load diff

35
api_docs/discover.mdx Normal file
View file

@ -0,0 +1,35 @@
---
id: kibDiscoverPluginApi
slug: /kibana-dev-docs/discoverPluginApi
title: discover
image: https://source.unsplash.com/400x175/?github
summary: API docs for the discover plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import discoverObj from './discover.json';
## Client
### Setup
<DocDefinitionList data={[discoverObj.client.setup]}/>
### Start
<DocDefinitionList data={[discoverObj.client.start]}/>
### Functions
<DocDefinitionList data={discoverObj.client.functions}/>
### Interfaces
<DocDefinitionList data={discoverObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={discoverObj.client.misc}/>
## Common
### Consts, variables and types
<DocDefinitionList data={discoverObj.common.misc}/>

910
api_docs/discover_enhanced.json Normal file
View file

@ -0,0 +1,910 @@
{
"id": "discoverEnhanced",
"client": {
"classes": [
{
"id": "def-public.ExploreDataContextMenuAction",
"type": "Class",
"tags": [],
"label": "ExploreDataContextMenuAction",
"description": [
"\nThis is \"Explore underlying data\" action which appears in the context\nmenu of a dashboard panel."
],
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataContextMenuAction",
"text": "ExploreDataContextMenuAction"
},
" extends ",
"AbstractExploreDataAction",
"<EmbeddableQueryContext> implements ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<EmbeddableQueryContext>"
],
"children": [
{
"tags": [],
"id": "def-public.ExploreDataContextMenuAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L37"
},
"signature": [
"\"ACTION_EXPLORE_DATA\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataContextMenuAction.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L39"
},
"signature": [
"\"ACTION_EXPLORE_DATA\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataContextMenuAction.order",
"type": "number",
"label": "order",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L41"
},
"signature": [
"200"
]
},
{
"id": "def-public.ExploreDataContextMenuAction.getUrl",
"type": "Function",
"children": [
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L43"
}
}
],
"signature": [
"(context: EmbeddableQueryContext) => Promise<",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.KibanaURL",
"text": "KibanaURL"
},
">"
],
"description": [],
"label": "getUrl",
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L43"
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L34"
},
"initialIsOpen": false
},
{
"id": "def-public.ExploreDataChartAction",
"type": "Class",
"tags": [],
"label": "ExploreDataChartAction",
"description": [
"\nThis is \"Explore underlying data\" action which appears in popup context\nmenu when user clicks a value in visualization or brushes a time range."
],
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartAction",
"text": "ExploreDataChartAction"
},
" extends ",
"AbstractExploreDataAction",
"<",
"ExploreDataChartActionContext",
"> implements ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
"ExploreDataChartActionContext"
],
"children": [
{
"tags": [],
"id": "def-public.ExploreDataChartAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L35"
},
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataChartAction.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L37"
},
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataChartAction.order",
"type": "number",
"label": "order",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L39"
},
"signature": [
"200"
]
},
{
"id": "def-public.ExploreDataChartAction.isCompatible",
"type": "Function",
"label": "isCompatible",
"signature": [
"(context: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
},
") => Promise<boolean>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L41"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L41"
}
},
{
"id": "def-public.ExploreDataChartAction.getUrl",
"type": "Function",
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L47"
}
}
],
"signature": [
"(context: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
},
") => Promise<",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.KibanaURL",
"text": "KibanaURL"
},
">"
],
"description": [],
"label": "getUrl",
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L46"
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L32"
},
"initialIsOpen": false
},
{
"id": "def-public.DiscoverEnhancedPlugin",
"type": "Class",
"tags": [],
"label": "DiscoverEnhancedPlugin",
"description": [],
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedPlugin",
"text": "DiscoverEnhancedPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<void, void, ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedSetupDependencies",
"text": "DiscoverEnhancedSetupDependencies"
},
", ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
">"
],
"children": [
{
"tags": [],
"id": "def-public.DiscoverEnhancedPlugin.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L43"
},
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "common",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-common.Config",
"text": "Config"
}
]
},
{
"id": "def-public.DiscoverEnhancedPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L45"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L45"
}
},
{
"id": "def-public.DiscoverEnhancedPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
", unknown>, { uiActions, share }: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedSetupDependencies",
"text": "DiscoverEnhancedSetupDependencies"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
", unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L50"
}
},
{
"type": "Object",
"label": "{ uiActions, share }",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedSetupDependencies",
"text": "DiscoverEnhancedSetupDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L51"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L49"
}
},
{
"id": "def-public.DiscoverEnhancedPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
", plugins: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69"
}
},
{
"type": "Object",
"label": "plugins",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69"
}
},
{
"id": "def-public.DiscoverEnhancedPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L71"
}
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L40"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.DiscoverEnhancedSetupDependencies",
"type": "Interface",
"label": "DiscoverEnhancedSetupDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.discover",
"type": "Object",
"label": "discover",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L25"
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L26"
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.kibanaLegacy",
"type": "Object",
"label": "kibanaLegacy",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L27"
},
"signature": [
"{} | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.share",
"type": "CompoundType",
"label": "share",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L28"
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePluginSetup",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L29"
},
"signature": [
"Pick<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L24"
},
"initialIsOpen": false
},
{
"id": "def-public.DiscoverEnhancedStartDependencies",
"type": "Interface",
"label": "DiscoverEnhancedStartDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.discover",
"type": "Object",
"label": "discover",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L33"
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L34"
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L35"
},
"signature": [
"{ dashboardConfig: ",
{
"pluginId": "kibanaLegacy",
"scope": "public",
"docId": "kibKibanaLegacyPluginApi",
"section": "def-public.DashboardConfig",
"text": "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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L36"
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePluginStart",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L37"
},
"signature": [
"Pick<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
", ",
"MethodKeysOf",
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
">>"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L32"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.Config",
"type": "Interface",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/common/config.ts#L9"
},
"signature": [
"{ exploreDataInChart: { enabled: boolean; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/common/config.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/common/config.ts#L8"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}

26
api_docs/discover_enhanced.mdx Normal file
View file

@ -0,0 +1,26 @@
---
id: kibDiscoverEnhancedPluginApi
slug: /kibana-dev-docs/discoverEnhancedPluginApi
title: discoverEnhanced
image: https://source.unsplash.com/400x175/?github
summary: API docs for the discoverEnhanced plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import discoverEnhancedObj from './discover_enhanced.json';
## Client
### Classes
<DocDefinitionList data={discoverEnhancedObj.client.classes}/>
### Interfaces
<DocDefinitionList data={discoverEnhancedObj.client.interfaces}/>
## Common
### Interfaces
<DocDefinitionList data={discoverEnhancedObj.common.interfaces}/>

9507
api_docs/embeddable.json Normal file
View file

File diff suppressed because it is too large Load diff

64
api_docs/embeddable.mdx Normal file
View file

@ -0,0 +1,64 @@
---
id: kibEmbeddablePluginApi
slug: /kibana-dev-docs/embeddablePluginApi
title: embeddable
image: https://source.unsplash.com/400x175/?github
summary: API docs for the embeddable plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import embeddableObj from './embeddable.json';
## Client
### Setup
<DocDefinitionList data={[embeddableObj.client.setup]}/>
### Start
<DocDefinitionList data={[embeddableObj.client.start]}/>
### Objects
<DocDefinitionList data={embeddableObj.client.objects}/>
### Functions
<DocDefinitionList data={embeddableObj.client.functions}/>
### Classes
<DocDefinitionList data={embeddableObj.client.classes}/>
### Interfaces
<DocDefinitionList data={embeddableObj.client.interfaces}/>
### Enums
<DocDefinitionList data={embeddableObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={embeddableObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[embeddableObj.server.setup]}/>
### Interfaces
<DocDefinitionList data={embeddableObj.server.interfaces}/>
## Common
### Objects
<DocDefinitionList data={embeddableObj.common.objects}/>
### Functions
<DocDefinitionList data={embeddableObj.common.functions}/>
### Interfaces
<DocDefinitionList data={embeddableObj.common.interfaces}/>
### Enums
<DocDefinitionList data={embeddableObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={embeddableObj.common.misc}/>

363
api_docs/embeddable_enhanced.json Normal file
View file

@ -0,0 +1,363 @@
{
"id": "embeddableEnhanced",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.isEnhancedEmbeddable",
"type": "Function",
"children": [
{
"type": "Uncategorized",
"label": "maybeEnhancedEmbeddable",
"isRequired": true,
"signature": [
"E"
],
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts#L12"
}
}
],
"signature": [
"<E>(maybeEnhancedEmbeddable: E) => maybeEnhancedEmbeddable is ",
{
"pluginId": "embeddableEnhanced",
"scope": "public",
"docId": "kibEmbeddableEnhancedPluginApi",
"section": "def-public.EnhancedEmbeddable",
"text": "EnhancedEmbeddable"
},
"<E extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
"> ? E : never>"
],
"description": [],
"label": "isEnhancedEmbeddable",
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts#L11"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.SetupDependencies",
"type": "Interface",
"label": "SetupDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SetupDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L36"
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"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": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L37"
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
}
]
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L35"
},
"initialIsOpen": false
},
{
"id": "def-public.StartDependencies",
"type": "Interface",
"label": "StartDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.StartDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L41"
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"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": 42,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L42"
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
}
]
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L40"
},
"initialIsOpen": false
},
{
"id": "def-public.EnhancedEmbeddableContext",
"type": "Interface",
"label": "EnhancedEmbeddableContext",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.EnhancedEmbeddableContext.embeddable",
"type": "CompoundType",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L21"
},
"signature": [
{
"pluginId": "embeddableEnhanced",
"scope": "public",
"docId": "kibEmbeddableEnhancedPluginApi",
"section": "def-public.EnhancedEmbeddable",
"text": "EnhancedEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
">>"
]
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L20"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.EnhancedEmbeddable",
"type": "Type",
"label": "EnhancedEmbeddable",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/types.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L11"
},
"signature": [
"E & { enhancements: { dynamicActions: DynamicActionManager;}; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.drilldownGrouping",
"type": "Array",
"label": "drilldownGrouping",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts#L12"
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.PresentableGrouping",
"text": "PresentableGrouping"
},
"<{ embeddable?: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
"> | undefined; }>"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.SetupContract",
"type": "Interface",
"label": "SetupContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L46"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.StartContract",
"type": "Interface",
"label": "StartContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L49"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

30
api_docs/embeddable_enhanced.mdx Normal file
View file

@ -0,0 +1,30 @@
---
id: kibEmbeddableEnhancedPluginApi
slug: /kibana-dev-docs/embeddableEnhancedPluginApi
title: embeddableEnhanced
image: https://source.unsplash.com/400x175/?github
summary: API docs for the embeddableEnhanced plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import embeddableEnhancedObj from './embeddable_enhanced.json';
## Client
### Setup
<DocDefinitionList data={[embeddableEnhancedObj.client.setup]}/>
### Start
<DocDefinitionList data={[embeddableEnhancedObj.client.start]}/>
### Functions
<DocDefinitionList data={embeddableEnhancedObj.client.functions}/>
### Interfaces
<DocDefinitionList data={embeddableEnhancedObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={embeddableEnhancedObj.client.misc}/>

390
api_docs/encrypted_saved_objects.json Normal file
View file

@ -0,0 +1,390 @@
{
"id": "encryptedSavedObjects",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"id": "def-server.EncryptionError",
"type": "Class",
"tags": [],
"label": "EncryptionError",
"description": [],
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptionError",
"text": "EncryptionError"
},
" extends Error"
],
"children": [
{
"id": "def-server.EncryptionError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L18"
}
},
{
"type": "string",
"label": "attributeName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L19"
}
},
{
"type": "Enum",
"label": "operation",
"isRequired": true,
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptionErrorOperation",
"text": "EncryptionErrorOperation"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L20"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L21"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L17"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L30"
}
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L16"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-server.EncryptedSavedObjectTypeRegistration",
"type": "Interface",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L34"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L35"
},
"signature": [
"ReadonlySet<string | ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.AttributeToEncrypt",
"text": "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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L36"
},
"signature": [
"ReadonlySet<string> | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L33"
},
"initialIsOpen": false
},
{
"id": "def-server.EncryptedSavedObjectsClient",
"type": "Interface",
"label": "EncryptedSavedObjectsClient",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser",
"type": "Function",
"label": "getDecryptedAsInternalUser",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L41"
},
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
]
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L40"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-server.EncryptedSavedObjectsPluginSetup",
"type": "Interface",
"label": "EncryptedSavedObjectsPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt",
"type": "boolean",
"label": "canEncrypt",
"description": [
"\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`."
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L35"
}
},
{
"tags": [],
"id": "def-server.EncryptedSavedObjectsPluginSetup.registerType",
"type": "Function",
"label": "registerType",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L36"
},
"signature": [
"(typeRegistration: ",
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectTypeRegistration",
"text": "EncryptedSavedObjectTypeRegistration"
},
") => void"
]
},
{
"tags": [],
"id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration",
"type": "Function",
"label": "createMigration",
"description": [],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L37"
},
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.CreateEncryptedSavedObjectsMigrationFn",
"text": "CreateEncryptedSavedObjectsMigrationFn"
}
]
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L31"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.EncryptedSavedObjectsPluginStart",
"type": "Interface",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L41"
},
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L42"
},
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.ClientInstanciator",
"text": "ClientInstanciator"
}
]
}
],
"source": {
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L40"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

27
api_docs/encrypted_saved_objects.mdx Normal file
View file

@ -0,0 +1,27 @@
---
id: kibEncryptedSavedObjectsPluginApi
slug: /kibana-dev-docs/encryptedSavedObjectsPluginApi
title: encryptedSavedObjects
image: https://source.unsplash.com/400x175/?github
summary: API docs for the encryptedSavedObjects plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.json';
## Server
### Setup
<DocDefinitionList data={[encryptedSavedObjectsObj.server.setup]}/>
### Start
<DocDefinitionList data={[encryptedSavedObjectsObj.server.start]}/>
### Classes
<DocDefinitionList data={encryptedSavedObjectsObj.server.classes}/>
### Interfaces
<DocDefinitionList data={encryptedSavedObjectsObj.server.interfaces}/>

69
api_docs/enterprise_search.json Normal file
View file

@ -0,0 +1,69 @@
{
"id": "enterpriseSearch",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-server.ConfigType",
"type": "Type",
"label": "ConfigType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/enterprise_search/server/index.ts#L24"
},
"signature": [
"{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-server.configSchema",
"type": "Object",
"label": "configSchema",
"description": [],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/enterprise_search/server/index.ts#L17"
},
"signature": [
"ObjectType",
"<{ host: ",
"Type",
"<string | undefined>; enabled: ",
"Type",
"<boolean>; accessCheckTimeout: ",
"Type",
"<number>; accessCheckTimeoutWarning: ",
"Type"
],
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

21
api_docs/enterprise_search.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibEnterpriseSearchPluginApi
slug: /kibana-dev-docs/enterpriseSearchPluginApi
title: enterpriseSearch
image: https://source.unsplash.com/400x175/?github
summary: API docs for the enterpriseSearch plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import enterpriseSearchObj from './enterprise_search.json';
## Server
### Objects
<DocDefinitionList data={enterpriseSearchObj.server.objects}/>
### Consts, variables and types
<DocDefinitionList data={enterpriseSearchObj.server.misc}/>

1558
api_docs/es_ui_shared.json Normal file
View file

File diff suppressed because it is too large Load diff

40
api_docs/es_ui_shared.mdx Normal file
View file

@ -0,0 +1,40 @@
---
id: kibEsUiSharedPluginApi
slug: /kibana-dev-docs/esUiSharedPluginApi
title: esUiShared
image: https://source.unsplash.com/400x175/?github
summary: API docs for the esUiShared plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import esUiSharedObj from './es_ui_shared.json';
## Client
### Objects
<DocDefinitionList data={esUiSharedObj.client.objects}/>
### Functions
<DocDefinitionList data={esUiSharedObj.client.functions}/>
### Classes
<DocDefinitionList data={esUiSharedObj.client.classes}/>
### Interfaces
<DocDefinitionList data={esUiSharedObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={esUiSharedObj.client.misc}/>
## Server
### Functions
<DocDefinitionList data={esUiSharedObj.server.functions}/>
## Common
### Interfaces
<DocDefinitionList data={esUiSharedObj.common.interfaces}/>

715
api_docs/event_log.json Normal file
View file

@ -0,0 +1,715 @@
{
"id": "eventLog",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-server.IEventLogger",
"type": "Interface",
"label": "IEventLogger",
"description": [],
"tags": [],
"children": [
{
"id": "def-server.IEventLogger.logEvent",
"type": "Function",
"label": "logEvent",
"signature": [
"(properties: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "properties",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53"
}
},
{
"id": "def-server.IEventLogger.startTiming",
"type": "Function",
"label": "startTiming",
"signature": [
"(event: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "event",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L54"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L54"
}
},
{
"id": "def-server.IEventLogger.stopTiming",
"type": "Function",
"label": "stopTiming",
"signature": [
"(event: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "event",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L55"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L55"
}
}
],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L52"
},
"initialIsOpen": false
},
{
"id": "def-server.IEventLogClient",
"type": "Interface",
"label": "IEventLogClient",
"description": [],
"tags": [],
"children": [
{
"id": "def-server.IEventLogClient.findEventsBySavedObjectIds",
"type": "Function",
"label": "findEventsBySavedObjectIds",
"signature": [
"(type: string, ids: string[], options?: Partial<",
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.FindOptionsType",
"text": "FindOptionsType"
},
"> | undefined) => Promise<",
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.QueryEventsBySavedObjectResult",
"text": "QueryEventsBySavedObjectResult"
},
">"
],
"description": [],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L46"
}
},
{
"type": "Array",
"label": "ids",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L47"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
"Partial<",
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.FindOptionsType",
"text": "FindOptionsType"
},
"> | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L48"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L45"
}
}
],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L44"
},
"initialIsOpen": false
},
{
"id": "def-server.QueryEventsBySavedObjectResult",
"type": "Interface",
"label": "QueryEventsBySavedObjectResult",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.QueryEventsBySavedObjectResult.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L35"
}
},
{
"tags": [],
"id": "def-server.QueryEventsBySavedObjectResult.per_page",
"type": "number",
"label": "per_page",
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L36"
}
},
{
"tags": [],
"id": "def-server.QueryEventsBySavedObjectResult.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L37"
}
},
{
"tags": [],
"id": "def-server.QueryEventsBySavedObjectResult.data",
"type": "Array",
"label": "data",
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L38"
},
"signature": [
"(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
]
}
],
"source": {
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L34"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-server.IEvent",
"type": "Type",
"label": "IEvent",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/generated/schemas.ts#L26"
},
"signature": [
"undefined | DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>>"
],
"initialIsOpen": false
},
{
"id": "def-server.IValidatedEvent",
"type": "Type",
"label": "IValidatedEvent",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/generated/schemas.ts#L25"
},
"signature": [
"undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-server.SAVED_OBJECT_REL_PRIMARY",
"type": "string",
"label": "SAVED_OBJECT_REL_PRIMARY",
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L18"
},
"signature": [
"\"primary\""
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-server.IEventLogService",
"type": "Interface",
"label": "IEventLogService",
"description": [],
"tags": [],
"children": [
{
"id": "def-server.IEventLogService.isEnabled",
"type": "Function",
"label": "isEnabled",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L30"
}
},
{
"id": "def-server.IEventLogService.isLoggingEntries",
"type": "Function",
"label": "isLoggingEntries",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L31"
}
},
{
"id": "def-server.IEventLogService.isIndexingEntries",
"type": "Function",
"label": "isIndexingEntries",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L32"
}
},
{
"id": "def-server.IEventLogService.registerProviderActions",
"type": "Function",
"label": "registerProviderActions",
"signature": [
"(provider: string, actions: string[]) => void"
],
"description": [],
"children": [
{
"type": "string",
"label": "provider",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33"
}
},
{
"type": "Array",
"label": "actions",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33"
}
},
{
"id": "def-server.IEventLogService.isProviderActionRegistered",
"type": "Function",
"label": "isProviderActionRegistered",
"signature": [
"(provider: string, action: string) => boolean"
],
"description": [],
"children": [
{
"type": "string",
"label": "provider",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34"
}
},
{
"type": "string",
"label": "action",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34"
}
},
{
"id": "def-server.IEventLogService.getProviderActions",
"type": "Function",
"label": "getProviderActions",
"signature": [
"() => Map<string, Set<string>>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L35"
}
},
{
"id": "def-server.IEventLogService.registerSavedObjectProvider",
"type": "Function",
"label": "registerSavedObjectProvider",
"signature": [
"(type: string, provider: ",
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.SavedObjectProvider",
"text": "SavedObjectProvider"
},
") => void"
],
"description": [],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36"
}
},
{
"type": "Function",
"label": "provider",
"isRequired": true,
"signature": [
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.SavedObjectProvider",
"text": "SavedObjectProvider"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36"
}
},
{
"id": "def-server.IEventLogService.getLogger",
"type": "Function",
"label": "getLogger",
"signature": [
"(properties: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.IEventLogger",
"text": "IEventLogger"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "properties",
"isRequired": false,
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L37"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L37"
}
}
],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L29"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.IEventLogClientService",
"type": "Interface",
"label": "IEventLogClientService",
"description": [],
"tags": [],
"children": [
{
"id": "def-server.IEventLogClientService.getClient",
"type": "Function",
"label": "getClient",
"signature": [
"(request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "eventLog",
"scope": "server",
"docId": "kibEventLogPluginApi",
"section": "def-server.IEventLogClient",
"text": "IEventLogClient"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "request",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"description": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L41"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L41"
}
}
],
"source": {
"path": "x-pack/plugins/event_log/server/types.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L40"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.BASE_EVENT_LOG_API_PATH",
"type": "string",
"label": "BASE_EVENT_LOG_API_PATH",
"description": [],
"source": {
"path": "x-pack/plugins/event_log/common/index.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/common/index.ts#L8"
},
"signature": [
"\"/api/event_log\""
],
"initialIsOpen": false
}
],
"objects": []
}
}

32
api_docs/event_log.mdx Normal file
View file

@ -0,0 +1,32 @@
---
id: kibEventLogPluginApi
slug: /kibana-dev-docs/eventLogPluginApi
title: eventLog
image: https://source.unsplash.com/400x175/?github
summary: API docs for the eventLog plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import eventLogObj from './event_log.json';
## Server
### Setup
<DocDefinitionList data={[eventLogObj.server.setup]}/>
### Start
<DocDefinitionList data={[eventLogObj.server.start]}/>
### Interfaces
<DocDefinitionList data={eventLogObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={eventLogObj.server.misc}/>
## Common
### Consts, variables and types
<DocDefinitionList data={eventLogObj.common.misc}/>

35643
api_docs/expressions.json Normal file
View file

File diff suppressed because it is too large Load diff

79
api_docs/expressions.mdx Normal file
View file

@ -0,0 +1,79 @@
---
id: kibExpressionsPluginApi
slug: /kibana-dev-docs/expressionsPluginApi
title: expressions
image: https://source.unsplash.com/400x175/?github
summary: API docs for the expressions plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import expressionsObj from './expressions.json';
## Client
### Setup
<DocDefinitionList data={[expressionsObj.client.setup]}/>
### Start
<DocDefinitionList data={[expressionsObj.client.start]}/>
### Functions
<DocDefinitionList data={expressionsObj.client.functions}/>
### Classes
<DocDefinitionList data={expressionsObj.client.classes}/>
### Interfaces
<DocDefinitionList data={expressionsObj.client.interfaces}/>
### Enums
<DocDefinitionList data={expressionsObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={expressionsObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[expressionsObj.server.setup]}/>
### Start
<DocDefinitionList data={[expressionsObj.server.start]}/>
### Functions
<DocDefinitionList data={expressionsObj.server.functions}/>
### Classes
<DocDefinitionList data={expressionsObj.server.classes}/>
### Interfaces
<DocDefinitionList data={expressionsObj.server.interfaces}/>
### Enums
<DocDefinitionList data={expressionsObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={expressionsObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={expressionsObj.common.objects}/>
### Functions
<DocDefinitionList data={expressionsObj.common.functions}/>
### Classes
<DocDefinitionList data={expressionsObj.common.classes}/>
### Interfaces
<DocDefinitionList data={expressionsObj.common.interfaces}/>
### Enums
<DocDefinitionList data={expressionsObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={expressionsObj.common.misc}/>

3713
api_docs/features.json Normal file
View file

File diff suppressed because it is too large Load diff

49
api_docs/features.mdx Normal file
View file

@ -0,0 +1,49 @@
---
id: kibFeaturesPluginApi
slug: /kibana-dev-docs/featuresPluginApi
title: features
image: https://source.unsplash.com/400x175/?github
summary: API docs for the features plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import featuresObj from './features.json';
## Client
### Setup
<DocDefinitionList data={[featuresObj.client.setup]}/>
### Start
<DocDefinitionList data={[featuresObj.client.start]}/>
### Classes
<DocDefinitionList data={featuresObj.client.classes}/>
### Interfaces
<DocDefinitionList data={featuresObj.client.interfaces}/>
## Server
### Objects
<DocDefinitionList data={featuresObj.server.objects}/>
### Classes
<DocDefinitionList data={featuresObj.server.classes}/>
### Interfaces
<DocDefinitionList data={featuresObj.server.interfaces}/>
## Common
### Classes
<DocDefinitionList data={featuresObj.common.classes}/>
### Interfaces
<DocDefinitionList data={featuresObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={featuresObj.common.misc}/>

1797
api_docs/file_upload.json Normal file
View file

File diff suppressed because it is too large Load diff

32
api_docs/file_upload.mdx Normal file
View file

@ -0,0 +1,32 @@
---
id: kibFileUploadPluginApi
slug: /kibana-dev-docs/fileUploadPluginApi
title: fileUpload
image: https://source.unsplash.com/400x175/?github
summary: API docs for the fileUpload plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import fileUploadObj from './file_upload.json';
## Client
### Start
<DocDefinitionList data={[fileUploadObj.client.start]}/>
### Interfaces
<DocDefinitionList data={fileUploadObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fileUploadObj.client.misc}/>
## Common
### Interfaces
<DocDefinitionList data={fileUploadObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fileUploadObj.common.misc}/>

17178
api_docs/fleet.json Normal file
View file

File diff suppressed because it is too large Load diff

73
api_docs/fleet.mdx Normal file
View file

@ -0,0 +1,73 @@
---
id: kibFleetPluginApi
slug: /kibana-dev-docs/fleetPluginApi
title: fleet
image: https://source.unsplash.com/400x175/?github
summary: API docs for the fleet plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import fleetObj from './fleet.json';
## Client
### Setup
<DocDefinitionList data={[fleetObj.client.setup]}/>
### Start
<DocDefinitionList data={[fleetObj.client.start]}/>
### Objects
<DocDefinitionList data={fleetObj.client.objects}/>
### Functions
<DocDefinitionList data={fleetObj.client.functions}/>
### Interfaces
<DocDefinitionList data={fleetObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fleetObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[fleetObj.server.setup]}/>
### Start
<DocDefinitionList data={[fleetObj.server.start]}/>
### Objects
<DocDefinitionList data={fleetObj.server.objects}/>
### Functions
<DocDefinitionList data={fleetObj.server.functions}/>
### Interfaces
<DocDefinitionList data={fleetObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fleetObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={fleetObj.common.objects}/>
### Functions
<DocDefinitionList data={fleetObj.common.functions}/>
### Classes
<DocDefinitionList data={fleetObj.common.classes}/>
### Interfaces
<DocDefinitionList data={fleetObj.common.interfaces}/>
### Enums
<DocDefinitionList data={fleetObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={fleetObj.common.misc}/>

1383
api_docs/global_search.json Normal file
View file

File diff suppressed because it is too large Load diff

41
api_docs/global_search.mdx Normal file
View file

@ -0,0 +1,41 @@
---
id: kibGlobalSearchPluginApi
slug: /kibana-dev-docs/globalSearchPluginApi
title: globalSearch
image: https://source.unsplash.com/400x175/?github
summary: API docs for the globalSearch plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import globalSearchObj from './global_search.json';
## Client
### Setup
<DocDefinitionList data={[globalSearchObj.client.setup]}/>
### Start
<DocDefinitionList data={[globalSearchObj.client.start]}/>
### Interfaces
<DocDefinitionList data={globalSearchObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={globalSearchObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[globalSearchObj.server.setup]}/>
### Start
<DocDefinitionList data={[globalSearchObj.server.start]}/>
### Interfaces
<DocDefinitionList data={globalSearchObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={globalSearchObj.server.misc}/>

1504
api_docs/home.json Normal file
View file

File diff suppressed because it is too large Load diff

56
api_docs/home.mdx Normal file
View file

@ -0,0 +1,56 @@
---
id: kibHomePluginApi
slug: /kibana-dev-docs/homePluginApi
title: home
image: https://source.unsplash.com/400x175/?github
summary: API docs for the home plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import homeObj from './home.json';
## Client
### Setup
<DocDefinitionList data={[homeObj.client.setup]}/>
### Start
<DocDefinitionList data={[homeObj.client.start]}/>
### Objects
<DocDefinitionList data={homeObj.client.objects}/>
### Functions
<DocDefinitionList data={homeObj.client.functions}/>
### Interfaces
<DocDefinitionList data={homeObj.client.interfaces}/>
### Enums
<DocDefinitionList data={homeObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={homeObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[homeObj.server.setup]}/>
### Start
<DocDefinitionList data={[homeObj.server.start]}/>
### Objects
<DocDefinitionList data={homeObj.server.objects}/>
### Interfaces
<DocDefinitionList data={homeObj.server.interfaces}/>
### Enums
<DocDefinitionList data={homeObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={homeObj.server.misc}/>

105
api_docs/index_lifecycle_management.json Normal file
View file

@ -0,0 +1,105 @@
{
"id": "indexLifecycleManagement",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.IlmUrlGeneratorState",
"type": "Interface",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L22"
},
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L23"
},
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L24"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L21"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.ILM_URL_GENERATOR_ID",
"type": "string",
"label": "ILM_URL_GENERATOR_ID",
"description": [],
"source": {
"path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L19"
},
"signature": [
"\"ILM_URL_GENERATOR_ID\""
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

21
api_docs/index_lifecycle_management.mdx Normal file
View file

@ -0,0 +1,21 @@
---
id: kibIndexLifecycleManagementPluginApi
slug: /kibana-dev-docs/indexLifecycleManagementPluginApi
title: indexLifecycleManagement
image: https://source.unsplash.com/400x175/?github
summary: API docs for the indexLifecycleManagement plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import indexLifecycleManagementObj from './index_lifecycle_management.json';
## Client
### Interfaces
<DocDefinitionList data={indexLifecycleManagementObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={indexLifecycleManagementObj.client.misc}/>

2607
api_docs/index_management.json Normal file
View file

File diff suppressed because it is too large Load diff

43
api_docs/index_management.mdx Normal file
View file

@ -0,0 +1,43 @@
---
id: kibIndexManagementPluginApi
slug: /kibana-dev-docs/indexManagementPluginApi
title: indexManagement
image: https://source.unsplash.com/400x175/?github
summary: API docs for the indexManagement plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import indexManagementObj from './index_management.json';
## Client
### Functions
<DocDefinitionList data={indexManagementObj.client.functions}/>
### Interfaces
<DocDefinitionList data={indexManagementObj.client.interfaces}/>
## Server
### Setup
<DocDefinitionList data={[indexManagementObj.server.setup]}/>
### Interfaces
<DocDefinitionList data={indexManagementObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={indexManagementObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={indexManagementObj.common.functions}/>
### Interfaces
<DocDefinitionList data={indexManagementObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={indexManagementObj.common.misc}/>

497
api_docs/index_pattern_field_editor.json Normal file
View file

@ -0,0 +1,497 @@
{
"id": "indexPatternFieldEditor",
"client": {
"classes": [
{
"id": "def-public.DefaultFormatEditor",
"type": "Class",
"tags": [],
"label": "DefaultFormatEditor",
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.DefaultFormatEditor",
"text": "DefaultFormatEditor"
},
"<P, S> extends React.PureComponent<",
"FormatEditorProps",
"<P>, ",
"FormatEditorState",
" & S, any>"
],
"children": [
{
"tags": [],
"id": "def-public.DefaultFormatEditor.formatId",
"type": "string",
"label": "formatId",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L77"
}
},
{
"tags": [],
"id": "def-public.DefaultFormatEditor.state",
"type": "CompoundType",
"label": "state",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 78,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L78"
},
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorState",
"text": "FormatEditorState"
},
" & S"
]
},
{
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps",
"type": "Function",
"label": "getDerivedStateFromProps",
"signature": [
"typeof ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.DefaultFormatEditor",
"text": "DefaultFormatEditor"
},
".getDerivedStateFromProps"
],
"description": [],
"children": [
{
"type": "Object",
"label": "nextProps",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<{}>"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80"
}
},
{
"type": "Object",
"label": "state",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorState",
"text": "FormatEditorState"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80"
}
},
{
"id": "def-public.DefaultFormatEditor.onChange",
"type": "Function",
"children": [
{
"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": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L92"
}
}
],
"signature": [
"(newParams?: {}) => void"
],
"description": [],
"label": "onChange",
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L92"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.DefaultFormatEditor.render",
"type": "Function",
"label": "render",
"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": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L101"
}
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L73"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.OpenFieldEditorOptions",
"type": "Interface",
"label": "OpenFieldEditorOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.OpenFieldEditorOptions.ctx",
"type": "Object",
"label": "ctx",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L28"
},
"signature": [
"{ indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"; }"
]
},
{
"tags": [],
"id": "def-public.OpenFieldEditorOptions.onSave",
"type": "Function",
"label": "onSave",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L31"
},
"signature": [
"((field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
") => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.OpenFieldEditorOptions.fieldName",
"type": "string",
"label": "fieldName",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L32"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L27"
},
"initialIsOpen": false
},
{
"id": "def-public.FieldEditorContext",
"type": "Interface",
"label": "FieldEditorContext",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FieldEditorContext.indexPattern",
"type": "Object",
"label": "indexPattern",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L28"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
]
},
{
"tags": [],
"id": "def-public.FieldEditorContext.fieldTypeToProcess",
"type": "CompoundType",
"label": "fieldTypeToProcess",
"description": [
"\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L33"
},
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.InternalFieldType",
"text": "InternalFieldType"
}
]
},
{
"tags": [],
"id": "def-public.FieldEditorContext.search",
"type": "Object",
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L35"
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataSearchPluginApi",
"section": "def-public.ISearchStart",
"text": "ISearchStart"
}
]
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L27"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"id": "def-public.PluginStart",
"type": "Interface",
"label": "PluginStart",
"description": [],
"tags": [],
"children": [
{
"id": "def-public.PluginStart.openEditor",
"type": "Function",
"label": "openEditor",
"signature": [
"(options: ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.OpenFieldEditorOptions",
"text": "OpenFieldEditorOptions"
},
") => () => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.OpenFieldEditorOptions",
"text": "OpenFieldEditorOptions"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L26"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L26"
}
},
{
"tags": [],
"id": "def-public.PluginStart.fieldFormatEditors",
"type": "Object",
"label": "fieldFormatEditors",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L27"
},
"signature": [
"{ getAll: () => typeof ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.DefaultFormatEditor",
"text": "DefaultFormatEditor"
},
"[]; getById: (id: string) => typeof ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.DefaultFormatEditor",
"text": "DefaultFormatEditor"
},
" | undefined; }"
]
},
{
"tags": [],
"id": "def-public.PluginStart.userPermissions",
"type": "Object",
"label": "userPermissions",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L28"
},
"signature": [
"{ editIndexPattern: () => boolean; }"
]
},
{
"tags": [],
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider",
"type": "Function",
"label": "DeleteRuntimeFieldProvider",
"description": [],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L31"
},
"signature": [
"React.FunctionComponent<",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.Props",
"text": "Props"
},
">"
]
}
],
"source": {
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L25"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

24
api_docs/index_pattern_field_editor.mdx Normal file
View file

@ -0,0 +1,24 @@
---
id: kibIndexPatternFieldEditorPluginApi
slug: /kibana-dev-docs/indexPatternFieldEditorPluginApi
title: indexPatternFieldEditor
image: https://source.unsplash.com/400x175/?github
summary: API docs for the indexPatternFieldEditor plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternFieldEditor']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import indexPatternFieldEditorObj from './index_pattern_field_editor.json';
## Client
### Start
<DocDefinitionList data={[indexPatternFieldEditorObj.client.start]}/>
### Classes
<DocDefinitionList data={indexPatternFieldEditorObj.client.classes}/>
### Interfaces
<DocDefinitionList data={indexPatternFieldEditorObj.client.interfaces}/>

914
api_docs/index_pattern_management.json Normal file
View file

@ -0,0 +1,914 @@
{
"id": "indexPatternManagement",
"client": {
"classes": [
{
"id": "def-public.IndexPatternCreationConfig",
"type": "Class",
"tags": [],
"label": "IndexPatternCreationConfig",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.key",
"type": "string",
"label": "key",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L38"
},
"signature": [
"\"default\""
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L40"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L41"
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.showSystemIndices",
"type": "boolean",
"label": "showSystemIndices",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L42"
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.httpClient",
"type": "CompoundType",
"label": "httpClient",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L43"
},
"signature": [
"object | null"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.isBeta",
"type": "boolean",
"label": "isBeta",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L44"
}
},
{
"id": "def-public.IndexPatternCreationConfig.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }",
"type": "Object",
"label": "{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L53"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L54"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.showSystemIndices",
"type": "CompoundType",
"label": "showSystemIndices",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L55"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.httpClient",
"type": "CompoundType",
"label": "httpClient",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 56,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L56"
},
"signature": [
"object | null | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.isBeta",
"type": "CompoundType",
"label": "isBeta",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 57,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L57"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L52"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L46"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternCreationOption",
"type": "Function",
"label": "getIndexPatternCreationOption",
"signature": [
"(urlHandler: ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.UrlHandler",
"text": "UrlHandler"
},
") => ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationOption",
"text": "IndexPatternCreationOption"
}
],
"description": [],
"children": [
{
"type": "Function",
"label": "urlHandler",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.UrlHandler",
"text": "UrlHandler"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternType",
"type": "Function",
"label": "getIndexPatternType",
"signature": [
"() => string | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L77"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternName",
"type": "Function",
"label": "getIndexPatternName",
"signature": [
"() => string"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L81"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIsBeta",
"type": "Function",
"label": "getIsBeta",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L85"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getShowSystemIndices",
"type": "Function",
"label": "getShowSystemIndices",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L89"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexTags",
"type": "Function",
"label": "getIndexTags",
"signature": [
"(indexName: string) => never[]"
],
"description": [],
"children": [
{
"type": "string",
"label": "indexName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 93,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 93,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93"
}
},
{
"id": "def-public.IndexPatternCreationConfig.checkIndicesForErrors",
"type": "Function",
"label": "checkIndicesForErrors",
"signature": [
"(indices: ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.MatchedItem",
"text": "MatchedItem"
},
"[]) => undefined"
],
"description": [],
"children": [
{
"type": "Array",
"label": "indices",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.MatchedItem",
"text": "MatchedItem"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 97,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 97,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternMappings",
"type": "Function",
"label": "getIndexPatternMappings",
"signature": [
"() => {}"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L101"
}
},
{
"id": "def-public.IndexPatternCreationConfig.renderPrompt",
"type": "Function",
"label": "renderPrompt",
"signature": [
"() => null"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 105,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L105"
}
},
{
"id": "def-public.IndexPatternCreationConfig.getFetchForWildcardOptions",
"type": "Function",
"label": "getFetchForWildcardOptions",
"signature": [
"() => {}"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 109,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L109"
}
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L37"
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternListConfig",
"type": "Class",
"tags": [],
"label": "IndexPatternListConfig",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternListConfig.key",
"type": "string",
"label": "key",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L26"
},
"signature": [
"\"default\""
]
},
{
"id": "def-public.IndexPatternListConfig.getIndexPatternTags",
"type": "Function",
"label": "getIndexPatternTags",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
">, isDefault: boolean) => ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternTag",
"text": "IndexPatternTag"
},
"[]"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L29"
}
},
{
"type": "boolean",
"label": "isDefault",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L30"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L28"
}
},
{
"id": "def-public.IndexPatternListConfig.getFieldInfo",
"type": "Function",
"label": "getFieldInfo",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
") => string[]"
],
"description": [],
"children": [
{
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"
}
},
{
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"
}
},
{
"id": "def-public.IndexPatternListConfig.areScriptedFieldsEnabled",
"type": "Function",
"label": "areScriptedFieldsEnabled",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => boolean"
],
"description": [],
"children": [
{
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46"
}
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L25"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.IndexPatternCreationOption",
"type": "Interface",
"label": "IndexPatternCreationOption",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L30"
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L31"
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.testSubj",
"type": "string",
"label": "testSubj",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L32"
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.onClick",
"type": "Function",
"label": "onClick",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L33"
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.isBeta",
"type": "CompoundType",
"label": "isBeta",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L34"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L29"
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.MlCardState",
"type": "Enum",
"label": "MlCardState",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/types.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/types.ts#L42"
},
"initialIsOpen": false
}
],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.IndexPatternManagementSetup",
"type": "Type",
"label": "IndexPatternManagementSetup",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/plugin.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L32"
},
"signature": [
"{ creation: { addCreationConfig: (Config: typeof ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationConfig",
"text": "IndexPatternCreationConfig"
},
") => void; }; list: { addListConfig: (Config: typeof ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternListConfig",
"text": "IndexPatternListConfig"
},
") => void; }; environment: { update: (update: Partial<",
"Environment",
">) => void; }; }"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.IndexPatternManagementStart",
"type": "Type",
"label": "IndexPatternManagementStart",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/plugin.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L34"
},
"signature": [
"{ creation: { getType: (key: string | undefined) => ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationConfig",
"text": "IndexPatternCreationConfig"
},
"; getIndexPatternCreationOptions: (urlHandler: ",
"UrlHandler",
") => Promise<",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationOption",
"text": "IndexPatternCreationOption"
},
"[]>; }; list: { getIndexPatternTags: (indexPattern: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.IIndexPattern",
"text": "IIndexPattern"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

30
api_docs/index_pattern_management.mdx Normal file
View file

@ -0,0 +1,30 @@
---
id: kibIndexPatternManagementPluginApi
slug: /kibana-dev-docs/indexPatternManagementPluginApi
title: indexPatternManagement
image: https://source.unsplash.com/400x175/?github
summary: API docs for the indexPatternManagement plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternManagement']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import indexPatternManagementObj from './index_pattern_management.json';
## Client
### Setup
<DocDefinitionList data={[indexPatternManagementObj.client.setup]}/>
### Start
<DocDefinitionList data={[indexPatternManagementObj.client.start]}/>
### Classes
<DocDefinitionList data={indexPatternManagementObj.client.classes}/>
### Interfaces
<DocDefinitionList data={indexPatternManagementObj.client.interfaces}/>
### Enums
<DocDefinitionList data={indexPatternManagementObj.client.enums}/>

270
api_docs/infra.json Normal file
View file

@ -0,0 +1,270 @@
{
"id": "infra",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.LazyLogStreamWrapper",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "props",
"isRequired": true,
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "infra",
"scope": "public",
"docId": "kibInfraPluginApi",
"section": "def-public.LogStreamProps",
"text": "LogStreamProps"
},
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"id": "def-public.InfraFormatterType",
"type": "Enum",
"label": "InfraFormatterType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/infra/public/lib/lib.ts",
"lineNumber": 147,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/lib/lib.ts#L147"
},
"initialIsOpen": false
}
],
"misc": [
{
"id": "def-public.InfraAppId",
"type": "Type",
"label": "InfraAppId",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/infra/public/index.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/index.ts#L29"
},
"signature": [
"\"metrics\" | \"logs\""
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-public.FORMATTERS",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FORMATTERS.number",
"type": "Function",
"label": "number",
"description": [],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L16"
},
"signature": [
"(val: number) => string"
]
},
{
"tags": [],
"id": "def-public.FORMATTERS.abbreviatedNumber",
"type": "Function",
"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."
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L19"
},
"signature": [
"(bytes: number) => string"
]
},
{
"tags": [],
"id": "def-public.FORMATTERS.bytes",
"type": "Function",
"label": "bytes",
"description": [
"// bytes in bytes formatted string out"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L21"
},
"signature": [
"(bytes: number) => string"
]
},
{
"tags": [],
"id": "def-public.FORMATTERS.bits",
"type": "Function",
"label": "bits",
"description": [
"// bytes in bits formatted string out"
],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L23"
},
"signature": [
"(bytes: number) => string"
]
},
{
"tags": [],
"id": "def-public.FORMATTERS.percent",
"type": "Function",
"label": "percent",
"description": [],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L24"
},
"signature": [
"(val: number) => string"
]
},
{
"tags": [],
"id": "def-public.FORMATTERS.highPercision",
"type": "Function",
"label": "highPercision",
"description": [],
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L25"
},
"signature": [
"(val: number) => string"
]
}
],
"description": [],
"label": "FORMATTERS",
"source": {
"path": "x-pack/plugins/infra/common/formatters/index.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L15"
},
"initialIsOpen": false
}
]
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-server.InfraConfig",
"type": "Type",
"label": "InfraConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L64"
},
"signature": [
"{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; container?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly query: Readonly<{} & { partitionSize: number; partitionFactor: number; }>; }"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-server.InfraPluginSetup",
"type": "Interface",
"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": 75,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L75"
},
"signature": [
"(sourceId: string, sourceProperties: ",
{
"pluginId": "infra",
"scope": "common",
"docId": "kibInfraPluginApi",
"section": "def-common.InfraStaticSourceConfiguration",
"text": "InfraStaticSourceConfiguration"
},
") => void"
]
}
],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 74,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L74"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

35
api_docs/infra.mdx Normal file
View file

@ -0,0 +1,35 @@
---
id: kibInfraPluginApi
slug: /kibana-dev-docs/infraPluginApi
title: infra
image: https://source.unsplash.com/400x175/?github
summary: API docs for the infra plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import infraObj from './infra.json';
## Client
### Objects
<DocDefinitionList data={infraObj.client.objects}/>
### Functions
<DocDefinitionList data={infraObj.client.functions}/>
### Enums
<DocDefinitionList data={infraObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={infraObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[infraObj.server.setup]}/>
### Consts, variables and types
<DocDefinitionList data={infraObj.server.misc}/>

207
api_docs/ingest_pipelines.json Normal file
View file

@ -0,0 +1,207 @@
{
"id": "ingestPipelines",
"client": {
"classes": [
{
"id": "def-public.IngestPipelinesUrlGenerator",
"type": "Class",
"tags": [],
"label": "IngestPipelinesUrlGenerator",
"description": [],
"signature": [
{
"pluginId": "ingestPipelines",
"scope": "public",
"docId": "kibIngestPipelinesPluginApi",
"section": "def-public.IngestPipelinesUrlGenerator",
"text": "IngestPipelinesUrlGenerator"
},
" implements ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorsDefinition",
"text": "UrlGeneratorsDefinition"
},
"<\"INGEST_PIPELINES_APP_URL_GENERATOR\">"
],
"children": [
{
"id": "def-public.IngestPipelinesUrlGenerator.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 57,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57"
}
},
{
"tags": [],
"id": "def-public.IngestPipelinesUrlGenerator.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L59"
},
"signature": [
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
]
},
{
"id": "def-public.IngestPipelinesUrlGenerator.createUrl",
"type": "Function",
"children": [
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61"
}
}
],
"signature": [
"(state: ",
{
"pluginId": "ingestPipelines",
"scope": "public",
"docId": "kibIngestPipelinesPluginApi",
"section": "def-public.IngestPipelinesUrlGeneratorState",
"text": "IngestPipelinesUrlGeneratorState"
},
") => Promise<string>"
],
"description": [],
"label": "createUrl",
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61"
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L55"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [
{
"id": "def-public.INGEST_PIPELINES_PAGES",
"type": "Enum",
"label": "INGEST_PIPELINES_PAGES",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L22"
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-public.INGEST_PIPELINES_APP_ULR_GENERATOR",
"type": "string",
"label": "INGEST_PIPELINES_APP_ULR_GENERATOR",
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L20"
},
"signature": [
"\"INGEST_PIPELINES_APP_URL_GENERATOR\""
],
"initialIsOpen": false
},
{
"id": "def-public.IngestPipelinesUrlGeneratorState",
"type": "Type",
"label": "IngestPipelinesUrlGeneratorState",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L49"
},
"signature": [
"PipelinesListUrlGeneratorState",
" | ",
"PipelineEditUrlGeneratorState",
" | ",
"PipelineCloneUrlGeneratorState",
" | ",
"PipelineCreateUrlGeneratorState"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

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