kibana/api_docs/embeddable.mdx
Stacey Gammon 7111bcf5f4
Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236) (#107905)
* Fix the bug and update tests

* update api docs

* Fix tests
# Conflicts:
#	api_docs/charts.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_field_formats.mdx
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/es_ui_shared.mdx
#	api_docs/fleet.mdx
#	api_docs/reporting.json
#	api_docs/rule_registry.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
#	api_docs/timelines.json
#	api_docs/timelines.mdx
#	api_docs/visualizations.mdx
2021-08-09 12:51:00 -04:00

77 lines
1.8 KiB
Plaintext

---
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';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 460 | 5 | 388 | 3 |
## 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]}/>
### Start
<DocDefinitionList data={[embeddableObj.server.start]}/>
### 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}/>