ede34a84a2
* Clean up api doc infra * updated docs * Update api dics # Conflicts: # api_docs/actions.mdx # api_docs/alerting.json # api_docs/core.mdx # api_docs/core_application.mdx # api_docs/core_chrome.mdx # api_docs/core_http.mdx # api_docs/core_saved_objects.mdx # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_index_patterns.json # api_docs/data_index_patterns.mdx # api_docs/data_query.mdx # api_docs/data_search.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/discover_enhanced.json # api_docs/expressions.mdx # api_docs/interactive_setup.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.json # api_docs/rule_registry.json # api_docs/saved_objects.json # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/url_forwarding.json
51 lines
1.4 KiB
Plaintext
51 lines
1.4 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';
|
|
|
|
|
|
|
|
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 |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 132 | 0 | 109 | 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}/>
|
|
|