0.20.1

Description

This release addresses Gradle plugin compatibility issues and updates the Java compatibility level to align with Spring Boot requirements.

Please note that 0.20.x line may still contain minor compatibility issues, especially when used with Spring Boot 4, and some additional adjustments may be required on the consumer side.

If you encounter such issues, please open a GitHub issue so we can track and address them.

Changes

• Fixed Gradle plugin compatibility issues (#293)

• Updated Java compatibility to match Spring Boot minimum requirements (#294)

Contributors

• Reported by: @fstaudt and @antoinelochet

• Contributors: @antoinelochet and @wodrobina

0.20.0

restdocs-api-spec 0.20.0

• Add compatibility with Spring Boot 4
• Fix ClassCastException caused by ReadOnlyHttpHeaders when running with Spring Boot 4 (#289)
• Remove REST Assured support due to changes in Spring REST Docs
• Update dependencies and build configuration
• Update documentation and compatibility matrix

Thanks to:
@antoinelochet, @MarcelKonrad and @DamianFekete

Contributors

antoinelochet
MarcelKonrad

Maintenance release

This release is just testing the new release process.

0.19.4

• Restassured module now should be able to reference classes from the restdocs-api-spec module
• Updated code samples

Thanks to:
@kyY00n and @markruler

Keep supporting Spring Boot 2.7.x

Thanks to @Kieun for supporting Spring Boot 2.7.x

Keep supporting Spring Boot 2.7.x

Thanks to @Kieun for supporting Spring Boot 2.7.x

FIX: Null values in schema ref reuse - openapi3 task

Error fix

Thanks to @xeromank for fixing #251

0.19.1

Thanks to @philipowen, it is now possible to use beneathPath() for defining paths in a shorter way.

Example usage:

responseFields(
    beneathPath("_links").withSubsectionId("beneath-links"),
    fieldWithPath("self").description("self link"),
    fieldWithPath("self.href").description("self link href"),
    subsectionWithPath("multiple").ignored(),
)

JSON Schema: Support schema ref reuse

Thanks to @xeromank for suggesting to solve #170 with #246 :

• It is now possible to specify a schema name in the attributes of a descriptor, see #246 (comment) for an example

Error fix

Thanks to @Kieun for fixing #242 with #247 :

• The pattern constraint should now correctly render in JSON schema

JSON Schema: Render optional field descriptors as nullable

Thanks again to @xeromank for providing #245 !