Skip to content

Commit

Permalink
[Reporting/Docs] Add CSV Download breaking changes to release notes. (e…
Browse files Browse the repository at this point in the history
…lastic#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 <lcawley@elastic.co>
  • Loading branch information
tsullivan and lcawl authored Sep 9, 2024
1 parent 2c5c8ad commit 10292a4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 10292a4

Please sign in to comment.