From 10292a427ab2cec14367f970d672cdd95a64c2bc Mon Sep 17 00:00:00 2001 From: Tim Sullivan Date: Mon, 9 Sep 2024 09:20:18 -0700 Subject: [PATCH] [Reporting/Docs] Add CSV Download breaking changes to release notes. (#192310) This PR retrospectively adds breaking change items to the release notes: * 8.10: path change for Download CSV from saved search panel. * 8.14: requirement to add a yml setting to enable the deprecated Download CSV functionality, rather than generating a CSV report --------- Co-authored-by: Lisa Cawley --- docs/CHANGELOG.asciidoc | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc index ee7c1a29e1177..d12d5a91f8273 100644 --- a/docs/CHANGELOG.asciidoc +++ b/docs/CHANGELOG.asciidoc @@ -657,6 +657,18 @@ The visualization type, region map, comes out of technical preview and is genera UI improvements for managed tags. For more information, refer to ({kibana-pull}177089[#177089]). ==== +[discrete] +[[breaking-178159]] +.Downloading a CSV file from a saved search panel in a dashboard has become deprecated in favor of generating a CSV report. +[%collapsible] +==== +*Details* + +The mechanism of exporting CSV data from a saved search panel in a dashboard has been changed to generate a CSV report, rather than allowing the CSV data to be downloaded +without creating a report. To preserve the original behavior, it is necessary to update `kibana.yml` with the setting of `xpack.reporting.csv.enablePanelActionDownload: +true`. The scope of this breaking change is limited to downloading CSV files from saved search panels only; downloading CSV files from other types of dashboard panels is +unchanged. For more information, refer to {kibana-pull}178159[#178159]. +==== + [float] [[features-8.14.0]] === Features @@ -2322,6 +2334,16 @@ For the full list, refer to {kib-issue}146945[#146945]. The function `addProcessorDefinition` is removed from the Console plugin start contract (server side). For more information, refer to ({kibana-pull}159041[#159041]). ==== +[discrete] +[[breaking-162288]] +.The Download CSV endpoint has changed. +[%collapsible] +==== +*Details* + +The API endpoint for downloading a CSV file from a saved search in the Dashboard application has changed to reflect the fact that this is an internal API. The previous API path of +`/api/reporting/v1/generate/immediate/csv_searchsource` has been changed to `/internal/reporting/generate/immediate/csv_searchsource`. For more information, refer to {kibana-pull}162288[#162288]. +==== + [float] [[deprecations-8.10.0]] === Deprecations