Commit graph

11 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
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 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
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 2fcf3e49ea
Improve deprecated API list, and update api docs (#106942) (#107441)
* 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
2021-08-02 16:44:47 -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 d2ee3daa6d
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 15:18:24 -04:00
Kibana Machine aa3c54879e
Small clean up with Cases plugin API (#101668) (#101889)
* Clean up public API of cases plugin

1. Don't use export * on index.ts files that define the public API
2. Add comments to the interface show they show up in the API docs
3. Export types that are part of the public API so they show up in the API docs.
4. Fill in information for the up and coming `description` and `owner` items in kibana.json.

* Update returns comments to be more descriptive

* update api docs

* Remove kibana.json attributes, until PR supporting them is merged.

* Change all exports to export type to avoid increase page bundle size

Co-authored-by: Stacey Gammon <gammon@elastic.co>
2021-06-10 14:50:31 +00: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
Alejandro Fernández Haro 47c3e20546
[Usage Collection] Report the number of SOs per type (#99344) (#99509)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	api_docs/core.json
#	api_docs/dashboard.json
#	api_docs/data.json
#	api_docs/data_search.json
#	api_docs/fleet.json
#	api_docs/infra.json
#	api_docs/ml.json
#	api_docs/observability.json
#	api_docs/presentation_util.json
#	api_docs/reporting.json
#	api_docs/visualizations.json
2021-05-06 15:08:20 -04:00
Lukas Olson aa9e554b31
Fix search telemetry to only update SO periodically (#93130) (#94454)
* Fix search telemetry to only update SO periodically

* Handle case when searches completed mid flight

* Fix error in resetting counters

* Update docs

* update docs

* Don't track restored searches

* Update docs

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Anton Dosov <anton.dosov@elastic.co>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Anton Dosov <anton.dosov@elastic.co>
2021-03-11 13:35:23 -05:00