kibana/api_docs/share.mdx
Stacey Gammon 0254ff06b5
Support owner and description attributes inside the Manifest file, use in API docs (#101786)
* 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
2021-06-09 16:18:21 -04:00

48 lines
1.1 KiB
Text

---
id: kibSharePluginApi
slug: /kibana-dev-docs/sharePluginApi
title: share
image: https://source.unsplash.com/400x175/?github
summary: API docs for the share plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share']
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 shareObj from './share.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 67 | 1 | 61 | 4 |
## Client
### Setup
<DocDefinitionList data={[shareObj.client.setup]}/>
### Start
<DocDefinitionList data={[shareObj.client.start]}/>
### Functions
<DocDefinitionList data={shareObj.client.functions}/>
### Classes
<DocDefinitionList data={shareObj.client.classes}/>
### Interfaces
<DocDefinitionList data={shareObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={shareObj.client.misc}/>
## Server
### Consts, variables and types
<DocDefinitionList data={shareObj.server.misc}/>