kibana/api_docs/inspector.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

55 lines
1.3 KiB
Plaintext

---
id: kibInspectorPluginApi
slug: /kibana-dev-docs/inspectorPluginApi
title: inspector
image: https://source.unsplash.com/400x175/?github
summary: API docs for the inspector plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
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 inspectorObj from './inspector.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 101 | 6 | 78 | 4 |
## Client
### Setup
<DocDefinitionList data={[inspectorObj.client.setup]}/>
### Start
<DocDefinitionList data={[inspectorObj.client.start]}/>
### Classes
<DocDefinitionList data={inspectorObj.client.classes}/>
### Interfaces
<DocDefinitionList data={inspectorObj.client.interfaces}/>
### Enums
<DocDefinitionList data={inspectorObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={inspectorObj.client.misc}/>
## Common
### Classes
<DocDefinitionList data={inspectorObj.common.classes}/>
### Interfaces
<DocDefinitionList data={inspectorObj.common.interfaces}/>
### Enums
<DocDefinitionList data={inspectorObj.common.enums}/>