b2903e9f8f
* Clean up public API of cases plugin 1. Don't use export * on index.ts files that define the public API 2. Add comments to the interface show they show up in the API docs 3. Export types that are part of the public API so they show up in the API docs. 4. Fill in information for the up and coming `description` and `owner` items in kibana.json. * Update returns comments to be more descriptive * update api docs * Remove kibana.json attributes, until PR supporting them is merged. * Change all exports to export type to avoid increase page bundle size
60 lines
1.3 KiB
Plaintext
60 lines
1.3 KiB
Plaintext
---
|
|
id: kibCasesPluginApi
|
|
slug: /kibana-dev-docs/casesPluginApi
|
|
title: cases
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the cases plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
|
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 casesObj from './cases.json';
|
|
|
|
|
|
|
|
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 406 | 0 | 381 | 13 |
|
|
|
|
## Client
|
|
|
|
### Start
|
|
<DocDefinitionList data={[casesObj.client.start]}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={casesObj.client.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={casesObj.client.interfaces}/>
|
|
|
|
## Server
|
|
|
|
### Classes
|
|
<DocDefinitionList data={casesObj.server.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={casesObj.server.interfaces}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={casesObj.common.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={casesObj.common.functions}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={casesObj.common.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={casesObj.common.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={casesObj.common.misc}/>
|
|
|