e097adbb6a
* Fixes - Fix bad formatting of deprecated apis by plugin - Collect deprecated apis recursively - Include unreferenced apis in Deprecated apis by API page. * Fix unreferenced dep list * check in updated docs * Fix the issue with saved objects management plugin docs not being included * adding the new docs after fixing some docs missing * update api docs
50 lines
1.4 KiB
Text
50 lines
1.4 KiB
Text
---
|
|
id: kibRuleRegistryPluginApi
|
|
slug: /kibana-dev-docs/ruleRegistryPluginApi
|
|
title: ruleRegistry
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the ruleRegistry plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry']
|
|
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 ruleRegistryObj from './rule_registry.json';
|
|
|
|
|
|
|
|
Contact [RAC](https://github.com/orgs/elastic/teams/rac) for questions regarding this plugin.
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 136 | 0 | 114 | 7 |
|
|
|
|
## Server
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[ruleRegistryObj.server.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[ruleRegistryObj.server.start]}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={ruleRegistryObj.server.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={ruleRegistryObj.server.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={ruleRegistryObj.server.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={ruleRegistryObj.server.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={ruleRegistryObj.server.misc}/>
|
|
|
|
## Common
|
|
|
|
### Functions
|
|
<DocDefinitionList data={ruleRegistryObj.common.functions}/>
|
|
|