* 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> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
363 lines
12 KiB
JSON
363 lines
12 KiB
JSON
{
|
|
"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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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/7.xx-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": []
|
|
}
|
|
} |