Releases: spring-projects/spring-restdocs
Releases · spring-projects/spring-restdocs
v3.0.0-M1
⭐ New Features
- Remove deprecated code #781
- Drop support for REST Assured until it supports Jakarta EE 9 #761
- Raise the minimum supported version of REST Assured to 4.4 #752
- Raise the minimum supported version of AsciidoctorJ to 2.5 #751
- Raise the minimum supported version of Bean Validation to 3.0 #750
- Raise the minimum supported version of Java to 17 #749
- Raise the minimum supported version of Spring Framework to 6.0 #748
📔 Documentation
- Improve documentation styling and provide a dynamic table of contents #773
- For consistency with other projects, publish reference documentation to a directory named htmlsingle rather than html5 #681
🔨 Dependency Upgrades
- Upgrade samples to Spring Data REST 2022.0.0-M1 #777
- Upgrade samples to Spring HATEOAS 2.0.0-M1 #778
- Upgrade to Jackson 2.13.1 #774
- Upgrade to Spring Framework 6.0.0-M2 #775
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
v2.0.6.RELEASE
🐞 Bug Fixes
- HTTPie snippet uses --form for multipart requests when --multipart is a clearer alternative #771
- RestDocumentationRequestBuilders' methods for multipart file uploads are not aligned with MockMvc's MockMvcRequestBuilders #770
- HTTP request snippet for a PUT request with a query string duplicates the string's parameters in a form URL encoded body #763
- spring-restdocs-restassured has a transitive dependency on javax.xml.bind:jaxb-api rather than jakarta.xml.bind:jakarta.xml.bind-api #758
- spring-restdocs-restassured has a transitive dependency on commons-logging:commons-logging #757
- Duplicate parts in generated snippets for multipart requests documented with MockMvc #746
- Unhelpful IndexOutOfBoundException when an empty array subsection is extracted #732
- Pretty printing truncates non-json responses that happen to begin with valid json #730
- Diagnostics are poor when a wildcard is used with beneathPath and the identified field doesn't exist everywhere in the payload #715
- Jackson parsing fails when using an UTF-8 character for link masking #705
- Request parts not found when using Spring Framework 5.3 without nio-multipart-parser #703
- Warnings logged by the operation block macro lack context #699
📔 Documentation
- Document how to use REST Docs with the new org.asciidoctor.jvm.convert Gradle plugin #744
- Update Gradle examples to use configurations for dependencies that are Gradle 7-compatible #743
- Document how to build samples in CONTRIBUTING.md #725
- Upgrade the samples to Spring Boot 2.4 #723
- Update Docs to Show Use of Consumer in WebTestClient.Builder #713
- "included in the package" cross-reference is broken #700
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
v2.0.5.RELEASE
🐞 Bug Fixes
- Operation macro corrupts snippets with UTF-8 characters #696
- Default operation content encoding is unstable as it relies on the underlying OS's default #689
- Request parameters ignored for HTTP DELETE #683
- Changes made by ParametersModifyingOperationPreprocessor are not reflected in a GET request's query string #682
- ignoreUndocumentedParamters is lost when using and() on PathParametersSnippet and RequestParametersSnippet #676
- {method-name} with uppercase word generates dashes #658
- NPE in HttpResponseSnippet when documenting a response with a custom HTTP status #653
- Section title out of sequence with operation macro when using leveloffset #649
- Valueless query parameters are duplicated in request snippets #647
- Snippet templates that contain UTF-8 characters are corrupted on platforms with a non-UTF-8 default encoding #585
📔 Documentation
- Upgrade Slate sample to Slate 2.7.1 #693
- Fix minor typo in Documenting your API #690
- Fix typo in description of how to obtain an instance of RestDocumentationResultHandler #679
- Some cross-references in the samples do not work #674
- Data REST sample cannot resolve spring-restdocs-asciidoctor snapshots #673
- REST Assured JUnit 5 example should use
@BeforeEachrather than@Before#663 - Mention spring-restdocs-webtestclient as an alternative dependency in getting started documentation #654
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
v2.0.4.RELEASE
⭐ New Features
- Allow custom snippets directory via JUnit 5 #633
🪲 Bug Fixes
- Responses with custom HTTP statuses cannot be documented #639
- Section title out of sequence warnings may be generated when using operation macro #628
- Operation block macro fails with 2.2 Asciidoctor Gradle Plugins does to missing gradle-projectdir attribute #624
- Diagnostics are poor when misconfiguration leads to operation-specific configuration being null #583
- spring-restdocs-asciidoctor is incompatible with AsciidoctorJ 1.6 and later #581
- Regression in beneathPath in 2.0.3 #573
- Diagnostics are poor when an attempt is made to extract a non-existent subsection of a payload #568
- Optionality of ancestor fields is not considered when resolving the type of a field #567
📔 Documentation
- Invalid part errors when rendering samples' getting-started-guide.adoc #641
- Drop the Grails 3.x sample as it is incompatible with Spring Framework 5 #637
- Fix IDs of sections in examples #629
- Upgrade Asciidoctor Maven Plugin so that syntax highlighting can be enabled using an attribute #620
- Remove remnants of a merge conflict from README #614
- Fix links to ignored() in RequestDocumentation's javadoc #595
- NoSuchBeanDefinitionException when configuring test that uses WebTestClient as described in the user guide #582
- Fix typo in REST Assured HTTP headers example #579
- Improve style and consistency of the documentation #575
🔨 Dependency Upgrades
❤️ Contributors
We'd like to thank all the contributors who worked on this release!