Skip to content
This repository has been archived by the owner on Dec 19, 2023. It is now read-only.

Releases: ScaCap/spring-auto-restdocs

1.0.14

06 Nov 13:21
54ed8fd
Compare
Choose a tag to compare
  • Upgrade to Spring REST Docs 1.2.5 (#254)
  • Handle not null Kotlin properties and Java Optional / nullable Kotlin parameters (#231)

2.0.2

20 Sep 10:11
Compare
Choose a tag to compare

2.0.1

29 Mar 12:22
e64b58b
Compare
Choose a tag to compare
  • Dokka JSON: support for paragraphs, unordered lists, and links (#219)
  • Simplify includes in the section snippet so that it works with the Spring REST Docs AsciiDoctor plugin (#220)

We also added an example project that demonstrates the use of Spring Auto REST Docs with Kotlin (#218).

1.0.13

29 Mar 12:18
b17dafd
Compare
Choose a tag to compare
  • Support for non-null properties in Kotlin (#213)
  • Simplify includes in the section snippet so that it works with the Spring REST Docs AsciiDoctor plugin (#220)

2.0.0

23 Mar 16:22
1415215
Compare
Choose a tag to compare
  • Upgrade to Spring REST Docs 2.0.0 (#212)
  • Support for Kotlin's KDoc (#210)

Java 8 is the new baseline.

The Spring Auto REST Docs line based on Spring REST Docs 1.x moved to 1.0.x branch.

1.0.12

23 Mar 13:42
3801a6c
Compare
Choose a tag to compare
  • Fix interplay of @Deprecated annotation and Lombok (#209)
  • Support for @JsonValue on enums (#206)

1.0.11

10 Jan 20:16
d91f6a7
Compare
Choose a tag to compare
  • translations of snippets (#189, #197)
  • enums in path and request parameters (#191)
  • @see tag support (#188)
  • support for Bean Validation 2.0 (#192)
  • default value support for @RequestParam and @RequestHeader (#172)
  • snippet for @RequestHeader parameters (#166)

1.0.10

03 Nov 11:00
ec057bd
Compare
Choose a tag to compare
  • support for JsonSubTypes (#112)
  • support for static resources (#151)
  • support for Javadoc inheritance (#126)
  • support for @Deprecated (#150)
  • validation-api is now an optional dependency (#124)
  • fixed pipe escaping in tables (#139)
  • improved array type display in tables (#153)
  • update to Spring REST Docs 1.2.2 (#145)
  • bug fixes (#144)

1.0.9

12 Sep 10:27
Compare
Choose a tag to compare
  • resolving default directory paths (#125)
  • removed dependency on hibernate-validator and el-api (#124)
  • customization of existing snippet templates (#123)
  • documenting paging support in request (#121)
  • automatic support for recursive structures (#109)
  • customizable section title via @title Javadoc tag (#123)
  • added support for primitive types (#114)
  • improved Javadoc to Asciidoc formatting, support for bullet list
  • resolving Javadoc JSON files from classpath (#102)

Breaking change

Spring Auto REST Docs specific snippets are now prefixed with auto-. This prefix has to be added to the AsciiDoc files where the snippets are included. List of snippets with auto- prefix:

  • auto-request-fields
  • auto-response-fields
  • auto-method-path
  • auto-authorization
  • auto-description
  • auto-section

This change avoids conflicts with the snippets from Spring REST Docs.

1.0.8

10 Jul 13:20
Compare
Choose a tag to compare
  • Option to fail on undocumented fields (#105)
  • Support for explicitly setting type of request/response body (#103)
  • Support for HttpEntity (#100)
  • Update to Spring REST Docs v1.2.1 (#98)