kibana/api_docs/rule_registry.mdx
Stacey Gammon 899a6f3f11
Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236)
* Fix the bug and update tests

* update api docs

* Fix tests
2021-08-03 11:58:03 -04:00

48 lines
1.2 KiB
Plaintext

---
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';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 62 | 0 | 62 | 9 |
## 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}/>
### Consts, variables and types
<DocDefinitionList data={ruleRegistryObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={ruleRegistryObj.common.functions}/>