Skip to content

Releases: spring-projects/spring-restdocs

v4.0.0-M1

21 Jul 06:31
Compare
Choose a tag to compare
v4.0.0-M1 Pre-release
Pre-release

⭐ New Features

  • Raise the minimum supported version of REST Assured to 5.5 #975
  • Add Nullability support #972
  • Publish milestones and release candidates to Maven Central #969
  • Remove deprecated APIs #967
  • Add support for official HAL and HAL-FORMS media type in link extraction #965
  • Remove support for JUnit 4 #958
  • Raise the minimum supported version of AsciidoctorJ to 3.0 #957
  • Raise the minimum supported version of Bean Validation to 3.1 and of Hibernate Validator to 9.0 #956
  • Raise the minimum support version of Spring Framework to 7.0 #955

πŸ“” Documentation

  • Fix broken links to Spring Framework's reference documentation #978
  • Correct "Including Multiple Snippets for an Operation" #971

πŸ”¨ Dependency Upgrades

  • Upgrade to JMustache 1.16 #976
  • Upgrade to Spring Framework 7.0.0-M7 #973

❀️ Contributors

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

@nicos68, @odrotbohm, @snicoll, and @zzoe2346

v3.0.4

16 Jun 06:40
Compare
Choose a tag to compare

🐞 Bug Fixes

  • The default version of Spring Framework is unsupported beyond June 2025 #966
  • Snippet from operation macro not found with asciidoctor-maven-plugin v3.1.0 #950

πŸ“” Documentation

  • Align bootJar example with changes to Asciidoctor's Gradle plugin #962

❀️ Contributors

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

@djarnis73, @izeye, and @zzoe2346

v3.0.3

18 Nov 17:15
Compare
Choose a tag to compare

🐞 Bug Fixes

  • AbstractMethodError when using Asciidoctor extension with AsciidoctorJ 3.0.0 #949

❀️ Contributors

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

@LeeSJ0109

v3.0.2

21 Oct 13:27
Compare
Choose a tag to compare

🐞 Bug Fixes

  • When a request contains multiple cookies, HTTP request snippet has multiple Cookie headers when the spec permits only one #947
  • The default version of Spring Framework is no longer supported #941
  • Documenting path parameters does not work with MockMvcTester's fluent API #939
  • multipart/form-data PATCH request produces http-request snippet with no request body #933

πŸ“” Documentation

  • Omit the version in the Maven Resources plugin example #943
  • Document that the query string should be provided in the URL or by using queryParam when using MockMvc #926
  • Add Revved up by Develocity badge #918

❀️ Contributors

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

@dve, @erichaagdev, @izeye, @mnhock, and @snicoll

v3.0.1

20 Nov 18:20
Compare
Choose a tag to compare

🐞 Bug Fixes

  • UnsupportedOperationException when modifying request and response headers with Framework 6.0.9 and later #906

πŸ“” Documentation

  • Clarify the role of snippetsDir as a task input and output #893

πŸ”¨ Dependency Upgrades

  • Upgrade to Spring Framework 6.0.14 #904

❀️ Contributors

We'd like to thank all the contributors who worked on this release!

v2.0.8.RELEASE

20 Nov 18:00
Compare
Choose a tag to compare

πŸ“” Documentation

  • Clarify the role of snippetsDir as a task input and output #892

❀️ Contributors

We'd like to thank all the contributors who worked on this release!

v3.0.0

21 Nov 12:13
Compare
Choose a tag to compare

πŸ“” Documentation

  • Update reference documentation to reflect Bean Validation 3.0 upgrade #869
  • Re-order reference documentation to prefer JUnit 5 #864

πŸ”¨ Dependency Upgrades

  • Upgrade to AsciidoctorJ 2.5.7 #872
  • Upgrade to Jackson 2.14.0 #874
  • Upgrade to Jakarta Servlet 6.0.0 #867
  • Upgrade to REST Assured 5.2.1 #876
  • Upgrade to Spring Framework 6.0.0 #866

v2.0.7.RELEASE

21 Nov 11:07
Compare
Choose a tag to compare

🐞 Bug Fixes

  • Problem documenting response with custom status code with WebTestClient #847
  • modifyUris may corrupt the request or response body if it contains a URI without a port and a colon later in the content #790

πŸ“” Documentation

  • Address warnings in WebTestClient sample #830
  • Use HTTPS for REST Assured links #819

❀️ Contributors

We'd like to thank all the contributors who worked on this release!

v3.0.0-RC1

17 Oct 09:49
Compare
Choose a tag to compare
v3.0.0-RC1 Pre-release
Pre-release

⭐ New Features

  • Use spring-web's HttpStatusCode to model a response's status #848
  • Remove support for preprocessing a request to modify its parameters #846
  • Provide separate snippets for documenting query parameters and form parameters #832

πŸ“” Documentation

  • Update reference documentation to link to Spring Framework 6's reference documentation #853
  • Remove samples in favor of those now in spring-projects/spring-restdocs-samples #852

πŸ”¨ Dependency Upgrades

  • Upgrade to Jackson 2.13.4.20221013 #862
  • Upgrade to JUnit 4.13.2 #863
  • Upgrade to REST Assured 5.2.0 #855
  • Upgrade to Spring Framework 6.0.0-RC1 #854

❀️ Contributors

We'd like to thank all the contributors who worked on this release!

v3.0.0-M4

18 Jul 18:55
Compare
Choose a tag to compare
v3.0.0-M4 Pre-release
Pre-release

⭐ New Features

  • Provide a bom that manages the version of all of Spring REST Docs' modules #831
  • Remove redundant throws declarations #829
  • Specify the language in body snippets based on the request or response's content type #797
  • Add support for documenting request and response cookies #592

πŸ“” Documentation

  • Section heading for Working With Asciidoctor is missing from the reference documentation #833
  • Update documentation examples to use new modifyHeaders preprocessor #827
  • Use HTTPS for REST Assured links #824

πŸ”¨ Dependency Upgrades

  • Upgrade to AsciidoctorJ 2.5.4 #835
  • Upgrade to JMustache 1.15 #834
  • Upgrade to REST Assured 5.1.1 #836
  • Upgrade to Spring Framework 6.0.0-M5 #822

❀️ Contributors

We'd like to thank all the contributors who worked on this release!