Content HAL API Add-on Release Notes

Note: Bloomreach provides Enterprise support for this feature for Bloomreach Experience customers. The release schedule for this add-on may differ from the core product release cycle.

Compatibility

Plugin Version	Bloomreach Content Version
7.x	17.x
6.x	16.x
5.x	15.x
4.x	14.x
3.x	13.x
2.x	12.x, 11.x

Releases

7.0.0

Released: 31 Aug 2026

• SERVPLUG-156 Updated for compatibility with brXM 17 and Java 21.

6.1.0

Released: 14 Jan 2026

• SERVPLUG-143 Mitigated an XPath injection vulnerability in HAL API input handling.

6.0.1

Released: 14 May 2025

• SERVPLUG-140 The API now returns an error code when a serialization exception occurs.

6.0.0

Released: 09 July 2024

• SERVPLUG-134 Updated for compatibility with brXM 16 and Java 17. This release also migrates from the javax to the jakarta namespace, in line with brXM 16 requirements.

5.1.0

Released: 31 May 2023

• SERVPLUG-110 Improved error handling.
  When an exception occurs in HAL resources, the API now returns a 500 Internal Server Error with a detailed error message and logs the backend stack trace, instead of returning a 204 No Content.

• SERVPLUG-122 Prevented NullPointerExceptions when no converters are found for a node.
  Internal Spring bean configuration has been updated: the halContentHalResourceConverters bean has been removed. The argument beans customContentHalResourceConverters and defaultContentHalResourceConverters are now used independently. A new boolean bean useDefaultConverters (default: true) has been added to allow disabling default converters if needed.

5.0.0

Released: 12 September 2022

• SERVPLUG-127
  Updated for compatibility with brXM 15 and Java 11.

4.2.0

Released: 31 May 2023

• SERVPLUG-110 Improved error handling.
  On exception in HAL resources, the API now returns a 500 Internal Server Error with a descriptive error message and backend stack trace logging, instead of a 204 No Content.

4.1.0

Released: 17 February 2021

• SERVPLUG-107
  Enhanced processing for /api/documents/{UUID} endpoints. The API now validates the parameter as a UUID. If the value is not a valid UUID, it is treated as a relative path.

4.0.0

Released: 11 March 2020

• SERVPLUG-100
  Updated for compatibility with brXM 14.

3.x

For release notes for versions 3.x, see the release notes for brXM 13.

2.x

For release notes for versions 2.x, see the release notes for brXM 12.