kibana/api_docs/data_search.mdx

62 lines
1.5 KiB
Plaintext
Raw Normal View History

---
id: kibDataSearchPluginApi
slug: /kibana-dev-docs/data.searchPluginApi
title: data.search
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data.search plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
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 dataSearchObj from './data_search.json';
## Client
### Functions
<DocDefinitionList data={dataSearchObj.client.functions}/>
### Classes
<DocDefinitionList data={dataSearchObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.client.interfaces}/>
### Enums
<DocDefinitionList data={dataSearchObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.client.misc}/>
## Server
### Functions
<DocDefinitionList data={dataSearchObj.server.functions}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.server.interfaces}/>
Create new alerting HTTP APIs that use the new terminology (#93977) * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <github@gidi.io> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <lcawley@elastic.co> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <github@gidi.io> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
2021-03-30 14:27:28 +02:00
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={dataSearchObj.common.objects}/>
### Functions
<DocDefinitionList data={dataSearchObj.common.functions}/>
### Classes
<DocDefinitionList data={dataSearchObj.common.classes}/>
### Interfaces
<DocDefinitionList data={dataSearchObj.common.interfaces}/>
### Enums
<DocDefinitionList data={dataSearchObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.common.misc}/>