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

* update api docs

* Fix tests
2021-08-03 11:58:03 -04:00

63 lines
1.4 KiB
Plaintext

---
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';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 101 | 3 | 77 | 5 |
## 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}/>
### Enums
<DocDefinitionList data={homeObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={homeObj.server.misc}/>