Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[7.x] Add packages to our API documentation (#113564) #114513

Merged
merged 1 commit into from
Oct 11, 2021
Merged

[7.x] Add packages to our API documentation (#113564) #114513

merged 1 commit into from
Oct 11, 2021

Conversation

stacey-gammon
Copy link
Contributor

Backports the following commits to 7.x:

@stacey-gammon
Add packages to our API documentation (elastic#113564)
8980ace 
* 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
@stacey-gammon stacey-gammon enabled auto-merge (squash) October 11, 2021 15:33
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@elastic/datemath - 43 +43
@kbn/ace - 11 +11
@kbn/alerts - 9 +9
@kbn/analytics - 69 +69
@kbn/apm-config-loader - 14 +14
@kbn/apm-utils - 11 +11
@kbn/cli-dev-mode - 2 +2
@kbn/config - 52 +52
@kbn/config-schema - 107 +107
@kbn/crypto - 7 +7
@kbn/dev-utils - 231 +231
@kbn/docs-utils - 1 +1
@kbn/es-archiver - 12 +12
@kbn/es-query - 156 +156
@kbn/field-types - 16 +16
@kbn/i18n - 2 +2
@kbn/io-ts-utils - 18 +18
@kbn/legacy-logging - 27 +27
@kbn/logging - 5 +5
@kbn/mapbox-gl - 378 +378
@kbn/monaco - 38 +38
@kbn/optimizer - 44 +44
@kbn/plugin-generator - 1 +1
@kbn/plugin-helpers - 1 +1
@kbn/pm - 49 +49
@kbn/rule-data-utils - 71 +71
@kbn/securitysolution-autocomplete - 34 +34
@kbn/securitysolution-es-utils - 51 +51
@kbn/securitysolution-hook-utils - 1 +1
@kbn/securitysolution-io-ts-alerting-types - 128 +128
@kbn/securitysolution-io-ts-list-types - 409 +409
@kbn/securitysolution-io-ts-types - 23 +23
@kbn/securitysolution-io-ts-utils - 22 +22
@kbn/securitysolution-list-api - 41 +41
@kbn/securitysolution-list-constants - 9 +9
@kbn/securitysolution-list-hooks - 44 +44
@kbn/securitysolution-list-utils - 177 +177
@kbn/securitysolution-t-grid - 116 +116
@kbn/securitysolution-utils - 2 +2
@kbn/server-http-tools - 50 +50
@kbn/server-route-repository - 27 +27
@kbn/std - 63 +63
@kbn/storybook - 18 +18
@kbn/telemetry-tools - 2 +2
@kbn/test - 177 +177
@kbn/typed-react-router-config - 78 +78
@kbn/utility-types - 10 +10
@kbn/utils - 21 +21
total +2878

Any counts in public APIs

Total count of every any typed public API. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats any for more detailed information.

id before after diff
@kbn/ace - 5 +5
@kbn/alerts - 1 +1
@kbn/config-schema - 3 +3
@kbn/dev-utils - 7 +7
@kbn/es-query - 2 +2
@kbn/mapbox-gl - 9 +9
@kbn/securitysolution-autocomplete - 1 +1
@kbn/securitysolution-io-ts-alerting-types - 1 +1
@kbn/securitysolution-io-ts-list-types - 1 +1
@kbn/std - 1 +1
@kbn/storybook - 1 +1
@kbn/test - 5 +5
@kbn/utility-types - 1 +1
@kbn/utils - 1 +1
total +39

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
@kbn/analytics - 4 +4
@kbn/config - 1 +1
@kbn/config-schema - 18 +18
@kbn/dev-utils - 4 +4
@kbn/es-archiver - 1 +1
@kbn/es-query - 14 +14
@kbn/i18n - 2 +2
@kbn/io-ts-utils - 2 +2
@kbn/legacy-logging - 2 +2
@kbn/logging - 37 +37
@kbn/monaco - 3 +3
@kbn/optimizer - 9 +9
@kbn/pm - 5 +5
@kbn/securitysolution-hook-utils - 1 +1
@kbn/securitysolution-list-api - 5 +5
@kbn/server-http-tools - 1 +1
@kbn/server-route-repository - 1 +1
@kbn/std - 2 +2
@kbn/test - 9 +9
@kbn/tinymath - 3 +3
@kbn/typed-react-router-config - 1 +1
@kbn/utility-types - 1 +1
bar - 2 +2
kibana - 843 +843
total +971
Unknown metric groups

API count

id before after diff
@elastic/datemath - 44 +44
@kbn/ace - 11 +11
@kbn/alerts - 9 +9
@kbn/analytics - 69 +69
@kbn/apm-config-loader - 14 +14
@kbn/apm-utils - 11 +11
@kbn/cli-dev-mode - 2 +2
@kbn/config - 73 +73
@kbn/config-schema - 109 +109
@kbn/crypto - 13 +13
@kbn/dev-utils - 258 +258
@kbn/docs-utils - 1 +1
@kbn/es-archiver - 25 +25
@kbn/es-query - 208 +208
@kbn/field-types - 20 +20
@kbn/i18n - 2 +2
@kbn/io-ts-utils - 18 +18
@kbn/legacy-logging - 28 +28
@kbn/logging - 30 +30
@kbn/mapbox-gl - 467 +467
@kbn/monaco - 38 +38
@kbn/optimizer - 44 +44
@kbn/plugin-generator - 1 +1
@kbn/plugin-helpers - 1 +1
@kbn/pm - 63 +63
@kbn/rule-data-utils - 74 +74
@kbn/securitysolution-autocomplete - 47 +47
@kbn/securitysolution-es-utils - 54 +54
@kbn/securitysolution-hook-utils - 8 +8
@kbn/securitysolution-io-ts-alerting-types - 147 +147
@kbn/securitysolution-io-ts-list-types - 418 +418
@kbn/securitysolution-io-ts-types - 45 +45
@kbn/securitysolution-io-ts-utils - 28 +28
@kbn/securitysolution-list-api - 42 +42
@kbn/securitysolution-list-constants - 23 +23
@kbn/securitysolution-list-hooks - 56 +56
@kbn/securitysolution-list-utils - 222 +222
@kbn/securitysolution-t-grid - 120 +120
@kbn/securitysolution-utils - 4 +4
@kbn/server-http-tools - 53 +53
@kbn/server-route-repository - 28 +28
@kbn/std - 96 +96
@kbn/storybook - 18 +18
@kbn/telemetry-tools - 2 +2
@kbn/test - 200 +200
@kbn/typed-react-router-config - 78 +78
@kbn/utility-types - 29 +29
@kbn/utils - 31 +31
total +3382

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@stacey-gammon stacey-gammon merged commit e92a945 into elastic:7.x Oct 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
backport
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@stacey-gammon @kibanamachine