IQSS / dataverse / #29631

25%

Build Type

push

github

Committed by web-flow

Commit Message

Fix nested message object in API responses (#12097)

* Fix nested message object in API responses #12096

* Fix integration tests and add API changelog entry

* Fix RST reference syntax in changelog

* Add feature flag for legacy API message format

Adds API_MESSAGE_FIELD_LEGACY feature flag that allows admins to revert
to the old (buggy) nested message format if they have integrations that
depend on it. The fix is now the default behavior.

Set dataverse.feature.api-message-field-legacy=true to use the legacy format.
This flag will be removed in a future version.

* refactor(api): remove redundant `this.` qualifier in `BatchImport.java`

Replaced `this.error(...)` with `error(...)` for consistency with recent style updates in error handling.

* refactor(api): move constants from `AbstractApiBean` to `ApiConstants` and remove duplicates

Consolidated shared API constants—such as header names, status codes, and response messages—from `AbstractApiBean` into the dedicated `ApiConstants` class. Replaced direct usages with references to `ApiConstants` for improved maintainability and consistency.

* refactor(api): consolidate `ok()` response methods and simplify return structure

Unified the multiple `ok()` overloads into a single primary method accepting `JsonValue`s for `data and` `message` fields, plus `totalCount` Long field, reducing duplication and ensuring consistent JSON response formatting across API endpoints.

* refactor(api): add legacy message field support for ok(String) response creation

Use feature flag `API_MESSAGE_FIELD_LEGACY` to preserve the old `{data:{message:"..."}}` response format if needed in an installation.

* refactor(api): simplify `ok(String, JsonObjectBuilder)` response creation

Consolidated `ok()` logic by delegating to the unified `ok(JsonValue, JsonValue, Long)` method, removing redundant response construction.

Keeping the support to create the wrapped legacy {message:{message:value}} style.

* refactor(settings): migr... (continued)

Coverage Stats

25 of 51 new or added lines in 4 files covered. (49.02%)

1 existing line in 1 file now uncovered.

23825 of 95415 relevant lines covered (24.97%)

0.25 hits per line