kibana/api_docs/home.mdx
Stacey Gammon d2ee3daa6d
Support owner and description attributes inside the Manifest file, use in API docs (#101786) (#101841)
* Support owner and description in manifest file, add to mdx output for each plugin

* Update parse_kibana_platform_plugin.ts

* edit a couple kibana.jsons

* Update write_plugin_mdx_docs.ts

* update api docs

* Update core server manifest plugin types

* update core docs

* Fix type_check failure

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-10 15:18:24 -04:00

63 lines
1.4 KiB
Text

---
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 |
|-------------------|-----------|------------------------|-----------------|
| 89 | 0 | 65 | 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}/>