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

Commit ab791f9

Browse files
jmisurjmisur
authored
2.0.3 release (#279)
1 parent f77936e commit ab791f9

File tree

18 files changed

+39
-33
lines changed

18 files changed

+39
-33
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail
2222

2323
## Documentation
2424

25-
[Current 2.0.2 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.2/docs/index.html) reference guide (based on Spring REST Docs 2.x).
25+
[Current 2.0.3 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.3/docs/index.html) reference guide (based on Spring REST Docs 2.x).
2626

2727
[Current 1.0.14 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.14/docs/index.html) reference guide (based on Spring REST Docs 1.x).
2828

2929
Latest master [2.0.3-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
3030

3131
Older releases:
32-
[2.0.1](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.1/docs/index.html),
32+
[2.0.2](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.2/docs/index.html),
3333
[1.0.13](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.13/docs/index.html)
3434

3535
## Main features

‎docs/index.html

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@
437437
<h1>Spring Auto REST Docs</h1>
438438
<div class="details">
439439
<span id="author" class="author">Scalable Capital</span><br>
440-
<span id="revnumber">version 2.0.3-SNAPSHOT</span>
440+
<span id="revnumber">version 2.0.3</span>
441441
</div>
442442
<div id="toc" class="toc2">
443443
<div id="toctitle">Table of Contents</div>
@@ -594,6 +594,10 @@ <h2 id="faq"><a class="link" href="#faq">FAQ</a></h2>
594594
With Gradle it can be done via <code>./gradlew asciidoctor</code> if <code>asciidoctor</code> is the name of the Gradle task
595595
in your setup. You might have to remove <code>dependsOn test</code> depending on your setup to run it standalone.</p>
596596
</li>
597+
<li>
598+
<p><em>Is HATEOAS supported?</em></p>
599+
<p>Yes, there is basic support for <a href="#snippets-links">links</a> and <a href="#snippets-embedded">embedded</a> resources.</p>
600+
</li>
597601
</ol>
598602
</div>
599603
</div>
@@ -642,7 +646,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
642646
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
643647
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
644648
&lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
645-
&lt;version&gt;2.0.3-SNAPSHOT&lt;/version&gt;
649+
&lt;version&gt;2.0.3&lt;/version&gt;
646650
&lt;scope&gt;test&lt;/scope&gt; <i class="conum" data-value="1"></i><b>(1)</b>
647651
&lt;/dependency&gt;
648652

@@ -679,7 +683,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
679683
&lt;docletArtifact&gt;
680684
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
681685
&lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt; <i class="conum" data-value="4"></i><b>(4)</b>
682-
&lt;version&gt;2.0.3-SNAPSHOT&lt;/version&gt;
686+
&lt;version&gt;2.0.3&lt;/version&gt;
683687
&lt;/docletArtifact&gt;
684688
&lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt; <i class="conum" data-value="3"></i><b>(3)</b>
685689
&lt;reportOutputDirectory&gt;${project.build.directory}&lt;/reportOutputDirectory&gt; <i class="conum" data-value="3"></i><b>(3)</b>
@@ -728,8 +732,8 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
728732
}
729733

730734
dependencies {
731-
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.3-SNAPSHOT' <i class="conum" data-value="1"></i><b>(1)</b>
732-
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.3-SNAPSHOT' <i class="conum" data-value="4"></i><b>(4)</b>
735+
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.3' <i class="conum" data-value="1"></i><b>(1)</b>
736+
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.3' <i class="conum" data-value="4"></i><b>(4)</b>
733737
}
734738

735739
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -2397,8 +2401,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
23972401
</div>
23982402
<div id="footer">
23992403
<div id="footer-text">
2400-
Version 2.0.3-SNAPSHOT<br>
2401-
Last updated 2018-11-22 13:12:12 CET
2404+
Version 2.0.3<br>
2405+
Last updated 2018-12-05 21:53:37 CET
24022406
</div>
24032407
</div>
24042408
<link rel="stylesheet" href="highlight/styles/github.min.css">

‎pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>capital.scalable</groupId>
77
<artifactId>spring-auto-restdocs-parent</artifactId>
8-
<version>2.0.3-SNAPSHOT</version>
8+
<version>2.0.3</version>
99
<packaging>pom</packaging>
1010

1111
<name>Spring Auto REST Docs Parent POM</name>

‎samples/java-webflux/generated-docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1955,12 +1955,12 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
19551955
"pageable" : "INSTANCE",
19561956
"total" : 1,
19571957
"last" : true,
1958-
"totalElements" : 1,
19591958
"totalPages" : 1,
1959+
"totalElements" : 1,
19601960
"size" : 0,
19611961
"number" : 0,
1962-
"first" : true,
19631962
"numberOfElements" : 1,
1963+
"first" : true,
19641964
"sort" : {
19651965
"orders" : [ ],
19661966
"sorted" : false,

‎samples/java-webflux/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3636
<start-class>capital.scalable.restdocs.example.Application</start-class>
3737
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
38-
<spring-auto-restdocs.version>2.0.3-SNAPSHOT</spring-auto-restdocs.version>
38+
<spring-auto-restdocs.version>2.0.3</spring-auto-restdocs.version>
3939
</properties>
4040

4141
<dependencies>

‎samples/java-webmvc/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
buildscript {
22
ext {
3-
springAutoRestDocsVersion = "2.0.3-SNAPSHOT"
3+
springAutoRestDocsVersion = "2.0.3"
44
springRestDocsVersion = "2.0.2.RELEASE"
55
springBootVersion = "2.0.6.RELEASE"
66
}

‎samples/java-webmvc/generated-docs/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1167,7 +1167,7 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
11671167
<div class="content">
11681168
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
11691169
-H 'Content-Type: application/json' \
1170-
-H 'Authorization: Bearer b42d7fe9-1c74-44dd-9223-8e3469381f2b' \
1170+
-H 'Authorization: Bearer d1c9b00e-97e2-46a4-ab14-eecf930a3377' \
11711171
-d '{"description":"Hot News"}'</code></pre>
11721172
</div>
11731173
</div>
@@ -1416,7 +1416,7 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
14161416
<div class="content">
14171417
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
14181418
-H 'Content-Type: application/json' \
1419-
-H 'Authorization: Bearer b42d7fe9-1c74-44dd-9223-8e3469381f2b' \
1419+
-H 'Authorization: Bearer d1c9b00e-97e2-46a4-ab14-eecf930a3377' \
14201420
-d '{"description":"Hot News"}'</code></pre>
14211421
</div>
14221422
</div>
@@ -1534,7 +1534,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
15341534
<div class="listingblock">
15351535
<div class="content">
15361536
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
1537-
-H 'Authorization: Bearer b42d7fe9-1c74-44dd-9223-8e3469381f2b'</code></pre>
1537+
-H 'Authorization: Bearer d1c9b00e-97e2-46a4-ab14-eecf930a3377'</code></pre>
15381538
</div>
15391539
</div>
15401540
</div>
@@ -2054,13 +2054,13 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
20542054
"unpaged" : false
20552055
},
20562056
"total" : 1,
2057+
"last" : true,
20572058
"totalPages" : 1,
20582059
"totalElements" : 1,
2059-
"last" : true,
20602060
"size" : 20,
20612061
"number" : 0,
2062-
"first" : true,
20632062
"numberOfElements" : 1,
2063+
"first" : true,
20642064
"sort" : {
20652065
"orders" : [ ],
20662066
"sorted" : false,

‎samples/java-webmvc/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3636
<start-class>capital.scalable.restdocs.example.Application</start-class>
3737
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
38-
<spring-auto-restdocs.version>2.0.3-SNAPSHOT</spring-auto-restdocs.version>
38+
<spring-auto-restdocs.version>2.0.3</spring-auto-restdocs.version>
3939
</properties>
4040

4141
<dependencies>

‎samples/kotlin-webmvc/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
buildscript {
22
ext {
33
kotlinVersion = "1.3.0"
4-
springAutoRestDocsVersion = "2.0.3-SNAPSHOT"
4+
springAutoRestDocsVersion = "2.0.3"
55
springRestDocsVersion = "2.0.2.RELEASE"
66
springBootVersion = "2.0.6.RELEASE"
77
dokkaVersion = "0.9.17"

‎samples/kotlin-webmvc/generated-docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,7 +1135,7 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
11351135
<div class="content">
11361136
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
11371137
-H 'Content-Type: application/json' \
1138-
-H 'Authorization: Bearer 9d545a6e-b07c-40f9-974d-3a76009280f1' \
1138+
-H 'Authorization: Bearer 69665eb8-8518-461b-8df9-b220b6694eae' \
11391139
-d '{"description":"Hot News"}'</code></pre>
11401140
</div>
11411141
</div>
@@ -1372,7 +1372,7 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
13721372
<div class="content">
13731373
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
13741374
-H 'Content-Type: application/json' \
1375-
-H 'Authorization: Bearer 9d545a6e-b07c-40f9-974d-3a76009280f1' \
1375+
-H 'Authorization: Bearer 69665eb8-8518-461b-8df9-b220b6694eae' \
13761376
-d '{"description":"Hot News"}'</code></pre>
13771377
</div>
13781378
</div>
@@ -1474,7 +1474,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
14741474
<div class="listingblock">
14751475
<div class="content">
14761476
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
1477-
-H 'Authorization: Bearer 9d545a6e-b07c-40f9-974d-3a76009280f1'</code></pre>
1477+
-H 'Authorization: Bearer 69665eb8-8518-461b-8df9-b220b6694eae'</code></pre>
14781478
</div>
14791479
</div>
14801480
</div>

‎samples/kotlin-webmvc/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<properties>
3535
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3636
<spring-restdocs.version>2.0.2.RELEASE</spring-restdocs.version>
37-
<spring-auto-restdocs.version>2.0.3-SNAPSHOT</spring-auto-restdocs.version>
37+
<spring-auto-restdocs.version>2.0.3</spring-auto-restdocs.version>
3838
<kotlin.version>1.3.0</kotlin.version>
3939
<dokka.version>0.9.17</dokka.version>
4040
<jsonDirectory>${project.build.directory}/generated-javadoc-json</jsonDirectory>

‎samples/shared/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
<properties>
3535
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
36-
<spring-auto-restdocs.version>2.0.3-SNAPSHOT</spring-auto-restdocs.version>
36+
<spring-auto-restdocs.version>2.0.3</spring-auto-restdocs.version>
3737
</properties>
3838

3939
<dependencies>

‎spring-auto-restdocs-core/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>capital.scalable</groupId>
99
<artifactId>spring-auto-restdocs-parent</artifactId>
10-
<version>2.0.3-SNAPSHOT</version>
10+
<version>2.0.3</version>
1111
<relativePath>..</relativePath>
1212
</parent>
1313

‎spring-auto-restdocs-docs/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ Can I regenerate the final HTML without running all tests?::
7373
(where `process-asciidoc` is the goal specified in your Maven POM and might differ).
7474
With Gradle it can be done via `./gradlew asciidoctor` if `asciidoctor` is the name of the Gradle task
7575
in your setup. You might have to remove `dependsOn test` depending on your setup to run it standalone.
76+
Is HATEOAS supported?::
77+
Yes, there is basic support for <<snippets-links,links>> and <<snippets-embedded,embedded>> resources.
7678

7779
include::getting-started.adoc[]
7880

‎spring-auto-restdocs-docs/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>capital.scalable</groupId>
88
<artifactId>spring-auto-restdocs-parent</artifactId>
9-
<version>2.0.3-SNAPSHOT</version>
9+
<version>2.0.3</version>
1010
<relativePath>..</relativePath>
1111
</parent>
1212

@@ -18,7 +18,7 @@
1818

1919
<properties>
2020
<docs.dir>${project.basedir}/../docs</docs.dir>
21-
<latestRelease>2.0.3-SNAPSHOT</latestRelease> <!-- change this when releasing 2.0.3-SNAPSHOT< -->
21+
<latestRelease>2.0.3</latestRelease> <!-- change this when releasing 2.0.3-SNAPSHOT< -->
2222
</properties>
2323

2424
<build>

‎spring-auto-restdocs-dokka-json/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<groupId>capital.scalable</groupId>
77
<artifactId>spring-auto-restdocs-parent</artifactId>
8-
<version>2.0.3-SNAPSHOT</version>
8+
<version>2.0.3</version>
99
<relativePath>..</relativePath>
1010
</parent>
1111

‎spring-auto-restdocs-json-doclet-jdk9/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<parent>
66
<groupId>capital.scalable</groupId>
77
<artifactId>spring-auto-restdocs-parent</artifactId>
8-
<version>2.0.3-SNAPSHOT</version>
8+
<version>2.0.3</version>
99
<relativePath>..</relativePath>
1010
</parent>
1111

1212
<artifactId>spring-auto-restdocs-json-doclet-jdk9</artifactId>
13-
<version>2.0.3-SNAPSHOT</version>
13+
<version>2.0.3</version>
1414
<packaging>jar</packaging>
1515

1616
<name>Spring Auto REST Docs Json Doclet for JDK9+</name>

‎spring-auto-restdocs-json-doclet/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<groupId>capital.scalable</groupId>
77
<artifactId>spring-auto-restdocs-parent</artifactId>
8-
<version>2.0.3-SNAPSHOT</version>
8+
<version>2.0.3</version>
99
<relativePath>..</relativePath>
1010
</parent>
1111

0 commit comments

Comments
 (0)