maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/apm_oss.mdx

39 lines
1 KiB
Plaintext
Raw Normal View History

API DOCS Step 3/3 (#92929) (#93530) * update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
2021-03-04 02:12:24 +01:00
---
id: kibApmOssPluginApi
Add packages to our API documentation (#113564) (#114513) * Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs # Conflicts: # api_docs/alerting.mdx # api_docs/apm.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/custom_integrations.mdx # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_data_views.json # api_docs/data_data_views.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/embeddable.json # api_docs/event_log.mdx # api_docs/fleet.mdx # api_docs/home.json # api_docs/index_management.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.mdx # api_docs/plugin_directory.mdx # api_docs/security_oss.mdx
2021-10-11 19:58:18 +02:00
slug: /kibana-dev-docs/api/apmOss
title: "apmOss"
API DOCS Step 3/3 (#92929) (#93530) * update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
2021-03-04 02:12:24 +01:00
image: https://source.unsplash.com/400x175/?github
summary: API docs for the apmOss plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmOss']
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 apmOssObj from './apm_oss.json';
Support owner and description attributes inside the Manifest file, use in API docs (#101786) (#101841) * Support owner and description in manifest file, add to mdx output for each plugin * Update parse_kibana_platform_plugin.ts * edit a couple kibana.jsons * Update write_plugin_mdx_docs.ts * update api docs * Update core server manifest plugin types * update core docs * Fix type_check failure Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-10 21:18:24 +02:00
API Doc Fixes (#109685) (#110466) * Fixes - Fix bad formatting of deprecated apis by plugin - Collect deprecated apis recursively - Include unreferenced apis in Deprecated apis by API page. * Fix unreferenced dep list * check in updated docs * Fix the issue with saved objects management plugin docs not being included * adding the new docs after fixing some docs missing * update api docs # Conflicts: # api_docs/apm.json # api_docs/charts.mdx # api_docs/core.mdx # api_docs/core_application.mdx # api_docs/core_chrome.json # 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.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/expression_shape.json # api_docs/expression_shape.mdx # api_docs/expressions.json # api_docs/field_formats.json # api_docs/fleet.json # api_docs/kibana_react.json # api_docs/kibana_react.mdx # api_docs/lists.json # api_docs/observability.json # api_docs/reporting.json # api_docs/rule_registry.json # api_docs/rule_registry.mdx # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/visualizations.mdx
2021-08-30 17:02:04 +02:00
Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin.
Support owner and description attributes inside the Manifest file, use in API docs (#101786) (#101841) * Support owner and description in manifest file, add to mdx output for each plugin * Update parse_kibana_platform_plugin.ts * edit a couple kibana.jsons * Update write_plugin_mdx_docs.ts * update api docs * Update core server manifest plugin types * update core docs * Fix type_check failure Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-10 21:18:24 +02:00
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
API Doc Fixes (#109685) (#110466) * Fixes - Fix bad formatting of deprecated apis by plugin - Collect deprecated apis recursively - Include unreferenced apis in Deprecated apis by API page. * Fix unreferenced dep list * check in updated docs * Fix the issue with saved objects management plugin docs not being included * adding the new docs after fixing some docs missing * update api docs # Conflicts: # api_docs/apm.json # api_docs/charts.mdx # api_docs/core.mdx # api_docs/core_application.mdx # api_docs/core_chrome.json # 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.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/expression_shape.json # api_docs/expression_shape.mdx # api_docs/expressions.json # api_docs/field_formats.json # api_docs/fleet.json # api_docs/kibana_react.json # api_docs/kibana_react.mdx # api_docs/lists.json # api_docs/observability.json # api_docs/reporting.json # api_docs/rule_registry.json # api_docs/rule_registry.mdx # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/visualizations.mdx
2021-08-30 17:02:04 +02:00
| 6 | 0 | 6 | 0 |
## Client
### Setup
<DocDefinitionList data={[apmOssObj.client.setup]}/>
### Start
<DocDefinitionList data={[apmOssObj.client.start]}/>
Support owner and description attributes inside the Manifest file, use in API docs (#101786) (#101841) * Support owner and description in manifest file, add to mdx output for each plugin * Update parse_kibana_platform_plugin.ts * edit a couple kibana.jsons * Update write_plugin_mdx_docs.ts * update api docs * Update core server manifest plugin types * update core docs * Fix type_check failure Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-10 21:18:24 +02:00
API DOCS Step 3/3 (#92929) (#93530) * update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
2021-03-04 02:12:24 +01:00
## Server
### Setup
<DocDefinitionList data={[apmOssObj.server.setup]}/>
### Consts, variables and types
<DocDefinitionList data={apmOssObj.server.misc}/>
Reference in a new issue Copy permalink