2.0.8 Release (#376)

ScaCap · Feb 25, 2020 · c2553bf · c2553bf
1 parent 6d85749
commit c2553bf
Show file tree

Hide file tree

Showing 18 changed files with 60 additions and 78 deletions.
diff --git 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
@@ -437,7 +437,7 @@
 <h1>Spring Auto REST Docs</h1>
 <div class="details">
 <span id="author" class="author">Scalable Capital</span><br>
-<span id="revnumber">version 2.0.7</span>
+<span id="revnumber">version 2.0.8</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -653,7 +653,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
 <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
     &lt;groupId&gt;capital.scalable&lt;/groupId&gt;
     &lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
-    &lt;version&gt;2.0.7&lt;/version&gt;
+    &lt;version&gt;2.0.8&lt;/version&gt;
     &lt;scope&gt;test&lt;/scope&gt;
 &lt;/dependency&gt;
 
@@ -690,7 +690,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
                         &lt;docletArtifact&gt;
                             &lt;groupId&gt;capital.scalable&lt;/groupId&gt;
                             &lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt; <i class="conum" data-value="3"></i><b>(3)</b>
-                            &lt;version&gt;2.0.7&lt;/version&gt;
+                            &lt;version&gt;2.0.8&lt;/version&gt;
                         &lt;/docletArtifact&gt;
                         &lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt; <i class="conum" data-value="2"></i><b>(2)</b>
                         &lt;reportOutputDirectory&gt;${project.build.directory}&lt;/reportOutputDirectory&gt; <i class="conum" data-value="2"></i><b>(2)</b>
@@ -735,8 +735,8 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">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' <i class="conum" data-value="3"></i><b>(3)</b>
+    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' <i class="conum" data-value="3"></i><b>(3)</b>
 }
 
 task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -2266,6 +2266,9 @@ <h3 id="preprocessors"><a class="link" href="#preprocessors">Preprocessors</a></
 <p><a href="https://github.com/ScaCap/spring-auto-restdocs/blob/master/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/response/BinaryReplacementContentModifier.java">binary replacement</a>: replaces content with <code>&lt;binary&gt;</code> for common mime types</p>
 </li>
 <li>
+<p><a href="https://github.com/ScaCap/spring-auto-restdocs/blob/master/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/response/MultipartContentOperationPreprocessor.java">multipart binary replacement</a>: replaces content with <code>&lt;binary&gt;</code> for multipart/form-data requests</p>
+</li>
+<li>
 <p><a href="https://github.com/ScaCap/spring-auto-restdocs/blob/master/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/response/ArrayLimitingJsonContentModifier.java">limit JSON array length</a>: limits all JSON arrays to 3 items</p>
 </li>
 </ul>
@@ -2508,8 +2511,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 2.0.7<br>
-Last updated 2019-10-07 11:42:51 +0200
+Version 2.0.8<br>
+Last updated 2020-02-24 21:43:07 +0100
 </div>
 </div>
 <link rel="stylesheet" href="highlight/styles/github.min.css">

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-parent</artifactId>
-    <version>2.0.8-SNAPSHOT</version>
+    <version>2.0.8</version>
     <packaging>pom</packaging>
 
     <name>Spring Auto REST Docs Parent POM</name>

diff --git a/samples/java-webflux/generated-docs/index.html b/samples/java-webflux/generated-docs/index.html
@@ -541,7 +541,7 @@ <h4 id="_response_fields"><a class="anchor" href="#_response_fields"></a><a clas
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -753,7 +753,7 @@ <h4 id="_response_fields_2"><a class="anchor" href="#_response_fields_2"></a><a
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -1028,7 +1028,7 @@ <h4 id="_response_fields_3"><a class="anchor" href="#_response_fields_3"></a><a
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -1166,7 +1166,7 @@ <h4 id="_example_response_3"><a class="anchor" href="#_example_response_3"></a><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2019-10-07 11:41:40 +0200
+Last updated 2019-09-30 21:39:20 +0200
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/github.min.css">

diff --git a/samples/java-webflux/pom.xml b/samples/java-webflux/pom.xml
@@ -13,7 +13,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-java-webflux-example</artifactId>
-    <version>2.0.8-SNAPSHOT</version>
+    <version>2.0.8</version>
 
     <name>Spring Auto REST Docs Java WebFlux Example Project</name>
     <description>Example project for Spring Auto REST Docs</description>
@@ -35,7 +35,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <start-class>capital.scalable.restdocs.example.Application</start-class>
         <spring-restdocs.version>2.0.4.RELEASE</spring-restdocs.version>
-        <spring-auto-restdocs.version>2.0.8-SNAPSHOT</spring-auto-restdocs.version>
+        <spring-auto-restdocs.version>2.0.8</spring-auto-restdocs.version>
     </properties>
 
     <dependencies>

diff --git 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
@@ -721,7 +721,7 @@ <h4 id="_response_fields"><a class="anchor" href="#_response_fields"></a><a clas
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -941,7 +941,7 @@ <h4 id="_response_fields_2"><a class="anchor" href="#_response_fields_2"></a><a
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -1195,8 +1195,8 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ 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"}'</code></pre>
 </div>
 </div>
@@ -1337,7 +1337,7 @@ <h4 id="_response_fields_4"><a class="anchor" href="#_response_fields_4"></a><a
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -1458,8 +1458,8 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ 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"}'</code></pre>
 </div>
 </div>
@@ -1503,7 +1503,7 @@ <h3 id="resources-item-resource-test-delete-item"><a class="anchor" href="#resou
 <p>Non existing items are ignored</p>
 </div>
 <div class="paragraph">
-<p>An example of using path variables.</p>
+<p>An example of using path variables. parameters documentation&lt;/a&gt;.</p>
 </div>
 <div class="paragraph">
 <p>See <a href="https://scacap.github.io/spring-auto-restdocs/#snippets-path-parameters">path parameters documentation</a>.</p>
@@ -1577,7 +1577,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-    -H 'Authorization: Bearer f63d67e7-d3a9-44fe-9efa-1dd4bd7b1d35'</code></pre>
+    -H 'Authorization: Bearer fdd5ad33-4481-44d1-83d1-4fa1b23753e6'</code></pre>
 </div>
 </div>
 </div>
@@ -1605,7 +1605,7 @@ <h3 id="resources-item-resource-test-get-child-item"><a class="anchor" href="#re
 <p>Retrieves a child of specified item.</p>
 </div>
 <div class="paragraph">
-<p>An example of using parameter validation.</p>
+<p>An example of using parameter validation. documentation&lt;/a&gt;.</p>
 </div>
 <div class="paragraph">
 <p>See <a href="https://scacap.github.io/spring-auto-restdocs/#constraints">constraints documentation</a>.</p>
@@ -1693,7 +1693,7 @@ <h4 id="_response_fields_6"><a class="anchor" href="#_response_fields_6"></a><a
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -1946,7 +1946,7 @@ <h4 id="_response_fields_7"><a class="anchor" href="#_response_fields_7"></a><a
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -2119,26 +2119,26 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
       "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" : [ ],
     "sorted" : false,
     "unsorted" : true,
     "empty" : true
   },
+  "number" : 0,
+  "numberOfElements" : 1,
+  "size" : 20,
   "empty" : false
 }</code></pre>
 </div>
@@ -2337,30 +2337,9 @@ <h4 id="_query_parameters_7"><a class="anchor" href="#_query_parameters_7"></a><
 </div>
 <div class="sect3">
 <h4 id="_request_fields_9"><a class="anchor" href="#_request_fields_9"></a><a class="link" href="#_request_fields_9">2.9.4. Request fields</a></h4>
-<table class="tableblock frame-all grid-all stretch">
-<colgroup>
-<col style="width: 25%;">
-<col style="width: 25%;">
-<col style="width: 25%;">
-<col style="width: 25%;">
-</colgroup>
-<thead>
-<tr>
-<th class="tableblock halign-left valign-top">Path</th>
-<th class="tableblock halign-left valign-top">Type</th>
-<th class="tableblock halign-left valign-top">Optional</th>
-<th class="tableblock halign-left valign-top">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">command</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Command to execute.</p></td>
-</tr>
-</tbody>
-</table>
+<div class="paragraph">
+<p>No request body.</p>
+</div>
 </div>
 <div class="sect3">
 <h4 id="_response_fields_9"><a class="anchor" href="#_response_fields_9"></a><a class="link" href="#_response_fields_9">2.9.5. Response fields</a></h4>
@@ -2991,7 +2970,7 @@ <h4 id="_response_fields_13"><a class="anchor" href="#_response_fields_13"></a><
 <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata.</p>
-<p class="tableblock">An example of JsonSubType support.<br>
+<p class="tableblock">An example of JsonSubType support. Jackson type documentation&lt;/a&gt;<br>
 See <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling"> Jackson type documentation</a>.</p></td>
 </tr>
 <tr>
@@ -3324,7 +3303,7 @@ <h4 id="_example_response_12"><a class="anchor" href="#_example_response_12"></a
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2019-10-07 11:41:40 +0200
+Last updated 2019-09-30 21:39:20 +0200
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/github.min.css">

diff --git a/samples/java-webmvc/pom.xml b/samples/java-webmvc/pom.xml
@@ -13,7 +13,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-java-webmvc-example</artifactId>
-    <version>2.0.8-SNAPSHOT</version>
+    <version>2.0.8</version>
 
     <name>Spring Auto REST Docs Java Web MVC Example Project</name>
     <description>Example project for Spring Auto REST Docs</description>
@@ -35,7 +35,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <start-class>capital.scalable.restdocs.example.Application</start-class>
         <spring-restdocs.version>2.0.4.RELEASE</spring-restdocs.version>
-        <spring-auto-restdocs.version>2.0.8-SNAPSHOT</spring-auto-restdocs.version>
+        <spring-auto-restdocs.version>2.0.8</spring-auto-restdocs.version>
     </properties>
 
     <dependencies>

diff --git 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
@@ -13,7 +13,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-kotlin-webmvc-example</artifactId>
-    <version>2.0.8-SNAPSHOT</version>
+    <version>2.0.8</version>
 
     <name>Spring Auto REST Docs Kotlin Web MVC Example Project</name>
     <description>Example project for Spring Auto REST Docs</description>
@@ -34,7 +34,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <spring-restdocs.version>2.0.4.RELEASE</spring-restdocs.version>
-        <spring-auto-restdocs.version>2.0.8-SNAPSHOT</spring-auto-restdocs.version>
+        <spring-auto-restdocs.version>2.0.8</spring-auto-restdocs.version>
         <kotlin.version>1.3.41</kotlin.version>
         <dokka.version>0.9.18</dokka.version>
         <jsonDirectory>${project.build.directory}/generated-javadoc-json</jsonDirectory>