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

Commit 5505745

Browse files
authored
2.0.6 RELEASE (#342)
* 2.0.6 RELEASE * jackson-databind 2.9.9.1 * regenerated docs * regenerated docs
1 parent 46df17a commit 5505745

File tree

18 files changed

+62
-63
lines changed

18 files changed

+62
-63
lines changed

README.md

Lines changed: 3 additions & 3 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.5 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.5/docs/index.html) reference guide (based on Spring REST Docs 2.x).
25+
[Current 2.0.6 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.6/docs/index.html) reference guide (based on Spring REST Docs 2.x).
2626

2727
[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).
2828

29-
Latest master [2.0.6-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
29+
Latest master [2.0.7-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
3030

3131
Older releases:
32-
[2.0.4](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.4/docs/index.html),
32+
[2.0.5](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.5/docs/index.html),
3333
[1.0.14](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.14/docs/index.html)
3434

3535
## Main features

docs/index.html

Lines changed: 7 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.5</span>
440+
<span id="revnumber">version 2.0.6</span>
441441
</div>
442442
<div id="toc" class="toc2">
443443
<div id="toctitle">Table of Contents</div>
@@ -653,7 +653,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
653653
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
654654
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
655655
&lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
656-
&lt;version&gt;2.0.5&lt;/version&gt;
656+
&lt;version&gt;2.0.6&lt;/version&gt;
657657
&lt;scope&gt;test&lt;/scope&gt;
658658
&lt;/dependency&gt;
659659

@@ -690,7 +690,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
690690
&lt;docletArtifact&gt;
691691
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
692692
&lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt; <i class="conum" data-value="3"></i><b>(3)</b>
693-
&lt;version&gt;2.0.5&lt;/version&gt;
693+
&lt;version&gt;2.0.6&lt;/version&gt;
694694
&lt;/docletArtifact&gt;
695695
&lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt; <i class="conum" data-value="2"></i><b>(2)</b>
696696
&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
735735
}
736736

737737
dependencies {
738-
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.5'
739-
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.5' <i class="conum" data-value="3"></i><b>(3)</b>
738+
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.6'
739+
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.6' <i class="conum" data-value="3"></i><b>(3)</b>
740740
}
741741

742742
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -2508,8 +2508,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
25082508
</div>
25092509
<div id="footer">
25102510
<div id="footer-text">
2511-
Version 2.0.5<br>
2512-
Last updated 2019-05-06 09:47:55 CEST
2511+
Version 2.0.6<br>
2512+
Last updated 2019-07-18 12:08:43 CEST
25132513
</div>
25142514
</div>
25152515
<link rel="stylesheet" href="highlight/styles/github.min.css">

pom.xml

Lines changed: 2 additions & 2 deletions
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.6-SNAPSHOT</version>
8+
<version>2.0.6</version>
99
<packaging>pom</packaging>
1010

1111
<name>Spring Auto REST Docs Parent POM</name>
@@ -309,7 +309,7 @@
309309
<dependency>
310310
<groupId>com.fasterxml.jackson.core</groupId>
311311
<artifactId>jackson-databind</artifactId>
312-
<version>2.9.9</version>
312+
<version>2.9.9.1</version>
313313
</dependency>
314314
<dependency>
315315
<groupId>org.springframework</groupId>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ <h2 id="resources-items"><a class="anchor" href="#resources-items"></a><a class=
458458
<div class="sect2">
459459
<h3 id="resources-item-resource-test-get-item"><a class="anchor" href="#resources-item-resource-test-get-item"></a><a class="link" href="#resources-item-resource-test-get-item">1.1. Get Item</a></h3>
460460
<div class="paragraph">
461-
<p><code>GET /items/1</code></p>
461+
<p><code>+GET /items/1+</code></p>
462462
</div>
463463
<div class="paragraph">
464464
<p>Returns item by ID.</p>
@@ -692,7 +692,7 @@ <h4 id="_example_response"><a class="anchor" href="#_example_response"></a><a cl
692692
<div class="sect2">
693693
<h3 id="resources-item-resource-test-get-all-items"><a class="anchor" href="#resources-item-resource-test-get-all-items"></a><a class="link" href="#resources-item-resource-test-get-all-items">1.2. All Items</a></h3>
694694
<div class="paragraph">
695-
<p><code>GET /items</code></p>
695+
<p><code>+GET /items+</code></p>
696696
</div>
697697
<div class="paragraph">
698698
<p>Lists all items.</p>
@@ -911,7 +911,7 @@ <h4 id="_example_response_2"><a class="anchor" href="#_example_response_2"></a><
911911
<div class="sect2">
912912
<h3 id="resources-item-resource-test-update-item"><a class="anchor" href="#resources-item-resource-test-update-item"></a><a class="link" href="#resources-item-resource-test-update-item">1.3. Update Item</a></h3>
913913
<div class="paragraph">
914-
<p><code>PUT /items/1</code></p>
914+
<p><code>+PUT /items/1+</code></p>
915915
</div>
916916
<div class="paragraph">
917917
<p>Updates existing item.</p>
@@ -1166,7 +1166,7 @@ <h4 id="_example_response_3"><a class="anchor" href="#_example_response_3"></a><
11661166
</div>
11671167
<div id="footer">
11681168
<div id="footer-text">
1169-
Last updated 2019-03-25 20:17:39 CET
1169+
Last updated 2019-05-22 09:13:17 CEST
11701170
</div>
11711171
</div>
11721172
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">

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.3.RELEASE</spring-restdocs.version>
38-
<spring-auto-restdocs.version>2.0.6-SNAPSHOT</spring-auto-restdocs.version>
38+
<spring-auto-restdocs.version>2.0.6</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.6-SNAPSHOT"
3+
springAutoRestDocsVersion = "2.0.6"
44
springRestDocsVersion = "2.0.3.RELEASE"
55
springBootVersion = "2.1.5.RELEASE"
66
}

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1105,7 +1105,7 @@ <h4 id="_example_requestresponse_2"><a class="anchor" href="#_example_requestres
11051105
<div class="sect2">
11061106
<h3 id="resources-item-resource-test-add-item"><a class="anchor" href="#resources-item-resource-test-add-item"></a><a class="link" href="#resources-item-resource-test-add-item">2.3. Add Item</a></h3>
11071107
<div class="paragraph">
1108-
<p><code>POST /items</code></p>
1108+
<p><code>+POST /items+</code></p>
11091109
</div>
11101110
<div class="paragraph">
11111111
<p>Adds new item.</p>
@@ -1194,8 +1194,8 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
11941194
<div class="listingblock">
11951195
<div class="content">
11961196
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
1197+
-H 'Authorization: Bearer 3692d91f-2ca5-4eb6-b811-3f468e26a234' \
11971198
-H 'Content-Type: application/json' \
1198-
-H 'Authorization: Bearer 904105cb-7a6d-4513-ada1-cc27ab84508e' \
11991199
-d '{"description":"Hot News"}'</code></pre>
12001200
</div>
12011201
</div>
@@ -1219,7 +1219,7 @@ <h4 id="_example_response"><a class="anchor" href="#_example_response"></a><a cl
12191219
<div class="sect2">
12201220
<h3 id="resources-item-resource-test-update-item"><a class="anchor" href="#resources-item-resource-test-update-item"></a><a class="link" href="#resources-item-resource-test-update-item">2.4. Update Item</a></h3>
12211221
<div class="paragraph">
1222-
<p><code>PUT /items/{id}</code></p>
1222+
<p><code>+PUT /items/{id}+</code></p>
12231223
</div>
12241224
<div class="paragraph">
12251225
<p>Updates existing item.</p>
@@ -1457,8 +1457,8 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
14571457
<div class="listingblock">
14581458
<div class="content">
14591459
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
1460+
-H 'Authorization: Bearer 3692d91f-2ca5-4eb6-b811-3f468e26a234' \
14601461
-H 'Content-Type: application/json' \
1461-
-H 'Authorization: Bearer 904105cb-7a6d-4513-ada1-cc27ab84508e' \
14621462
-d '{"description":"Hot News"}'</code></pre>
14631463
</div>
14641464
</div>
@@ -1492,7 +1492,7 @@ <h4 id="_example_response_2"><a class="anchor" href="#_example_response_2"></a><
14921492
<div class="sect2">
14931493
<h3 id="resources-item-resource-test-delete-item"><a class="anchor" href="#resources-item-resource-test-delete-item"></a><a class="link" href="#resources-item-resource-test-delete-item">2.5. Delete Item</a></h3>
14941494
<div class="paragraph">
1495-
<p><code>DELETE /items/{id}</code></p>
1495+
<p><code>+DELETE /items/{id}+</code></p>
14961496
</div>
14971497
<div class="paragraph">
14981498
<p>Deletes item.<br>
@@ -1576,7 +1576,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
15761576
<div class="listingblock">
15771577
<div class="content">
15781578
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
1579-
-H 'Authorization: Bearer 904105cb-7a6d-4513-ada1-cc27ab84508e'</code></pre>
1579+
-H 'Authorization: Bearer 3692d91f-2ca5-4eb6-b811-3f468e26a234'</code></pre>
15801580
</div>
15811581
</div>
15821582
</div>
@@ -1598,7 +1598,7 @@ <h4 id="_example_response_3"><a class="anchor" href="#_example_response_3"></a><
15981598
<div class="sect2">
15991599
<h3 id="resources-item-resource-test-get-child-item"><a class="anchor" href="#resources-item-resource-test-get-child-item"></a><a class="link" href="#resources-item-resource-test-get-child-item">2.6. Get Child</a></h3>
16001600
<div class="paragraph">
1601-
<p><code>GET /items/{id}/{child}</code></p>
1601+
<p><code>+GET /items/{id}/{child}+</code></p>
16021602
</div>
16031603
<div class="paragraph">
16041604
<p>Retrieves a child of specified item.</p>
@@ -1845,7 +1845,7 @@ <h4 id="_example_response_4"><a class="anchor" href="#_example_response_4"></a><
18451845
<div class="sect2">
18461846
<h3 id="resources-item-resource-test-search"><a class="anchor" href="#resources-item-resource-test-search"></a><a class="link" href="#resources-item-resource-test-search">2.7. Search Item</a></h3>
18471847
<div class="paragraph">
1848-
<p><code>GET /items/search</code></p>
1848+
<p><code>+GET /items/search+</code></p>
18491849
</div>
18501850
<div class="paragraph">
18511851
<p>Searches for item based on lookup parameters.</p>
@@ -2125,19 +2125,19 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
21252125
"unpaged" : false
21262126
},
21272127
"total" : 1,
2128+
"last" : true,
21282129
"totalPages" : 1,
21292130
"totalElements" : 1,
2130-
"last" : true,
21312131
"size" : 20,
21322132
"number" : 0,
21332133
"numberOfElements" : 1,
2134-
"first" : true,
21352134
"sort" : {
21362135
"orders" : [ ],
21372136
"sorted" : false,
21382137
"unsorted" : true,
21392138
"empty" : true
21402139
},
2140+
"first" : true,
21412141
"empty" : false
21422142
}</code></pre>
21432143
</div>
@@ -2147,7 +2147,7 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
21472147
<div class="sect2">
21482148
<h3 id="resources-item-resource-test-process-all-items"><a class="anchor" href="#resources-item-resource-test-process-all-items"></a><a class="link" href="#resources-item-resource-test-process-all-items">2.8. Process All Items</a></h3>
21492149
<div class="paragraph">
2150-
<p><code>POST /items/process</code></p>
2150+
<p><code>+POST /items/process+</code></p>
21512151
</div>
21522152
<div class="paragraph">
21532153
<p>Executes a command on all items.</p>
@@ -2273,7 +2273,7 @@ <h4 id="_example_response_6"><a class="anchor" href="#_example_response_6"></a><
22732273
<div class="sect2">
22742274
<h3 id="resources-item-resource-test-process-single-item"><a class="anchor" href="#resources-item-resource-test-process-single-item"></a><a class="link" href="#resources-item-resource-test-process-single-item">2.9. Process One Item</a></h3>
22752275
<div class="paragraph">
2276-
<p><code>POST /items/{itemId}/process</code></p>
2276+
<p><code>+POST /items/{itemId}/process+</code></p>
22772277
</div>
22782278
<div class="paragraph">
22792279
<p>Executes a command on an item.<br>
@@ -2434,7 +2434,7 @@ <h4 id="_example_response_7"><a class="anchor" href="#_example_response_7"></a><
24342434
<div class="sect2">
24352435
<h3 id="resources-item-resource-test-validate-metadata"><a class="anchor" href="#resources-item-resource-test-validate-metadata"></a><a class="link" href="#resources-item-resource-test-validate-metadata">2.10. Validate Metadata</a></h3>
24362436
<div class="paragraph">
2437-
<p><code>POST /items/validateMetadata</code></p>
2437+
<p><code>+POST /items/validateMetadata+</code></p>
24382438
</div>
24392439
<div class="paragraph">
24402440
<p>Validates metadata.</p>
@@ -2559,7 +2559,7 @@ <h4 id="_example_response_8"><a class="anchor" href="#_example_response_8"></a><
25592559
<div class="sect2">
25602560
<h3 id="resources-item-resource-test-clone-item"><a class="anchor" href="#resources-item-resource-test-clone-item"></a><a class="link" href="#resources-item-resource-test-clone-item">2.11. Clone Item (deprecated)</a></h3>
25612561
<div class="paragraph">
2562-
<p><code>POST /items/cloneItem</code></p>
2562+
<p><code>+POST /items/cloneItem+</code></p>
25632563
</div>
25642564
<div class="paragraph">
25652565
<p><strong>Deprecated.</strong> Create a new item instead.</p>
@@ -2662,7 +2662,7 @@ <h4 id="_example_response_9"><a class="anchor" href="#_example_response_9"></a><
26622662
<div class="sect2">
26632663
<h3 id="resources-item-resource-test-get-item-as-resource"><a class="anchor" href="#resources-item-resource-test-get-item-as-resource"></a><a class="link" href="#resources-item-resource-test-get-item-as-resource">2.12. Get Hypermedia Item</a></h3>
26642664
<div class="paragraph">
2665-
<p><code>GET /items/media/{id}</code></p>
2665+
<p><code>+GET /items/media/{id}+</code></p>
26662666
</div>
26672667
<div class="paragraph">
26682668
<p>Returns item with hypermedia.</p>
@@ -2922,7 +2922,7 @@ <h2 id="resources-items-get-spring-rest-docs"><a class="anchor" href="#resources
29222922
<div class="sect2">
29232923
<h3 id="resources-item-resource-test-get-item-with-rest-docs"><a class="anchor" href="#resources-item-resource-test-get-item-with-rest-docs"></a><a class="link" href="#resources-item-resource-test-get-item-with-rest-docs">3.1. Get Item</a></h3>
29242924
<div class="paragraph">
2925-
<p><code>GET /items/{id}</code></p>
2925+
<p><code>+GET /items/{id}+</code></p>
29262926
</div>
29272927
<div class="paragraph">
29282928
<p>Returns item by ID.</p>
@@ -3050,7 +3050,7 @@ <h4 id="_example_response_11"><a class="anchor" href="#_example_response_11"></a
30503050
</div>
30513051
<div id="footer">
30523052
<div id="footer-text">
3053-
Last updated 2018-04-10 10:14:19 CEST
3053+
Last updated 2019-05-22 09:13:17 CEST
30543054
</div>
30553055
</div>
30563056
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">

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.3.RELEASE</spring-restdocs.version>
38-
<spring-auto-restdocs.version>2.0.6-SNAPSHOT</spring-auto-restdocs.version>
38+
<spring-auto-restdocs.version>2.0.6</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.21"
4-
springAutoRestDocsVersion = "2.0.6-SNAPSHOT"
4+
springAutoRestDocsVersion = "2.0.6"
55
springRestDocsVersion = "2.0.3.RELEASE"
66
springBootVersion = "2.1.5.RELEASE"
77
dokkaVersion = "0.9.18"

0 commit comments

Comments
 (0)