v3.1.0

Release 3.1.0

✨ New Features

• Add support for @jakarta.persistence.EmbeddedId mapping to JSON:API id
• Use Jackson serializer for JSON:API id objects
• Support deserialization of added Jackson Modules in mapper customization

🐛 Bug Fixes

• Remove setting field explicitly to null during deserialization

🔨 Dependency Upgrades

• Spring Boot 4.0.3
• Spring HATEOAS 3.0.2
• Gradle 9.3.1
• Spotless 8.3.0
• com.vanniktech.maven.publish 0.36.0
• io.freefair.lombok 9.2.0
• dev.harrel:json-schema 1.9.1
• dev.harrel.json.providers:jackson3 1.9.1
• actions/upload-artifact v7

🛠️ Code Quality & Build

• Refactor build for Spotless 8.3.0
• Add automated version bump logic based on conventional commits
• Improve prepareRelease task with proper Pattern/Matcher imports
• Remove unnecessary asserts in tests
• Apply spotless formatting consistently

📚 Documentation

• Add Gradle (Kotlin) integration examples
• Update references to Spring HATEOAS 3.0.2
• Reorganize Gradle documentation tasks

---

Note: This is a minor release adding support for JPA @EmbeddedId annotations, improved Jackson serialization handling, and dependency updates. The new features are backwards compatible with 3.0.x versions.

v3.0.1

📚 Documentation

• Improve language and grammar across all docs
• Enhance Javadoc with usage examples and better descriptions

🔨 Dependency Upgrades

• Spring Boot 4.0.1
• Spring Framework 7.0.2
• Spring HATEOAS 3.0.1

🔧 Technical Details

• All types are non-null by default with @NullMarked at package level
• Nullable types explicitly marked with @Nullable for better static analysis
• Improved code maintainability with automated formatting and commit linting
• Enhanced developer workflow with automated release preparation
• No breaking changes - drop-in replacement for 3.0.0

🛠️ Code Quality & Build

• Add Spotless plugin for automatic code formatting (8.1.0)
• Setup Git hooks for pre-commit formatting and commit-msg validation (conventional commits)
• Apply Google Java Format to entire codebase
• Fix multiple SonarQube issues (null-safety, complexity, code smells)
• Add prepareRelease and showVersions Gradle tasks for automated versioning
• Automate release/snapshot documentation deployments to GitHub Pages

---

Note: This is a maintenance release focusing on code quality, developer experience improvements, null-safety, and documentation enhancements. No public API changes.

v3.0.0

Features

• Remove all deprecations declared until 2.2.0
• Update all examples to Spring Boot 4, Spring HATEOAS 3, and Jackson 3

Dependency Bumps

• Bump dependencies based on Spring Boot 4.0.0 (including Jackson 3)
• Bump dependencies based on Spring HATEOAS 3.0.0

Documentation

• Update documentation and provide migration guide to 3.0.0

Note
Version 3.0.0 removes all deprecated APIs from version 2.x.x. Specifically, withJsonApiVersionRendered() and withObjectMapperCustomizer() have been removed and replaced with withJsonApiObject() and withMapperCustomizer() respectively. See the Migration Guide for details.

v2.2.0

Features

• The model builder now provides explicit configuration for null or empty collection resource linkage, see https://toedter.github.io/spring-hateoas-jsonapi/2.2.0/reference/#explicit-configuration-of-empty-relationships
• Provide configuration for placing item resource links at resource level rather that document level, see https://toedter.github.io/spring-hateoas-jsonapi/2.2.0/reference/#link-placement-configuration-example and https://toedter.github.io/spring-hateoas-jsonapi/2.2.0/reference/#link-placement

Dependency Bumps

• Bump dependencies based on Spring Boot 3.5.8
• Bump dependencies based on Spring HATEOAS 2.5.1

v2.1.4

Dependency Bumps

• Bump dependencies based on Spring Boot 3.5.0
• Bump dependencies based on Spring HATEOAS 2.5.0

v2.1.3

Bug Fixes

• Now jsonapi object allowed in POST/PATCH request bodies (see #124)

Dependency Bumps

• Bump dependencies based on Spring Boot 3.4.3

v2.1.2

Dependency Bumps

• Bump dependency to Spring HATEOAS 2.4.1
• Bump dependencies based on Spring Boot 3.4.2

v2.1.1

Dependency Bumps

• Bump dependency to Spring HATEOAS 2.4.0
• Bump dependencies based on Spring Boot 3.4.0

v2.1.0

Features

• add configuration option to not URL encode specific link relations, see https://toedter.github.io/spring-hateoas-jsonapi/2.1.0/reference/#configuration

Documentation

• add new configuration documentation

Dependency Bumps

• Bump dependency to Spring HATEOAS 2.3.1
• Bump dependencies based on Spring Boot 3.3.2

Contributors
Thank you to all the contributors who worked on this release:
@jimirocks

v2.0.8

Documentation

• improve JSON:API error documentation, see https://toedter.github.io/spring-hateoas-jsonapi/2.0.8/reference/#more-generic-error-handling

Example

• improve JSDON:API error handling

Dependency Bumps

• Bump dependency to Spring HATEOAS 2.3.0
• Bump dependencies based on Spring Boot 3.3.1