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

Commit 1415215

Browse files
fbenzfbenz
authored
2.0.0 Release (#212)
* 2.0.0 Release * List both 1.x and 2.x as current releases * Fix link to 1.0.12 documentation
1 parent f180334 commit 1415215

File tree

10 files changed

+39
-36
lines changed

10 files changed

+39
-36
lines changed

‎README.md‎

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

2323
## Documentation
2424

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

27-
Latest master [1.0.12-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
27+
[Current 1.0.12 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.12/docs/index.html) reference guide (based on Spring REST Docs 1.x).
28+
29+
Latest master [2.0.1-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
2830

2931
Older releases:
32+
[1.0.11](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.11/docs/index.html),
3033
[1.0.10](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.10/docs/index.html),
3134
[1.0.9](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.9/docs/index.html),
3235
[1.0.8](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.8/docs/index.html),
@@ -43,7 +46,7 @@ Older releases:
4346
[path](https://scacap.github.io/spring-auto-restdocs/#snippets-path-parameters),
4447
[query parameters](https://scacap.github.io/spring-auto-restdocs/#snippets-request-parameters) and
4548
[request headers](https://scacap.github.io/spring-auto-restdocs/#snippets-request-headers)
46-
using Jackson and Javadoc
49+
using Jackson and Javadoc/KDoc
4750
* Automatic documentation of field and parameter
4851
[optionality](https://scacap.github.io/spring-auto-restdocs/#constraints-optionality) and
4952
[constraints](https://scacap.github.io/spring-auto-restdocs/#constraints) using JSR 303 annotations

‎docs/index.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@
432432
<h1>Spring Auto REST Docs</h1>
433433
<div class="details">
434434
<span id="author" class="author">Scalable Capital</span><br>
435-
<span id="revnumber">version 2.0.0-SNAPSHOT</span>
435+
<span id="revnumber">version 2.0.0</span>
436436
</div>
437437
<div id="toc" class="toc2">
438438
<div id="toctitle">Table of Contents</div>
@@ -602,7 +602,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
602602
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
603603
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
604604
&lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
605-
&lt;version&gt;1.0.11&lt;/version&gt;
605+
&lt;version&gt;2.0.0&lt;/version&gt;
606606
&lt;scope&gt;test&lt;/scope&gt; <i class="conum" data-value="1"></i><b>(1)</b>
607607
&lt;/dependency&gt;
608608

@@ -639,7 +639,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
639639
&lt;docletArtifact&gt;
640640
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
641641
&lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt;
642-
&lt;version&gt;1.0.11&lt;/version&gt;
642+
&lt;version&gt;2.0.0&lt;/version&gt;
643643
&lt;/docletArtifact&gt;
644644
&lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt; <i class="conum" data-value="3"></i><b>(3)</b>
645645
&lt;reportOutputDirectory&gt;${project.build.directory}&lt;/reportOutputDirectory&gt; <i class="conum" data-value="3"></i><b>(3)</b>
@@ -684,8 +684,8 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
684684
}
685685

686686
dependencies {
687-
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '1.0.11' <i class="conum" data-value="1"></i><b>(1)</b>
688-
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '1.0.11'
687+
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.0' <i class="conum" data-value="1"></i><b>(1)</b>
688+
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.0'
689689
}
690690

691691
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1848,8 +1848,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
18481848
</div>
18491849
<div id="footer">
18501850
<div id="footer-text">
1851-
Version 2.0.0-SNAPSHOT<br>
1852-
Last updated 2018-01-20 10:15:37 CET
1851+
Version 2.0.0<br>
1852+
Last updated 2018-03-23 14:31:47 CET
18531853
</div>
18541854
</div>
18551855
<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.0-SNAPSHOT</version>
8+
<version>2.0.0</version>
99
<packaging>pom</packaging>
1010

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

‎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.0-SNAPSHOT</version>
10+
<version>2.0.0</version>
1111
<relativePath>..</relativePath>
1212
</parent>
1313

‎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.0-SNAPSHOT</version>
9+
<version>2.0.0</version>
1010
<relativePath>..</relativePath>
1111
</parent>
1212

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

1919
<properties>
2020
<docs.dir>${project.basedir}/../docs</docs.dir>
21-
<latestRelease>1.0.11</latestRelease> <!-- change this when releasing 1.0.12-SNAPSHOT -->
21+
<latestRelease>2.0.0</latestRelease> <!-- change this when releasing 2.0.1-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>1.0.12-SNAPSHOT</version>
8+
<version>2.0.0</version>
99
<relativePath>..</relativePath>
1010
</parent>
1111

‎spring-auto-restdocs-example/build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ apply plugin: "io.spring.dependency-management"
1818
apply plugin: "org.asciidoctor.convert"
1919

2020
group = "capital.scalable"
21-
version = "2.0.0-SNAPSHOT"
21+
version = "2.0.0"
2222

2323
description = """Spring Auto REST Docs Example Project"""
2424

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -810,13 +810,13 @@ <h4 id="_example_request_response"><a class="anchor" href="#_example_request_res
810810
<div class="listingblock">
811811
<div class="content">
812812
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
813+
Content-Type: application/json;charset=UTF-8
813814
X-Content-Type-Options: nosniff
814815
X-XSS-Protection: 1; mode=block
815816
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
816817
Pragma: no-cache
817818
Expires: 0
818819
X-Frame-Options: DENY
819-
Content-Type: application/json;charset=UTF-8
820820
Content-Length: 459
821821

822822
{
@@ -1003,13 +1003,13 @@ <h4 id="_example_request_response_2"><a class="anchor" href="#_example_request_r
10031003
<div class="listingblock">
10041004
<div class="content">
10051005
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
1006+
Content-Type: application/json;charset=UTF-8
10061007
X-Content-Type-Options: nosniff
10071008
X-XSS-Protection: 1; mode=block
10081009
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
10091010
Pragma: no-cache
10101011
Expires: 0
10111012
X-Frame-Options: DENY
1012-
Content-Type: application/json;charset=UTF-8
10131013
Content-Length: 598
10141014

10151015
[ {
@@ -1129,7 +1129,7 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
11291129
<div class="content">
11301130
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
11311131
-H 'Content-Type: application/json' \
1132-
-H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921' \
1132+
-H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d' \
11331133
-d '{"description":"Hot News"}'</code></pre>
11341134
</div>
11351135
</div>
@@ -1139,13 +1139,13 @@ <h4 id="_example_response"><a class="anchor" href="#_example_response"></a><a cl
11391139
<div class="listingblock">
11401140
<div class="content">
11411141
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 201 Created
1142+
Location: /items/2
11421143
X-Content-Type-Options: nosniff
11431144
X-XSS-Protection: 1; mode=block
11441145
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
11451146
Pragma: no-cache
11461147
Expires: 0
1147-
X-Frame-Options: DENY
1148-
Location: /items/2</code></pre>
1148+
X-Frame-Options: DENY</code></pre>
11491149
</div>
11501150
</div>
11511151
</div>
@@ -1366,7 +1366,7 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
13661366
<div class="content">
13671367
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
13681368
-H 'Content-Type: application/json' \
1369-
-H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921' \
1369+
-H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d' \
13701370
-d '{"description":"Hot News"}'</code></pre>
13711371
</div>
13721372
</div>
@@ -1376,13 +1376,13 @@ <h4 id="_example_response_2"><a class="anchor" href="#_example_response_2"></a><
13761376
<div class="listingblock">
13771377
<div class="content">
13781378
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
1379+
Content-Type: application/json;charset=UTF-8
13791380
X-Content-Type-Options: nosniff
13801381
X-XSS-Protection: 1; mode=block
13811382
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
13821383
Pragma: no-cache
13831384
Expires: 0
13841385
X-Frame-Options: DENY
1385-
Content-Type: application/json;charset=UTF-8
13861386
Content-Length: 124
13871387

13881388
{
@@ -1472,7 +1472,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
14721472
<div class="listingblock">
14731473
<div class="content">
14741474
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
1475-
-H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921'</code></pre>
1475+
-H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d'</code></pre>
14761476
</div>
14771477
</div>
14781478
</div>
@@ -1691,13 +1691,13 @@ <h4 id="_example_response_4"><a class="anchor" href="#_example_response_4"></a><
16911691
<div class="listingblock">
16921692
<div class="content">
16931693
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
1694+
Content-Type: application/json;charset=UTF-8
16941695
X-Content-Type-Options: nosniff
16951696
X-XSS-Protection: 1; mode=block
16961697
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
16971698
Pragma: no-cache
16981699
Expires: 0
16991700
X-Frame-Options: DENY
1700-
Content-Type: application/json;charset=UTF-8
17011701
Content-Length: 133
17021702

17031703
{
@@ -1918,13 +1918,13 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
19181918
<div class="listingblock">
19191919
<div class="content">
19201920
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
1921+
Content-Type: application/json;charset=UTF-8
19211922
X-Content-Type-Options: nosniff
19221923
X-XSS-Protection: 1; mode=block
19231924
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
19241925
Pragma: no-cache
19251926
Expires: 0
19261927
X-Frame-Options: DENY
1927-
Content-Type: application/json;charset=UTF-8
19281928
Content-Length: 1011
19291929

19301930
{
@@ -1968,16 +1968,16 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
19681968
"unpaged" : false
19691969
},
19701970
"total" : 1,
1971-
"last" : true,
19721971
"totalPages" : 1,
1972+
"last" : true,
19731973
"totalElements" : 1,
1974+
"first" : true,
19741975
"sort" : {
19751976
"orders" : [ ],
19761977
"sorted" : false,
19771978
"unsorted" : true
19781979
},
19791980
"numberOfElements" : 1,
1980-
"first" : true,
19811981
"size" : 20,
19821982
"number" : 0
19831983
}</code></pre>
@@ -2083,14 +2083,14 @@ <h4 id="_example_response_6"><a class="anchor" href="#_example_response_6"></a><
20832083
<div class="listingblock">
20842084
<div class="content">
20852085
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
2086+
Content-Type: text/plain;charset=UTF-8
2087+
Content-Length: 28
20862088
X-Content-Type-Options: nosniff
20872089
X-XSS-Protection: 1; mode=block
20882090
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
20892091
Pragma: no-cache
20902092
Expires: 0
20912093
X-Frame-Options: DENY
2092-
Content-Type: text/plain;charset=UTF-8
2093-
Content-Length: 28
20942094

20952095
{
20962096
"output" : "processed"
@@ -2232,13 +2232,13 @@ <h4 id="_example_response_7"><a class="anchor" href="#_example_response_7"></a><
22322232
<div class="listingblock">
22332233
<div class="content">
22342234
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
2235+
Content-Type: application/json;charset=UTF-8
22352236
X-Content-Type-Options: nosniff
22362237
X-XSS-Protection: 1; mode=block
22372238
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
22382239
Pragma: no-cache
22392240
Expires: 0
22402241
X-Frame-Options: DENY
2241-
Content-Type: application/json;charset=UTF-8
22422242
Content-Length: 55
22432243

22442244
{
@@ -2511,13 +2511,13 @@ <h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_r
25112511
<div class="listingblock">
25122512
<div class="content">
25132513
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
2514+
Content-Type: application/json;charset=UTF-8
25142515
X-Content-Type-Options: nosniff
25152516
X-XSS-Protection: 1; mode=block
25162517
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
25172518
Pragma: no-cache
25182519
Expires: 0
25192520
X-Frame-Options: DENY
2520-
Content-Type: application/json;charset=UTF-8
25212521
Content-Length: 459
25222522

25232523
{
@@ -2554,7 +2554,7 @@ <h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_r
25542554
</div>
25552555
<div id="footer">
25562556
<div id="footer-text">
2557-
Last updated 2018-01-16 08:44:06 CET
2557+
Last updated 2018-01-30 18:01:20 CET
25582558
</div>
25592559
</div>
25602560
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<groupId>capital.scalable</groupId>
1515
<artifactId>spring-auto-restdocs-example</artifactId>
16-
<version>2.0.0-SNAPSHOT</version> <!-- not related to spring-auto-restdocs version -->
16+
<version>2.0.0</version> <!-- not related to spring-auto-restdocs version -->
1717

1818
<name>Spring Auto REST Docs Example Project</name>
1919
<description>Example project for Spring Auto REST Docs</description>
@@ -36,7 +36,7 @@
3636
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3737
<start-class>capital.scalable.restdocs.example.Application</start-class>
3838
<spring-restdocs.version>2.0.0.RELEASE</spring-restdocs.version>
39-
<spring-auto-restdocs.version>2.0.0-SNAPSHOT</spring-auto-restdocs.version>
39+
<spring-auto-restdocs.version>2.0.0</spring-auto-restdocs.version>
4040
</properties>
4141

4242
<dependencies>

‎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.0-SNAPSHOT</version>
8+
<version>2.0.0</version>
99
<relativePath>..</relativePath>
1010
</parent>
1111

0 commit comments

Comments
 (0)