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

Commit 6ddcee5

Browse files
fbenzjmisur
authored andcommitted
Update to Spring REST Docs 2.0.2 (#253)
* Update to Spring REST Docs 2.0.2 * Update Spring REST Docs version in Travis CI file * test fix
1 parent f3071df commit 6ddcee5

File tree

11 files changed

+30
-29
lines changed

11 files changed

+30
-29
lines changed

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ cache:
1212
- $HOME/.gradle/caches/
1313
- $HOME/.gradle/wrapper/
1414
before_install:
15-
- mvn install:install-file -Dfile=lib/spring-restdocs-core-2.0.1.RELEASE-test.jar
16-
-DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=2.0.1.RELEASE
15+
- mvn install:install-file -Dfile=lib/spring-restdocs-core-2.0.2.RELEASE-test.jar
16+
-DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=2.0.2.RELEASE
1717
-Dpackaging=jar -Dclassifier=test
1818
script:
1919
- mvn install -B -V

docs/index.html

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
583583
<p>Java 7</p>
584584
</li>
585585
<li>
586-
<p>Spring REST Docs 2.0.1.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/2.0.1.RELEASE/reference/html5/">documentation</a>)</p>
586+
<p>Spring REST Docs 2.0.2.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/2.0.2.RELEASE/reference/html5/">documentation</a>)</p>
587587
</li>
588588
<li>
589589
<p>Jackson has to be used for creating and parsing JSON</p>
@@ -596,7 +596,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
596596
<div class="olist arabic">
597597
<ol class="arabic">
598598
<li>
599-
<p>Setup project for <a href="http://docs.spring.io/spring-restdocs/docs/2.0.1.RELEASE/reference/html5/#getting-started">Spring REST Docs</a></p>
599+
<p>Setup project for <a href="http://docs.spring.io/spring-restdocs/docs/2.0.2.RELEASE/reference/html5/#getting-started">Spring REST Docs</a></p>
600600
</li>
601601
<li>
602602
<p>Additional configuration for this extension:</p>
@@ -1522,10 +1522,11 @@ <h3 id="snippets-custom"><a class="link" href="#snippets-custom">Custom snippet<
15221522
<h3 id="snippets-customization"><a class="link" href="#snippets-customization">Snippet customization</a></h3>
15231523
<div class="paragraph">
15241524
<p>Provide your own template in <code>org/springframework/restdocs/templates/asciidoctor</code> (or <code>markdown</code>) package of your resources.
1525-
You can override <a href="https://github.com/spring-projects/spring-restdocs/tree/v2.0.1.RELEASE/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates">REST Docs templates</a>
1525+
You can override <a href="https://github.com/spring-projects/spring-restdocs/tree/v2.0.2.RELEASE/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates">REST Docs
1526+
templates</a>
15261527
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>.
15271528
Important is to omit <code>default-</code> part from the template name so that the resolution algorithm will prefer this custom template.
1528-
See also <a href="http://docs.spring.io/spring-restdocs/docs/2.0.1.RELEASE/reference/html5/#documenting-your-api-customizing-snippets">original documentation</a> for additional details.</p>
1529+
See also <a href="http://docs.spring.io/spring-restdocs/docs/2.0.2.RELEASE/reference/html5/#documenting-your-api-customizing-snippets">original documentation</a> for additional details.</p>
15291530
</div>
15301531
</div>
15311532
</div>
@@ -1605,7 +1606,7 @@ <h3 id="constraints-custom"><a class="link" href="#constraints-custom">Custom co
16051606
Each description is a property where the key is the full class name of the annotation suffixed with <code>.description</code>.
16061607
The value is the description and can contain placeholders for annotation methods,
16071608
e.g. <code>${value}</code> to get the content of <code>value()</code>.
1608-
For more details, see original documentation of <a href="http://docs.spring.io/spring-restdocs/docs/2.0.1.RELEASE/reference/html5/#documenting-your-api-constraints-describing">here</a>.</p>
1609+
For more details, see original documentation of <a href="http://docs.spring.io/spring-restdocs/docs/2.0.2.RELEASE/reference/html5/#documenting-your-api-constraints-describing">here</a>.</p>
16091610
</div>
16101611
<div class="paragraph">
16111612
<p>Example for the constraint annotation <code>myproject.constraints.OneOf</code>:</p>
@@ -1835,9 +1836,9 @@ <h4 id="contributing-installing-testjar"><a class="link" href="#contributing-ins
18351836
<div class="listingblock">
18361837
<div class="title">Bash</div>
18371838
<div class="content">
1838-
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">mvn install:install-file -Dfile=lib/spring-restdocs-core-2.0.1.RELEASE-test.jar \
1839+
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">mvn install:install-file -Dfile=lib/spring-restdocs-core-2.0.2.RELEASE-test.jar \
18391840
-DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core \
1840-
-Dversion=2.0.1.RELEASE -Dpackaging=test-jar -Dclassifier=test</code></pre>
1841+
-Dversion=2.0.2.RELEASE -Dpackaging=test-jar -Dclassifier=test</code></pre>
18411842
</div>
18421843
</div>
18431844
</div>
@@ -1848,7 +1849,7 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
18481849
but if you ever want to upgrade the version of Spring REST Docs in this project this step has to be done.</p>
18491850
</div>
18501851
<div class="paragraph">
1851-
<p>We use version 2.0.1.RELEASE of Spring REST Docs in this example.</p>
1852+
<p>We use version 2.0.2.RELEASE of Spring REST Docs in this example.</p>
18521853
</div>
18531854
<div class="paragraph">
18541855
<p>You find the currently required version in <code>pom.xml</code>:</p>
@@ -1859,7 +1860,7 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
18591860
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
18601861
&lt;groupId&gt;org.springframework.restdocs&lt;/groupId&gt;
18611862
&lt;artifactId&gt;spring-restdocs-core&lt;/artifactId&gt;
1862-
&lt;version&gt;2.0.1.RELEASE&lt;/version&gt;
1863+
&lt;version&gt;2.0.2.RELEASE&lt;/version&gt;
18631864
&lt;classifier&gt;test&lt;/classifier&gt;
18641865
&lt;scope&gt;test&lt;/scope&gt;
18651866
&lt;/dependency&gt;</code></pre>
@@ -1874,13 +1875,13 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
18741875
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone git@github.com:spring-projects/spring-restdocs.git
18751876
cd spring-restdocs
18761877
git fetch --tags
1877-
git checkout tags/v2.0.1.RELEASE
1878+
git checkout tags/v2.0.2.RELEASE
18781879
./gradlew build</code></pre>
18791880
</div>
18801881
</div>
18811882
<div class="paragraph">
18821883
<p>Afterwards the test JAR is located at
1883-
<code>spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-2.0.1.RELEASE-test.jar</code>
1884+
<code>spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-2.0.2.RELEASE-test.jar</code>
18841885
and has to be installed with the Maven command shown in the section above.</p>
18851886
</div>
18861887
</div>
@@ -1900,7 +1901,7 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
19001901
<div id="footer">
19011902
<div id="footer-text">
19021903
Version 2.0.2-SNAPSHOT<br>
1903-
Last updated 2018-08-01 14:58:47 CEST
1904+
Last updated 2018-08-21 17:26:42 CEST
19041905
</div>
19051906
</div>
19061907
<link rel="stylesheet" href="highlight/styles/github.min.css">
212 KB
Binary file not shown.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<maven.compiler.target>1.8</maven.compiler.target>
5959
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
6060
<snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
61-
<spring-restdocs.version>2.0.1.RELEASE</spring-restdocs.version>
61+
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
6262
</properties>
6363

6464
<build>

samples/java-webmvc/build.gradle

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
buildscript {
22
ext {
33
springAutoRestDocsVersion = "2.0.2-SNAPSHOT"
4-
springRestDocsVersion = "2.0.1.RELEASE"
5-
springBootVersion = "2.0.1.RELEASE"
4+
springRestDocsVersion = "2.0.2.RELEASE"
5+
springBootVersion = "2.0.4.RELEASE"
66
}
77
repositories {
88
jcenter()

samples/java-webmvc/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.springframework.boot</groupId>
99
<artifactId>spring-boot-starter-parent</artifactId>
10-
<version>2.0.1.RELEASE</version>
10+
<version>2.0.4.RELEASE</version>
1111
<relativePath/>
1212
</parent>
1313

@@ -37,7 +37,7 @@
3737
<maven.compiler.target>1.8</maven.compiler.target>
3838
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3939
<start-class>capital.scalable.restdocs.example.Application</start-class>
40-
<spring-restdocs.version>2.0.1.RELEASE</spring-restdocs.version>
40+
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
4141
<spring-auto-restdocs.version>2.0.2-SNAPSHOT</spring-auto-restdocs.version>
4242
</properties>
4343

samples/java-webtestclient/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.springframework.boot</groupId>
99
<artifactId>spring-boot-starter-parent</artifactId>
10-
<version>2.0.1.RELEASE</version>
10+
<version>2.0.4.RELEASE</version>
1111
<relativePath/>
1212
</parent>
1313

@@ -37,7 +37,7 @@
3737
<maven.compiler.target>1.8</maven.compiler.target>
3838
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3939
<start-class>capital.scalable.restdocs.example.Application</start-class>
40-
<spring-restdocs.version>2.0.1.RELEASE</spring-restdocs.version>
40+
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
4141
<spring-auto-restdocs.version>2.0.2-SNAPSHOT</spring-auto-restdocs.version>
4242
</properties>
4343

samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public ResponseEntity<Void> addItem(@RequestBody @Valid ItemUpdateRequest itemUp
118118
UriComponentsBuilder uriComponentsBuilder) {
119119
// New item with unique ID is stored and returned.
120120
URI location = uriComponentsBuilder
121-
.path("/{id}")
121+
.path("/items/{id}")
122122
.buildAndExpand("2")
123123
.toUri();
124124

samples/kotlin-webmvc/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
buildscript {
22
ext {
3-
kotlinVersion = "1.2.31"
3+
kotlinVersion = "1.2.60"
44
springAutoRestDocsVersion = "2.0.2-SNAPSHOT"
5-
springRestDocsVersion = "2.0.1.RELEASE"
6-
springBootVersion = "2.0.1.RELEASE"
5+
springRestDocsVersion = "2.0.2.RELEASE"
6+
springBootVersion = "2.0.4.RELEASE"
77
dokkaVersion = "0.9.16"
88
}
99
repositories {

samples/kotlin-webmvc/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.springframework.boot</groupId>
99
<artifactId>spring-boot-starter-parent</artifactId>
10-
<version>2.0.1.RELEASE</version>
10+
<version>2.0.4.RELEASE</version>
1111
<relativePath/>
1212
</parent>
1313

@@ -34,9 +34,9 @@
3434
<properties>
3535
<java.version>1.8</java.version>
3636
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
37-
<spring-restdocs.version>2.0.1.RELEASE</spring-restdocs.version>
37+
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
3838
<spring-auto-restdocs.version>2.0.2-SNAPSHOT</spring-auto-restdocs.version>
39-
<kotlin.version>1.2.31</kotlin.version>
39+
<kotlin.version>1.2.60</kotlin.version>
4040
<dokka.version>0.9.16</dokka.version>
4141
<jsonDirectory>${project.build.directory}/generated-javadoc-json</jsonDirectory>
4242
</properties>

0 commit comments

Comments
 (0)