0254ff06b5
* 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
86 lines
1.9 KiB
Text
86 lines
1.9 KiB
Text
---
|
|
id: kibFleetPluginApi
|
|
slug: /kibana-dev-docs/fleetPluginApi
|
|
title: fleet
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the fleet plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
|
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 fleetObj from './fleet.json';
|
|
|
|
|
|
|
|
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 1071 | 15 | 981 | 8 |
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[fleetObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[fleetObj.client.start]}/>
|
|
|
|
### Objects
|
|
<DocDefinitionList data={fleetObj.client.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={fleetObj.client.functions}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={fleetObj.client.interfaces}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={fleetObj.client.misc}/>
|
|
|
|
## Server
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[fleetObj.server.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[fleetObj.server.start]}/>
|
|
|
|
### Objects
|
|
<DocDefinitionList data={fleetObj.server.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={fleetObj.server.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={fleetObj.server.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={fleetObj.server.interfaces}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={fleetObj.server.misc}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={fleetObj.common.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={fleetObj.common.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={fleetObj.common.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={fleetObj.common.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={fleetObj.common.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={fleetObj.common.misc}/>
|
|
|