diff --git a/README.md b/README.md index 1ffe29d7..f318ac58 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,14 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail ## Documentation -[Current 2.0.7 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.7/docs/index.html) reference guide (based on Spring REST Docs 2.x). +[Current 2.0.8 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.8/docs/index.html) reference guide (based on Spring REST Docs 2.x). [Current 1.0.15 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.15/docs/index.html) reference guide (based on Spring REST Docs 1.x). -Latest master [2.0.7](https://scacap.github.io/spring-auto-restdocs) reference guide. +Latest master [2.0.8](https://scacap.github.io/spring-auto-restdocs) reference guide. Older releases: -[2.0.6](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.6/docs/index.html), +[2.0.7](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.7/docs/index.html), [1.0.14](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.14/docs/index.html) ## Main features diff --git a/docs/index.html b/docs/index.html index 7c799287..f52f8b76 100644 --- a/docs/index.html +++ b/docs/index.html @@ -437,7 +437,7 @@

Spring Auto REST Docs

Scalable Capital
-version 2.0.7 +version 2.0.8
Table of Contents
@@ -653,7 +653,7 @@

Usage
<dependency>
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-core</artifactId>
-    <version>2.0.7</version>
+    <version>2.0.8</version>
     <scope>test</scope>
 </dependency>
 
@@ -690,7 +690,7 @@ 

Usage <docletArtifact> <groupId>capital.scalable</groupId> <artifactId>spring-auto-restdocs-json-doclet</artifactId> (3) - <version>2.0.7</version> + <version>2.0.8</version> </docletArtifact> <destDir>generated-javadoc-json</destDir> (2) <reportOutputDirectory>${project.build.directory}</reportOutputDirectory> (2) @@ -735,8 +735,8 @@

Usage } dependencies { - testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.7' - jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.7' (3) + testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.8' + jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.8' (3) } task jsonDoclet(type: Javadoc, dependsOn: compileJava) { @@ -2266,6 +2266,9 @@

Preprocessorsbinary replacement: replaces content with <binary> for common mime types

  • +

    multipart binary replacement: replaces content with <binary> for multipart/form-data requests

    +
  • +
  • limit JSON array length: limits all JSON arrays to 3 items

  • @@ -2508,8 +2511,8 @@

    diff --git a/pom.xml b/pom.xml index 6f10025c..90ae461f 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 pom Spring Auto REST Docs Parent POM diff --git a/samples/java-webflux/generated-docs/index.html b/samples/java-webflux/generated-docs/index.html index a817d405..4601b378 100644 --- a/samples/java-webflux/generated-docs/index.html +++ b/samples/java-webflux/generated-docs/index.html @@ -541,7 +541,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -753,7 +753,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -1028,7 +1028,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -1166,7 +1166,7 @@

    < diff --git a/samples/java-webflux/pom.xml b/samples/java-webflux/pom.xml index 1f1d698f..8b9f3bda 100644 --- a/samples/java-webflux/pom.xml +++ b/samples/java-webflux/pom.xml @@ -13,7 +13,7 @@ capital.scalable spring-auto-restdocs-java-webflux-example - 2.0.8-SNAPSHOT + 2.0.8 Spring Auto REST Docs Java WebFlux Example Project Example project for Spring Auto REST Docs @@ -35,7 +35,7 @@ UTF-8 capital.scalable.restdocs.example.Application 2.0.4.RELEASE - 2.0.8-SNAPSHOT + 2.0.8 diff --git a/samples/java-webmvc/build.gradle b/samples/java-webmvc/build.gradle index d5e52fca..0e754360 100644 --- a/samples/java-webmvc/build.gradle +++ b/samples/java-webmvc/build.gradle @@ -1,6 +1,6 @@ buildscript { ext { - springAutoRestDocsVersion = "2.0.8-SNAPSHOT" + springAutoRestDocsVersion = "2.0.8" springRestDocsVersion = "2.0.4.RELEASE" springBootVersion = "2.1.8.RELEASE" } @@ -20,7 +20,7 @@ apply plugin: "io.spring.dependency-management" apply plugin: "org.asciidoctor.convert" group = "capital.scalable" -version = "2.0.8-SNAPSHOT" +version = "2.0.8" description = """Spring Auto REST Docs Java Web MVC Example Project""" diff --git a/samples/java-webmvc/generated-docs/index.html b/samples/java-webmvc/generated-docs/index.html index a6c6361b..119fd3e8 100644 --- a/samples/java-webmvc/generated-docs/index.html +++ b/samples/java-webmvc/generated-docs/index.html @@ -721,7 +721,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -941,7 +941,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -1195,8 +1195,8 @@

    $ curl 'http://localhost:8080/items' -i -X POST \
    -    -H 'Authorization: Bearer f63d67e7-d3a9-44fe-9efa-1dd4bd7b1d35' \
         -H 'Content-Type: application/json' \
    +    -H 'Authorization: Bearer fdd5ad33-4481-44d1-83d1-4fa1b23753e6' \
         -d '{"description":"Hot News"}'
    @@ -1337,7 +1337,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -1458,8 +1458,8 @@

    $ curl 'http://localhost:8080/items/1' -i -X PUT \
    -    -H 'Authorization: Bearer f63d67e7-d3a9-44fe-9efa-1dd4bd7b1d35' \
         -H 'Content-Type: application/json' \
    +    -H 'Authorization: Bearer fdd5ad33-4481-44d1-83d1-4fa1b23753e6' \
         -d '{"description":"Hot News"}'
    @@ -1503,7 +1503,7 @@

    -

    An example of using path variables.

    +

    An example of using path variables. parameters documentation</a>.

    @@ -1605,7 +1605,7 @@

    -

    An example of using parameter validation.

    +

    An example of using parameter validation. documentation</a>.

    See constraints documentation.

    @@ -1693,7 +1693,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -1946,7 +1946,7 @@

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See
    Jackson type documentation.

    @@ -2119,19 +2119,16 @@

    < "unsorted" : true, "empty" : true }, - "offset" : 0, "pageSize" : 20, "pageNumber" : 0, - "paged" : true, - "unpaged" : false + "offset" : 0, + "unpaged" : false, + "paged" : true }, "total" : 1, "totalPages" : 1, "totalElements" : 1, "last" : true, - "size" : 20, - "number" : 0, - "numberOfElements" : 1, "first" : true, "sort" : { "orders" : [ ], @@ -2139,6 +2136,9 @@

    < "unsorted" : true, "empty" : true }, + "number" : 0, + "numberOfElements" : 1, + "size" : 20, "empty" : false }

    @@ -2337,30 +2337,9 @@

    <

    2.9.4. Request fields

    - ------ - - - - - - - - - - - - - - - - -
    PathTypeOptionalDescription

    command

    String

    false

    Command to execute.

    +
    +

    No request body.

    +

    2.9.5. Response fields

    @@ -2991,7 +2970,7 @@

    <

    Object

    true

    Metadata.

    -

    An example of JsonSubType support.
    +

    An example of JsonSubType support. Jackson type documentation</a>
    See Jackson type documentation.

    @@ -3324,7 +3303,7 @@

    diff --git a/samples/java-webmvc/pom.xml b/samples/java-webmvc/pom.xml index 120c08ac..c379ca7e 100644 --- a/samples/java-webmvc/pom.xml +++ b/samples/java-webmvc/pom.xml @@ -13,7 +13,7 @@ capital.scalable spring-auto-restdocs-java-webmvc-example - 2.0.8-SNAPSHOT + 2.0.8 Spring Auto REST Docs Java Web MVC Example Project Example project for Spring Auto REST Docs @@ -35,7 +35,7 @@ UTF-8 capital.scalable.restdocs.example.Application 2.0.4.RELEASE - 2.0.8-SNAPSHOT + 2.0.8 diff --git a/samples/kotlin-webmvc/build.gradle b/samples/kotlin-webmvc/build.gradle index d386847a..64107a68 100644 --- a/samples/kotlin-webmvc/build.gradle +++ b/samples/kotlin-webmvc/build.gradle @@ -1,7 +1,7 @@ buildscript { ext { kotlinVersion = "1.3.41" - springAutoRestDocsVersion = "2.0.8-SNAPSHOT" + springAutoRestDocsVersion = "2.0.8" springRestDocsVersion = "2.0.4.RELEASE" springBootVersion = "2.1.8.RELEASE" dokkaVersion = "0.9.18" @@ -31,7 +31,7 @@ apply plugin: "org.asciidoctor.convert" apply plugin: "org.jetbrains.dokka" group = "capital.scalable" -version = "2.0.8-SNAPSHOT" +version = "2.0.8" description = """Spring Auto REST Docs Kotlin Web MVC Example Project""" diff --git a/samples/kotlin-webmvc/pom.xml b/samples/kotlin-webmvc/pom.xml index 978050c0..3ba7ded2 100644 --- a/samples/kotlin-webmvc/pom.xml +++ b/samples/kotlin-webmvc/pom.xml @@ -13,7 +13,7 @@ capital.scalable spring-auto-restdocs-kotlin-webmvc-example - 2.0.8-SNAPSHOT + 2.0.8 Spring Auto REST Docs Kotlin Web MVC Example Project Example project for Spring Auto REST Docs @@ -34,7 +34,7 @@ UTF-8 2.0.4.RELEASE - 2.0.8-SNAPSHOT + 2.0.8 1.3.41 0.9.18 ${project.build.directory}/generated-javadoc-json diff --git a/samples/pom.xml b/samples/pom.xml index c039580c..42600dfa 100644 --- a/samples/pom.xml +++ b/samples/pom.xml @@ -6,7 +6,7 @@ capital.scalable spring-auto-restdocs-samples - 2.0.8-SNAPSHOT + 2.0.8 pom @@ -43,4 +43,4 @@ - \ No newline at end of file + diff --git a/samples/shared/pom.xml b/samples/shared/pom.xml index fe6b32ea..711b24b2 100644 --- a/samples/shared/pom.xml +++ b/samples/shared/pom.xml @@ -13,7 +13,7 @@ capital.scalable spring-auto-restdocs-shared-pojos-example - 2.0.8-SNAPSHOT + 2.0.8 Spring Auto REST Docs Shared POJOs Example Project Example project for Shared POJOs inside Spring Auto REST Docs @@ -33,7 +33,7 @@ UTF-8 - 2.0.8-SNAPSHOT + 2.0.8 diff --git a/spring-auto-restdocs-annotations/pom.xml b/spring-auto-restdocs-annotations/pom.xml index bfaa73f7..19234795 100644 --- a/spring-auto-restdocs-annotations/pom.xml +++ b/spring-auto-restdocs-annotations/pom.xml @@ -7,7 +7,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 .. diff --git a/spring-auto-restdocs-core/pom.xml b/spring-auto-restdocs-core/pom.xml index 699cb74a..4ec507af 100644 --- a/spring-auto-restdocs-core/pom.xml +++ b/spring-auto-restdocs-core/pom.xml @@ -7,7 +7,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 .. diff --git a/spring-auto-restdocs-docs/pom.xml b/spring-auto-restdocs-docs/pom.xml index f8a3c4de..2a7c34b4 100644 --- a/spring-auto-restdocs-docs/pom.xml +++ b/spring-auto-restdocs-docs/pom.xml @@ -6,7 +6,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 .. @@ -18,7 +18,7 @@ ${project.basedir}/../docs - 2.0.7 + 2.0.8 diff --git a/spring-auto-restdocs-dokka-json/pom.xml b/spring-auto-restdocs-dokka-json/pom.xml index 8227f61a..eadec4a8 100644 --- a/spring-auto-restdocs-dokka-json/pom.xml +++ b/spring-auto-restdocs-dokka-json/pom.xml @@ -5,7 +5,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 .. diff --git a/spring-auto-restdocs-json-doclet-jdk9/pom.xml b/spring-auto-restdocs-json-doclet-jdk9/pom.xml index 6e5f1a33..dc99617d 100644 --- a/spring-auto-restdocs-json-doclet-jdk9/pom.xml +++ b/spring-auto-restdocs-json-doclet-jdk9/pom.xml @@ -5,7 +5,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 .. diff --git a/spring-auto-restdocs-json-doclet/pom.xml b/spring-auto-restdocs-json-doclet/pom.xml index ce400740..af571bc1 100644 --- a/spring-auto-restdocs-json-doclet/pom.xml +++ b/spring-auto-restdocs-json-doclet/pom.xml @@ -5,7 +5,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.8-SNAPSHOT + 2.0.8 ..