Commit graph

20 commits

Author SHA1 Message Date
Stacey Gammon e92a945ab1
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 13:58:18 -04:00
Yaroslav Kuznietsov 0058764851
[MetricVis] Move the expression function and renderer to a separate plugin. (#113427) (#114384)
* Added expressionMetricVis plugin.

* splitted metric vis_type and expression.

* Fixed check errors.

* Fixed plugin docs.

* updated snapshots.

* Added code owner to expressionMetricVis.

* updated chart docs.

* Changed the `Metric` type export.

* Added storybook.

* Added bucket story.

* Added without label story.

* Added "with custom font size" story.

* Added other stories.

* Added DatatableColumn accessors.

* Replaced Metric with MetricOptions.

* Fixed MetricOptions.any

* updated the check of min/max existence.

* Updated function/renderer names.

metricRenderer -> metricVisRenderer
metricFunction -> metricVisFunction

* updated snapshot.

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	.github/CODEOWNERS
#	packages/kbn-optimizer/limits.yml
#	src/dev/code_coverage/ingest_coverage/__tests__/enumerate_patterns.test.js
#	src/dev/code_coverage/ingest_coverage/__tests__/transforms.test.js
2021-10-08 04:28:29 -04:00
Stacey Gammon 5d1916baae
Add a plugin directory page to the docs build (#112862) (#113314)
* Write plugin directory doc as part of api docs build.

* Replace service folder with the new name for index patterns

* Updated docs

* small update

* update docs
# Conflicts:
#	api_docs/actions.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/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.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/event_log.mdx
#	api_docs/maps.json
#	api_docs/maps.mdx
#	api_docs/maps_ems.json
#	api_docs/maps_ems.mdx
#	api_docs/observability.mdx
#	api_docs/saved_objects.json
#	api_docs/security_solution.mdx
2021-09-28 16:58:56 -04:00
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
Stacey Gammon 53fa5ff3fd
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 11:02:04 -04:00
Kibana Machine 32ebd0af7b
[Data cleanup] unify serializable state (#107745) (#108020)
* Use Serializable from package

* Rename to align with core

* fix

* more replacements

* docssss

* fix

* Move it to @kbn/utility-types and remove core export

* buildy build

* tests

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Liza Katz <lizka.k@gmail.com>
2021-08-10 13:33:44 +00:00
Stacey Gammon 7111bcf5f4
Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236) (#107905)
* Fix the bug and update tests

* update api docs

* Fix tests
# Conflicts:
#	api_docs/charts.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_field_formats.mdx
#	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/es_ui_shared.mdx
#	api_docs/fleet.mdx
#	api_docs/reporting.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-09 12:51:00 -04:00
Stacey Gammon 0b9be5df45
Remove line numbers from the json files (#107158) (#107758)
* Stop tracking line numbers

* Updated api docs

* Fix type error and update tests

* wrap label in encodeURIComponent for the links

* Update docs after encodeUriComponent change
# Conflicts:
#	api_docs/apm.json
#	api_docs/canvas.json
#	api_docs/core.json
#	api_docs/core_saved_objects.json
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_field_formats.json
#	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.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/home.json
#	api_docs/lens.json
#	api_docs/monitoring.json
#	api_docs/presentation_util.json
#	api_docs/security.json
#	api_docs/security_solution.json
#	api_docs/timelines.json
2021-08-05 12:26:16 -04:00
Stacey Gammon 3805c55d6e
Update api docs (#103310) (#103904)
* Update api docs

* update api docs after merge from master
# Conflicts:
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/licensing.json
#	api_docs/saved_objects.json
2021-06-30 13:04:59 -04:00
Stacey Gammon fba0dcc79e
Improve security plugin return types (#101492) (#101657)
* Add explicit security types

* Remove sessionTimeout, seems unused

* add comments

* Add comments and fix test since removing the unused APIs

* remove unused import

* wording cleanup

* Export some types that are part of the public API but not exported

* more improvements for api docs

* update security docs

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* remove unneccessary readonly prefix

* Update all api docs

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
# Conflicts:
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/deprecations.mdx
#	api_docs/licensing.json
#	api_docs/lists.json
#	api_docs/triggers_actions_ui.json
#	api_docs/usage_collection.json
2021-06-08 16:26:37 -04:00
Stacey Gammon 2cad521166
Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087)
* Make sure arrow functions capture parameter comments.

* Update docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/licensing.json
#	api_docs/reporting.json
#	api_docs/spaces.json
2021-06-01 17:24:44 -04:00
Alejandro Fernández Gómez 8a62b29374
[Fleet] Remove beats management plugin (#99789) (#101010)
# Conflicts:
#	.github/CODEOWNERS
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/deprecations.mdx
#	api_docs/security.json
#	api_docs/spaces.json
2021-05-31 13:33:12 -04:00
Stacey Gammon 8ee9c3abc4
Fix a bunch of bugs with APIDocs system (#99589) (#100417)
* Remove custom code, add in a hack

* remove artifical limit

* Fix arrow functions in interfaces not having children

* Update docs

* Update api docs after merge from master

* update api docs after merge from master

* update api docs
# Conflicts:
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/deprecations.mdx
#	api_docs/features.json
#	api_docs/licensing.json
#	api_docs/reporting.json
#	api_docs/spaces.json
2021-05-20 16:11:31 -04:00
Stacey Gammon 88f9c4ae02
Add support for building a deprecation list with usage (#99154) (#99538)
* Add support for building a deprecation list with usage

* Update API docs
2021-05-06 17:59:11 -04:00
Stacey Gammon 0a2799d09d
Track API stats as part of ci (#95733) (#97306)
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/reporting.json
2021-04-15 16:47:21 -04:00
Stacey Gammon 8f1264b3c7
update api docs (#95154) (#95428)
# Conflicts:
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/fleet.json
#	api_docs/reporting.json
2021-03-25 14:11:24 -04:00
Joe Reuter def8204814
[Lens] Implement filtered metric (#92589) (#95282) 2021-03-24 08:57:44 -04:00
Stratoula Kalafateli da9e1c313d
[XY axis] Integrates legend color picker with the eui palette (#90589) (#94738)
* XY Axis, integrate legend color picker with the eui palette

* Fix functional test to work with the eui palette

* Order eui colors by group

* Add unit test for use color picker

* Add useMemo to getColorPicker

* Remove the grey background from the first focused circle

* Fix bug caused by comparing lowercase with uppercase characters

* Fix bug on complimentary palette

* Fix CI

* fix linter

* Use uppercase for hex color

* Use eui variable instead

* Changes on charts.json

* Make the color picker accessible

* Fix ci and tests

* Allow keyboard navigation

* Close the popover on mouse click event

* Fix ci

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-16 15:58:18 -04:00
Stacey Gammon 6b8ebbfa18
API docs clean up (#93508) (#93881)
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
# Conflicts:
#	api_docs/actions.json
#	api_docs/advanced_settings.json
#	api_docs/alerting.json
#	api_docs/apm.json
#	api_docs/apm_oss.json
#	api_docs/banners.json
#	api_docs/beats_management.json
#	api_docs/bfetch.json
#	api_docs/canvas.json
#	api_docs/case.json
#	api_docs/charts.json
#	api_docs/cloud.json
#	api_docs/console.json
#	api_docs/core.json
#	api_docs/core_application.json
#	api_docs/core_chrome.json
#	api_docs/core_http.json
#	api_docs/core_saved_objects.json
#	api_docs/dashboard.json
#	api_docs/dashboard_enhanced.json
#	api_docs/dashboard_mode.json
#	api_docs/data.json
#	api_docs/data_autocomplete.json
#	api_docs/data_enhanced.json
#	api_docs/data_field_formats.json
#	api_docs/data_index_patterns.json
#	api_docs/data_query.json
#	api_docs/data_search.json
#	api_docs/data_ui.json
#	api_docs/dev_tools.json
#	api_docs/discover.json
#	api_docs/discover_enhanced.json
#	api_docs/embeddable.json
#	api_docs/embeddable_enhanced.json
#	api_docs/encrypted_saved_objects.json
#	api_docs/enterprise_search.json
#	api_docs/es_ui_shared.json
#	api_docs/event_log.json
#	api_docs/expressions.json
#	api_docs/features.json
#	api_docs/file_upload.json
#	api_docs/fleet.json
#	api_docs/global_search.json
#	api_docs/home.json
#	api_docs/index_lifecycle_management.json
#	api_docs/index_management.json
#	api_docs/index_pattern_field_editor.json
#	api_docs/index_pattern_management.json
#	api_docs/infra.json
#	api_docs/ingest_pipelines.json
#	api_docs/inspector.json
#	api_docs/kibana_legacy.json
#	api_docs/kibana_react.json
#	api_docs/kibana_utils.json
#	api_docs/lens.json
#	api_docs/license_management.json
#	api_docs/licensing.json
#	api_docs/lists.json
#	api_docs/management.json
#	api_docs/maps.json
#	api_docs/maps_legacy.json
#	api_docs/ml.json
#	api_docs/monitoring.json
#	api_docs/navigation.json
#	api_docs/newsfeed.json
#	api_docs/observability.json
#	api_docs/osquery.json
#	api_docs/presentation_util.json
#	api_docs/remote_clusters.json
#	api_docs/reporting.json
#	api_docs/rollup.json
#	api_docs/runtime_fields.json
#	api_docs/saved_objects.json
#	api_docs/saved_objects_management.json
#	api_docs/saved_objects_tagging.json
#	api_docs/saved_objects_tagging_oss.json
#	api_docs/security.json
#	api_docs/security_oss.json
#	api_docs/security_solution.json
#	api_docs/share.json
#	api_docs/snapshot_restore.json
#	api_docs/spaces.json
#	api_docs/spaces_oss.json
#	api_docs/stack_alerts.json
#	api_docs/task_manager.json
#	api_docs/telemetry.json
#	api_docs/telemetry_collection_manager.json
#	api_docs/telemetry_collection_xpack.json
#	api_docs/telemetry_management_section.json
#	api_docs/triggers_actions_ui.json
#	api_docs/ui_actions.json
#	api_docs/ui_actions_enhanced.json
#	api_docs/uptime.json
#	api_docs/url_forwarding.json
#	api_docs/usage_collection.json
#	api_docs/vis_type_timeseries.json
#	api_docs/visualizations.json
2021-03-06 10:05:27 -05:00
Stacey Gammon 2117e1324c
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-03 20:12:24 -05:00