Releases · spring-projects/spring-restdocs

🐞 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

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 @BeforeEach rather than @Before #663
Mention spring-restdocs-webtestclient as an alternative dependency in getting started documentation #654

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

🪲 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