* Stop tracking line numbers * Updated api docs * Fix type error and update tests * wrap label in encodeURIComponent for the links * Update docs after encodeUriComponent change # Conflicts: # api_docs/apm.json # api_docs/canvas.json # api_docs/core.json # api_docs/core_saved_objects.json # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_field_formats.json # api_docs/data_field_formats.mdx # api_docs/data_index_patterns.json # api_docs/data_index_patterns.mdx # api_docs/data_query.mdx # api_docs/data_search.json # api_docs/data_search.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/home.json # api_docs/lens.json # api_docs/monitoring.json # api_docs/presentation_util.json # api_docs/security.json # api_docs/security_solution.json # api_docs/timelines.json
48 lines
1.2 KiB
Plaintext
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 |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 82 | 0 | 82 | 11 |
|
|
|
|
## 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}/>
|
|
|