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
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
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
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
Mike Côté
52f41d8750
Create new alerting HTTP APIs that use the new terminology ( #93977 ) ( #95781 )
...
* Move current alert HTTP APIs to legacy folder (#93943 )
* Move current HTTP APIs to legacy folder
* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH
* Fix failing tests and extra files
* Create new rule HTTP APIs (#93980 )
* Move current HTTP APIs to legacy folder
* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH
* Fix failing tests and extra files
* Move current alert HTTP APIs to legacy folder (#93943 )
* Move current HTTP APIs to legacy folder
* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH
* Fix failing tests and extra files
* Add necessary files
* Create rule route
* Get rule API
* Update rule API
* Delete rule route
* Aggregate rules API
* Disable rule API
* Enable rule API
* Find rules API
* Fix Update API
* Get rule alert summary API
* Get rule state API
* Health API
* Rule types API
* Mute all API
* Mute alert API
* Unmute all API
* Unmute alert route
* Update API key API
* corrected tpye by making it much more complicated
* removed unneeded cocde
* Fixes
* Add back health route
* mutedInstanceIds -> mutedAlertIds
* lastRun -> last_run
* alert_type_state -> rule_type_state & alert_instances -> alerts
Co-authored-by: Gidi Meir Morris <github@gidi.io>
* Create docs for new rule HTTP APIs, deprecate old docs (#94745 )
* Create docs for new APIs, deprecate old docs
* Remove connector_type_id
* Update docs
* Add link to legacy APIs from rules API docs
* Remove connector_type_id references
* [DOCS] Add legacy APIs to index.asciidoc
* Fix camel case
Co-authored-by: lcawl <lcawley@elastic.co>
* Make alerting tests use new rules APIs (#95159 )
* Make API integration tests use new HTTP APIs
* Fix end to end tests
* Fix test failures
* Fix more test failures
* Rename some files
* Add tests for legacy APIs (#95333 )
* Initial commit (#95457 )
* Move some new alerting APIs to /internal (#95461 )
* Initial commit
* Update README.md
* Use internal API
* Merge deprecated warning w/ alternative solution
* Update API docs
Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
# Conflicts:
# api_docs/core.json
2021-03-30 10:41:41 -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
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