e9a4028005
* Add comments. Remove ruleType as the second param, not needed. * Add comments. Remove ruleType as the second param, not needed. * Fix bad type check and update docs * update docs * Remove unused import * change exports to type to avoid increasing bundle size * Update x-pack/plugins/alerting/public/plugin.ts Co-authored-by: ymao1 <ying.mao@elastic.co> * Update x-pack/plugins/alerting/public/plugin.ts Co-authored-by: ymao1 <ying.mao@elastic.co> * Update x-pack/plugins/alerting/public/plugin.ts Co-authored-by: ymao1 <ying.mao@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: ymao1 <ying.mao@elastic.co>
63 lines
1.5 KiB
Plaintext
63 lines
1.5 KiB
Plaintext
---
|
|
id: kibAlertingPluginApi
|
|
slug: /kibana-dev-docs/alertingPluginApi
|
|
title: alerting
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the alerting plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
|
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 alertingObj from './alerting.json';
|
|
|
|
|
|
|
|
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 213 | 0 | 213 | 15 |
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[alertingObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[alertingObj.client.start]}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={alertingObj.client.misc}/>
|
|
|
|
## Server
|
|
|
|
### Functions
|
|
<DocDefinitionList data={alertingObj.server.functions}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={alertingObj.server.interfaces}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={alertingObj.server.misc}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={alertingObj.common.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={alertingObj.common.functions}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={alertingObj.common.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={alertingObj.common.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={alertingObj.common.misc}/>
|
|
|