kibana/api_docs/timelines.mdx
Stacey Gammon ede34a84a2
Clean up some of the API doc code (#111635) (#112085)
* 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
2021-09-14 10:44:20 -04:00

68 lines
1.7 KiB
Plaintext

---
id: kibTimelinesPluginApi
slug: /kibana-dev-docs/timelinesPluginApi
title: timelines
image: https://source.unsplash.com/400x175/?github
summary: API docs for the timelines plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines']
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 timelinesObj from './timelines.json';
Contact [Security solution](https://github.com/orgs/elastic/teams/security-solution) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 968 | 6 | 847 | 25 |
## Client
### Start
<DocDefinitionList data={[timelinesObj.client.start]}/>
### Objects
<DocDefinitionList data={timelinesObj.client.objects}/>
### Functions
<DocDefinitionList data={timelinesObj.client.functions}/>
### Interfaces
<DocDefinitionList data={timelinesObj.client.interfaces}/>
### Enums
<DocDefinitionList data={timelinesObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={timelinesObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[timelinesObj.server.setup]}/>
### Start
<DocDefinitionList data={[timelinesObj.server.start]}/>
## Common
### Objects
<DocDefinitionList data={timelinesObj.common.objects}/>
### Functions
<DocDefinitionList data={timelinesObj.common.functions}/>
### Interfaces
<DocDefinitionList data={timelinesObj.common.interfaces}/>
### Enums
<DocDefinitionList data={timelinesObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={timelinesObj.common.misc}/>