kibana/api_docs/rule_registry.mdx

62 lines
1.7 KiB
Text

---
####
#### 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.
####
id: kibRuleRegistryPluginApi
slug: /kibana-dev-docs/api/ruleRegistry
title: "ruleRegistry"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ruleRegistry plugin
date: 2023-08-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry']
---
import ruleRegistryObj from './rule_registry.devdocs.json';
Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 264 | 0 | 235 | 14 |
## Server
### Setup
<DocDefinitionList data={[ruleRegistryObj.server.setup]}/>
### Start
<DocDefinitionList data={[ruleRegistryObj.server.start]}/>
### Objects
<DocDefinitionList data={ruleRegistryObj.server.objects}/>
### 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}/>
### Interfaces
<DocDefinitionList data={ruleRegistryObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={ruleRegistryObj.common.misc}/>