Skip to content

Commit

Permalink
Improve deprecated API list, and update api docs (#106942) (#107441)
Browse files Browse the repository at this point in the history
* Code to adjust deprecated api list

* updated docs

* fix and update tests
# Conflicts:
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	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.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations.mdx
#	api_docs/kibana_react.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
  • Loading branch information
stacey-gammon authored Aug 2, 2021
1 parent 14563db commit 2fcf3e4
Show file tree
Hide file tree
Showing 137 changed files with 68,812 additions and 48,676 deletions.
144 changes: 85 additions & 59 deletions api_docs/actions.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api_docs/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import actionsObj from './actions.json';

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 116 | 0 | 116 | 7 |
| 117 | 0 | 117 | 7 |

## Server

Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import advancedSettingsObj from './advanced_settings.json';




Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for questions regarding this plugin.

**Code health stats**

Expand Down
823 changes: 705 additions & 118 deletions api_docs/alerting.json

Large diffs are not rendered by default.

8 changes: 7 additions & 1 deletion api_docs/alerting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import alertingObj from './alerting.json';

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 216 | 0 | 208 | 14 |
| 242 | 0 | 234 | 16 |

## Client

Expand All @@ -36,9 +36,15 @@ import alertingObj from './alerting.json';
### Functions
<DocDefinitionList data={alertingObj.server.functions}/>

### Classes
<DocDefinitionList data={alertingObj.server.classes}/>

### Interfaces
<DocDefinitionList data={alertingObj.server.interfaces}/>

### Enums
<DocDefinitionList data={alertingObj.server.enums}/>

### Consts, variables and types
<DocDefinitionList data={alertingObj.server.misc}/>

Expand Down
272 changes: 217 additions & 55 deletions api_docs/apm.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions api_docs/apm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ import apmObj from './apm.json';




Contact APM UI for questions regarding this plugin.

**Code health stats**

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 37 | 0 | 37 | 30 |
| 39 | 0 | 39 | 30 |

## Client

Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm_oss.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
],
"source": {
"path": "src/plugins/apm_oss/server/index.ts",
"lineNumber": 31
"lineNumber": 34
},
"deprecated": false,
"initialIsOpen": false
Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm_oss.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import apmOssObj from './apm_oss.json';




Contact APM UI for questions regarding this plugin.

**Code health stats**

Expand Down
4 changes: 2 additions & 2 deletions api_docs/canvas.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 68
"lineNumber": 69
},
"deprecated": false,
"lifecycle": "setup",
Expand All @@ -84,7 +84,7 @@
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 69
"lineNumber": 70
},
"deprecated": false,
"lifecycle": "start",
Expand Down
Loading

0 comments on commit 2fcf3e4

Please sign in to comment.