kibana/api_docs
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
..
actions.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
actions.mdx
advanced_settings.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
advanced_settings.mdx
alerting.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
alerting.mdx Rename alerts plugin to alerting (#92898) (#93827) 2021-03-05 21:38:33 -05:00
apm.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
apm.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
apm_oss.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
apm_oss.mdx [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
banners.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
banners.mdx
bfetch.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
bfetch.mdx Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
canvas.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
canvas.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
cases.json Small clean up with Cases plugin API (#101668) (#101889) 2021-06-10 14:50:31 +00:00
cases.mdx Small clean up with Cases plugin API (#101668) (#101889) 2021-06-10 14:50:31 +00:00
charts.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
charts.mdx
cloud.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
cloud.mdx
console.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
console.mdx
core.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
core.mdx
core_application.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
core_application.mdx
core_chrome.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
core_chrome.mdx
core_http.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
core_http.mdx
core_saved_objects.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
core_saved_objects.mdx
dashboard.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
dashboard.mdx Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
dashboard_enhanced.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
dashboard_enhanced.mdx
dashboard_mode.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
dashboard_mode.mdx
data.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
data.mdx API DOCS Step 3/3 (#92929) (#93530) 2021-03-03 20:12:24 -05:00
data_autocomplete.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
data_autocomplete.mdx
data_enhanced.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
data_enhanced.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
data_field_formats.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
data_field_formats.mdx
data_index_patterns.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
data_index_patterns.mdx
data_query.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
data_query.mdx
data_search.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
data_search.mdx Create new alerting HTTP APIs that use the new terminology (#93977) (#95781) 2021-03-30 10:41:41 -04:00
data_ui.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
data_ui.mdx
data_visualizer.json [7.x] [ML] Move Index Data Visualizer into separate plugin (Part 1) (#100922) (#101665) 2021-06-09 17:50:33 -04:00
data_visualizer.mdx [7.x] [ML] Move Index Data Visualizer into separate plugin (Part 1) (#100922) (#101665) 2021-06-09 17:50:33 -04:00
deprecations.mdx Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
dev_tools.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
dev_tools.mdx
discover.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
discover.mdx
discover_enhanced.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
discover_enhanced.mdx
embeddable.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
embeddable.mdx Track API stats as part of ci (#95733) (#97306) 2021-04-15 16:47:21 -04:00
embeddable_enhanced.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
embeddable_enhanced.mdx
encrypted_saved_objects.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
encrypted_saved_objects.mdx
enterprise_search.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
enterprise_search.mdx
es_ui_shared.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
es_ui_shared.mdx
event_log.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
event_log.mdx Track API stats as part of ci (#95733) (#97306) 2021-04-15 16:47:21 -04:00
expressions.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
expressions.mdx
features.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
features.mdx
file_upload.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
file_upload.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
fleet.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
fleet.mdx [Fleet] Remove fleetServerEnabled feature flag and use fleet system indices (#92422) (#93923) 2021-03-08 13:01:50 -05:00
global_search.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
global_search.mdx
home.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
home.mdx Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
index_lifecycle_management.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
index_lifecycle_management.mdx
index_management.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
index_management.mdx
index_pattern_field_editor.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
index_pattern_field_editor.mdx
index_pattern_management.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
index_pattern_management.mdx
infra.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
infra.mdx
ingest_pipelines.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
ingest_pipelines.mdx
inspector.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
inspector.mdx
kibana_legacy.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
kibana_legacy.mdx
kibana_react.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
kibana_react.mdx
kibana_utils.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
kibana_utils.mdx
lens.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
lens.mdx
license_api_guard.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
license_api_guard.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
license_management.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
license_management.mdx
licensing.json Improve security server types (#101661) (#101767) 2021-06-09 16:14:49 +00:00
licensing.mdx
lists.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
lists.mdx [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
management.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
management.mdx
maps.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
maps.mdx Track API stats as part of ci (#95733) (#97306) 2021-04-15 16:47:21 -04:00
maps_ems.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
maps_ems.mdx update api docs (#95154) (#95428) 2021-03-25 14:11:24 -04:00
metrics_entities.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
metrics_entities.mdx [Security Solutions] (Phase 1) Adds an application cache called metrics entities and integrates it within Security Solutions behind a feature flag (#96446) (#98967) 2021-04-30 16:42:47 -04:00
ml.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
ml.mdx Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
monitoring.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
monitoring.mdx
navigation.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
navigation.mdx
newsfeed.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
newsfeed.mdx
observability.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
observability.mdx Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
osquery.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
osquery.mdx
presentation_util.json Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) (#101087) 2021-06-01 17:24:44 -04:00
presentation_util.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
remote_clusters.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
remote_clusters.mdx
reporting.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
reporting.mdx [Usage Collection] Report the number of SOs per type (#99344) (#99509) 2021-05-06 15:08:20 -04:00
rollup.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
rollup.mdx
rule_registry.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
rule_registry.mdx Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
runtime_fields.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
runtime_fields.mdx
saved_objects.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
saved_objects.mdx
saved_objects_management.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
saved_objects_management.mdx
saved_objects_tagging.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
saved_objects_tagging.mdx
saved_objects_tagging_oss.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
saved_objects_tagging_oss.mdx
screenshot_mode.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
screenshot_mode.mdx Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
security.json Improve security server types (#101661) (#101767) 2021-06-09 16:14:49 +00:00
security.mdx Improve security server types (#101661) (#101767) 2021-06-09 16:14:49 +00:00
security_oss.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
security_oss.mdx
security_solution.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
security_solution.mdx Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
share.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
share.mdx
snapshot_restore.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
snapshot_restore.mdx
spaces.json Improve security server types (#101661) (#101767) 2021-06-09 16:14:49 +00:00
spaces.mdx
spaces_oss.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
spaces_oss.mdx
stack_alerts.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
stack_alerts.mdx
task_manager.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
task_manager.mdx
telemetry.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
telemetry.mdx [API DOCS] Telemetry (#98610) (#98748) 2021-04-29 11:45:21 -04:00
telemetry_collection_manager.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
telemetry_collection_manager.mdx
telemetry_collection_xpack.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
telemetry_collection_xpack.mdx Create new alerting HTTP APIs that use the new terminology (#93977) (#95781) 2021-03-30 10:41:41 -04:00
telemetry_management_section.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
telemetry_management_section.mdx
timelines.json Add support for building a deprecation list with usage (#99154) (#99538) 2021-05-06 17:59:11 -04:00
timelines.mdx Track API stats as part of ci (#95733) (#97306) 2021-04-15 16:47:21 -04:00
triggers_actions_ui.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
triggers_actions_ui.mdx
ui_actions.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
ui_actions.mdx
ui_actions_enhanced.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
ui_actions_enhanced.mdx
uptime.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
uptime.mdx
url_forwarding.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
url_forwarding.mdx
usage_collection.json Improve security plugin return types (#101492) (#101657) 2021-06-08 16:26:37 -04:00
usage_collection.mdx [API DOCS] Usage Collection (#98656) (#99186) 2021-05-04 09:42:47 -04:00
vis_type_timeseries.json Fix a bunch of bugs with APIDocs system (#99589) (#100417) 2021-05-20 16:11:31 -04:00
vis_type_timeseries.mdx Track API stats as part of ci (#95733) (#97306) 2021-04-15 16:47:21 -04:00
visualizations.json [Fleet] Remove beats management plugin (#99789) (#101010) 2021-05-31 13:33:12 -04:00
visualizations.mdx