Upgrade to Spring REST Docs 1.2.3 (#177)

Author: fbenz

.travis.yml

@@ -13,8 +13,8 @@ cache:
   - $HOME/.gradle/caches/
   - $HOME/.gradle/wrapper/
 before_install:
-- mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.2.RELEASE-test.jar
-  -DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=1.2.2.RELEASE
+- mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.3.RELEASE-test.jar
+  -DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=1.2.3.RELEASE
   -Dpackaging=jar -Dclassifier=test
 script:
 - mvn install -B -V

docs/index.html

@@ -563,7 +563,7 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
 <p>Java 7</p>
 </li>
 <li>
-<p>Spring REST Docs 1.2.2.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/1.2.2.RELEASE/reference/html5/">documentation</a>)</p>
+<p>Spring REST Docs 1.2.3.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/">documentation</a>)</p>
 </li>
 <li>
 <p>Jackson has to be used for creating and parsing JSON</p>
@@ -576,7 +576,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
 <div class="olist arabic">
 <ol class="arabic">
 <li>
-<p>Setup project for <a href="http://docs.spring.io/spring-restdocs/docs/1.2.2.RELEASE/reference/html5/#getting-started">Spring REST Docs</a></p>
+<p>Setup project for <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/#getting-started">Spring REST Docs</a></p>
 </li>
 <li>
 <p>Additional configuration for this extension:</p>
@@ -1397,10 +1397,10 @@ <h3 id="snippets-custom"><a class="link" href="#snippets-custom">Custom snippet<
 <h3 id="snippets-customization"><a class="link" href="#snippets-customization">Snippet customization</a></h3>
 <div class="paragraph">
 <p>Provide your own template in <code>org/springframework/restdocs/templates/asciidoctor</code> (or <code>markdown</code>) package of your resources.
-You can override <a href="https://github.com/spring-projects/spring-restdocs/tree/v1.2.2.RELEASE/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates">REST Docs templates</a>
+You can override <a href="https://github.com/spring-projects/spring-restdocs/tree/v1.2.3.RELEASE/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates">REST Docs templates</a>
 and <a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/spring-auto-restdocs-core/src/main/resources/org/springframework/restdocs/templates">Auto REST Docs templates</a>.
 Important is to omit <code>default-</code> part from the template name so that the resolution algorithm will prefer this custom template.
-See also <a href="http://docs.spring.io/spring-restdocs/docs/1.2.2.RELEASE/reference/html5/#documenting-your-api-customizing-snippets">original documentation</a> for additional details.</p>
+See also <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/#documenting-your-api-customizing-snippets">original documentation</a> for additional details.</p>
 </div>
 </div>
 </div>
@@ -1480,7 +1480,7 @@ <h3 id="constraints-custom"><a class="link" href="#constraints-custom">Custom co
 Each description is a property where the key is the full class name of the annotation suffixed with <code>.description</code>.
 The value is the description and can contain placeholders for annotation methods,
 e.g. <code>${value}</code> to get the content of <code>value()</code>.
-For more details, see original documentation of <a href="http://docs.spring.io/spring-restdocs/docs/1.2.2.RELEASE/reference/html5/#documenting-your-api-constraints-describing">here</a>.</p>
+For more details, see original documentation of <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/#documenting-your-api-constraints-describing">here</a>.</p>
 </div>
 <div class="paragraph">
 <p>Example for the constraint annotation <code>myproject.constraints.OneOf</code>:</p>
@@ -1625,7 +1625,7 @@ <h3 id="paging"><a class="link" href="#paging">Paging support</a></h3>
 <p>Paging support in an endpoint is automatically recognized if request handler method contains <code>Pageable</code> parameter
 and response is of type <code>Page</code>. This is then mentioned in request and response snippets by linking
 to common section explaining the details of supported paging parameters/fields.
-This section has to be created manally and must be tagged as <code>[[overview-pagination]]</code>.
+This section has to be created manually and must be tagged as <code>[[overview-pagination]]</code>.
 See example project for <a href="https://github.com/ScaCap/spring-auto-restdocs/blob/master/spring-auto-restdocs-example/src/main/asciidoc/index.adoc#overview-pagination">paging section</a> template.</p>
 </div>
 </div>
@@ -1686,9 +1686,9 @@ <h4 id="contributing-installing-testjar"><a class="link" href="#contributing-ins
 <div class="listingblock">
 <div class="title">Bash</div>
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.2.RELEASE-test.jar \
+<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.3.RELEASE-test.jar \
     -DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core \
-    -Dversion=1.2.2.RELEASE -Dpackaging=test-jar -Dclassifier=test</code></pre>
+    -Dversion=1.2.3.RELEASE -Dpackaging=test-jar -Dclassifier=test</code></pre>
 </div>
 </div>
 </div>
@@ -1699,7 +1699,7 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
 but if you ever want to upgrade the version of Spring REST Docs in this project this step has to be done.</p>
 </div>
 <div class="paragraph">
-<p>We use version 1.2.2.RELEASE of Spring REST Docs in this example.</p>
+<p>We use version 1.2.3.RELEASE of Spring REST Docs in this example.</p>
 </div>
 <div class="paragraph">
 <p>You find the currently required version in <code>pom.xml</code>:</p>
@@ -1710,7 +1710,7 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
 <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;dependency&gt;
     &lt;groupId&gt;org.springframework.restdocs&lt;/groupId&gt;
     &lt;artifactId&gt;spring-restdocs-core&lt;/artifactId&gt;
-    &lt;version&gt;1.2.2.RELEASE&lt;/version&gt;
+    &lt;version&gt;1.2.3.RELEASE&lt;/version&gt;
     &lt;classifier&gt;test&lt;/classifier&gt;
     &lt;scope&gt;test&lt;/scope&gt;
 &lt;/dependency&gt;</code></pre>
@@ -1725,13 +1725,13 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
 <pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">git clone git@github.com:spring-projects/spring-restdocs.git
 cd spring-restdocs
 git fetch --tags
-git checkout tags/v1.2.2.RELEASE
+git checkout tags/v1.2.3.RELEASE
 ./gradlew build</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Afterwards the test JAR is located at
-<code>spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-1.2.2.RELEASE-test.jar</code>
+<code>spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-1.2.3.RELEASE-test.jar</code>
 and has to be installed with the Maven command shown in the section above.</p>
 </div>
 </div>
@@ -1750,7 +1750,7 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2017-11-04 17:46:45 GMT
+Last updated 2017-12-01 21:41:24 CET
 </div>
 </div>
 <link rel="stylesheet" href="highlight/styles/github.min.css">

…ing-restdocs-core-1.2.2.RELEASE-test.jar …ing-restdocs-core-1.2.3.RELEASE-test.jarlib/spring-restdocs-core-1.2.2.RELEASE-test.jar renamed to lib/spring-restdocs-core-1.2.3.RELEASE-test.jar lib/spring-restdocs-core-1.2.2.RELEASE-test.jar renamed to lib/spring-restdocs-core-1.2.3.RELEASE-test.jar

@@ -56,7 +56,7 @@
         <java.version>1.7</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
-        <spring-restdocs.version>1.2.2.RELEASE</spring-restdocs.version>
+        <spring-restdocs.version>1.2.3.RELEASE</spring-restdocs.version>
     </properties>
 
     <build>

pom.xml

@@ -1,6 +1,6 @@
 buildscript {
     ext {
-        springBootVersion = "1.5.8.RELEASE"
+        springBootVersion = "1.5.9.RELEASE"
     }
     repositories {
         jcenter()
@@ -51,8 +51,8 @@ dependencies {
         exclude(module: "commons-logging")
     }
     testCompile "com.jayway.jsonpath:json-path-assert"
-    testCompile "org.springframework.restdocs:spring-restdocs-core:1.2.2.RELEASE"
-    testCompile "org.springframework.restdocs:spring-restdocs-mockmvc:1.2.2.RELEASE"
+    testCompile "org.springframework.restdocs:spring-restdocs-core:1.2.3.RELEASE"
+    testCompile "org.springframework.restdocs:spring-restdocs-mockmvc:1.2.3.RELEASE"
     compileOnly "org.projectlombok:lombok"
     jsondoclet "capital.scalable:spring-auto-restdocs-json-doclet:$version"
 }

spring-auto-restdocs-example/build.gradle

@@ -1117,7 +1117,7 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer 024eccb9-bbe3-448f-b6ea-804db7e3f1c0' \
+    -H 'Authorization: Bearer a771d0c0-a03b-48ee-9511-f33193a506c9' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -1352,7 +1352,7 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer 024eccb9-bbe3-448f-b6ea-804db7e3f1c0' \
+    -H 'Authorization: Bearer a771d0c0-a03b-48ee-9511-f33193a506c9' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -1455,7 +1455,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" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-    -H 'Authorization: Bearer 024eccb9-bbe3-448f-b6ea-804db7e3f1c0'</code></pre>
+    -H 'Authorization: Bearer a771d0c0-a03b-48ee-9511-f33193a506c9'</code></pre>
 </div>
 </div>
 </div>
@@ -1935,9 +1935,9 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
     "offset" : 0
   },
   "total" : 1,
+  "totalPages" : 1,
   "totalElements" : 1,
   "last" : true,
-  "totalPages" : 1,
   "sort" : null,
   "first" : true,
   "numberOfElements" : 1,
@@ -2406,7 +2406,7 @@ <h4 id="_example_response_9"><a class="anchor" href="#_example_response_9"></a><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2017-11-02 20:52:09 GMT
+Last updated 2017-11-02 01:44:08 CET
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css">

spring-auto-restdocs-example/generated-docs/index.html

@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>1.5.8.RELEASE</version>
+        <version>1.5.9.RELEASE</version>
         <relativePath/>
     </parent>
 
@@ -23,7 +23,7 @@
         <java.version>1.7</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <start-class>capital.scalable.restdocs.example.Application</start-class>
-        <spring-restdocs.version>1.2.2.RELEASE</spring-restdocs.version>
+        <spring-restdocs.version>1.2.3.RELEASE</spring-restdocs.version>
         <spring-auto-restdocs.version>1.0.11-SNAPSHOT</spring-auto-restdocs.version>
     </properties>