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

31 lines
929 B
Plaintext
Raw Permalink Normal View History

API DOCS Step 3/3 (#92929) * 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>
2021-03-03 04:02:17 +01:00
---
id: kibBannersPluginApi
Add packages to our API documentation (#113564) * Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs
2021-10-06 23:02:57 +02:00
slug: /kibana-dev-docs/api/banners
title: "banners"
API DOCS Step 3/3 (#92929) * 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>
2021-03-03 04:02:17 +01:00
image: https://source.unsplash.com/400x175/?github
summary: API docs for the banners plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
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 bannersObj from './banners.json';
Support owner and description attributes inside the Manifest file, use in API docs (#101786) * 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
2021-06-09 22:18:21 +02:00
API Doc Fixes (#109685) * 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
2021-08-24 19:42:23 +02:00
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
Support owner and description attributes inside the Manifest file, use in API docs (#101786) * 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
2021-06-09 22:18:21 +02:00
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 9 | 0 |
API DOCS Step 3/3 (#92929) * 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>
2021-03-03 04:02:17 +01:00
## Common
### Interfaces
<DocDefinitionList data={bannersObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={bannersObj.common.misc}/>
Reference in a new issue Copy permalink