23ce8dcfdb
* Rename alerts plugin to alerting * Deprecate old config values * Few more renames * Update plugin list * Rename xpack.alerts -> xpack.alerting * Fix some ESLint rules * Fix typecheck * Fix some test failures * Some more renames * Fix ESLint * Fix some test failures * Fix failing jest test * Undo exclusive test * Fix APM deps * Fix docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
50 lines
1.2 KiB
Plaintext
50 lines
1.2 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';
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[alertingObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[alertingObj.client.start]}/>
|
|
|
|
## 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}/>
|
|
|