github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs
History
Stacey Gammon b2903e9f8f
Small clean up with Cases plugin API (#101668) 
* 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
2021-06-10 08:43:07 -04:00
..
actions.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
actions.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
advanced_settings.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
advanced_settings.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
alerting.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
alerting.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
apm.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
apm.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
apm_oss.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
apm_oss.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
banners.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
banners.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
bfetch.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
bfetch.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
canvas.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
canvas.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
cases.json Small clean up with Cases plugin API (#101668) 2021-06-10 08:43:07 -04:00
cases.mdx Small clean up with Cases plugin API (#101668) 2021-06-10 08:43:07 -04:00
charts.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
charts.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
cloud.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
cloud.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
console.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
console.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
core.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
core.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
core_application.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
core_application.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
core_chrome.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
core_chrome.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
core_http.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
core_http.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
core_saved_objects.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
core_saved_objects.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
dashboard.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
dashboard.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
dashboard_enhanced.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
dashboard_enhanced.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
dashboard_mode.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
dashboard_mode.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data.json Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_autocomplete.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
data_autocomplete.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_enhanced.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
data_enhanced.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_field_formats.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
data_field_formats.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_index_patterns.json Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_index_patterns.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_query.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
data_query.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_search.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
data_search.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_ui.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
data_ui.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_visualizer.json Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
data_visualizer.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
deprecations.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
dev_tools.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
dev_tools.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
discover.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
discover.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
discover_enhanced.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
discover_enhanced.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
embeddable.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
embeddable.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
embeddable_enhanced.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
embeddable_enhanced.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
encrypted_saved_objects.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
encrypted_saved_objects.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
enterprise_search.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
enterprise_search.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
es_ui_shared.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
es_ui_shared.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
event_log.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
event_log.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
expressions.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
expressions.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
features.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
features.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
file_upload.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
file_upload.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
fleet.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
fleet.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
global_search.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
global_search.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
home.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
home.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
index_lifecycle_management.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
index_lifecycle_management.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
index_management.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
index_management.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
index_pattern_field_editor.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
index_pattern_field_editor.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
index_pattern_management.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
index_pattern_management.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
infra.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
infra.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
ingest_pipelines.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
ingest_pipelines.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
inspector.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
inspector.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
kibana_legacy.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
kibana_legacy.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
kibana_react.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
kibana_react.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
kibana_utils.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
kibana_utils.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
lens.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
lens.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
license_api_guard.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
license_api_guard.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
license_management.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
license_management.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
licensing.json Improve security server types (#101661) 2021-06-09 14:01:48 +02:00
licensing.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
lists.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
lists.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
management.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
management.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
maps.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
maps.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
maps_ems.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
maps_ems.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
metrics_entities.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
metrics_entities.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
ml.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
ml.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
monitoring.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
monitoring.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
navigation.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
navigation.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
newsfeed.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
newsfeed.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
observability.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
observability.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
osquery.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
osquery.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
presentation_util.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
presentation_util.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
remote_clusters.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
remote_clusters.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
reporting.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
reporting.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
rollup.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
rollup.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
rule_registry.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
rule_registry.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
runtime_fields.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
runtime_fields.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
saved_objects.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
saved_objects.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
saved_objects_management.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
saved_objects_management.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
saved_objects_tagging.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
saved_objects_tagging.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
saved_objects_tagging_oss.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
saved_objects_tagging_oss.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
screenshot_mode.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
screenshot_mode.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
security.json Improve security server types (#101661) 2021-06-09 14:01:48 +02:00
security.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
security_oss.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
security_oss.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
security_solution.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
security_solution.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
share.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
share.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
snapshot_restore.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
snapshot_restore.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
spaces.json Improve security server types (#101661) 2021-06-09 14:01:48 +02:00
spaces.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
spaces_oss.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
spaces_oss.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
stack_alerts.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
stack_alerts.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
task_manager.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
task_manager.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
telemetry.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
telemetry.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
telemetry_collection_manager.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
telemetry_collection_manager.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
telemetry_collection_xpack.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
telemetry_collection_xpack.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
telemetry_management_section.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
telemetry_management_section.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
timelines.json Add support for building a deprecation list with usage (#99154) 2021-05-06 15:29:47 -04:00
timelines.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
triggers_actions_ui.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
triggers_actions_ui.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
ui_actions.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
ui_actions.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
ui_actions_enhanced.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
ui_actions_enhanced.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
uptime.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
uptime.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
url_forwarding.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
url_forwarding.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
usage_collection.json Improve security plugin return types (#101492) 2021-06-08 14:05:14 -04:00
usage_collection.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
vis_type_timeseries.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
vis_type_timeseries.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00
visualizations.json update api docs (#101528) 2021-06-07 17:55:35 -04:00
visualizations.mdx Support owner and description attributes inside the Manifest file, use in API docs (#101786) 2021-06-09 16:18:21 -04:00