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

Commit

Permalink
2.0.0 Release (#212)
Browse files Browse the repository at this point in the history
* 2.0.0 Release

* List both 1.x and 2.x as current releases

* Fix link to 1.0.12 documentation
  • Loading branch information
fbenz authored Mar 23, 2018
1 parent f180334 commit 1415215
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 36 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail

## Documentation

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

Latest master [1.0.12-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
[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).

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

Older releases:
[1.0.11](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.11/docs/index.html),
[1.0.10](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.10/docs/index.html),
[1.0.9](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.9/docs/index.html),
[1.0.8](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.8/docs/index.html),
Expand All @@ -43,7 +46,7 @@ Older releases:
[path](https://scacap.github.io/spring-auto-restdocs/#snippets-path-parameters),
[query parameters](https://scacap.github.io/spring-auto-restdocs/#snippets-request-parameters) and
[request headers](https://scacap.github.io/spring-auto-restdocs/#snippets-request-headers)
using Jackson and Javadoc
using Jackson and Javadoc/KDoc
* Automatic documentation of field and parameter
[optionality](https://scacap.github.io/spring-auto-restdocs/#constraints-optionality) and
[constraints](https://scacap.github.io/spring-auto-restdocs/#constraints) using JSR 303 annotations
Expand Down
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@
<h1>Spring Auto REST Docs</h1>
<div class="details">
<span id="author" class="author">Scalable Capital</span><br>
<span id="revnumber">version 2.0.0-SNAPSHOT</span>
<span id="revnumber">version 2.0.0</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
Expand Down Expand Up @@ -602,7 +602,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
&lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
&lt;version&gt;1.0.11&lt;/version&gt;
&lt;version&gt;2.0.0&lt;/version&gt;
&lt;scope&gt;test&lt;/scope&gt; <i class="conum" data-value="1"></i><b>(1)</b>
&lt;/dependency&gt;

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

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

task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
Expand Down Expand Up @@ -1848,8 +1848,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
</div>
<div id="footer">
<div id="footer-text">
Version 2.0.0-SNAPSHOT<br>
Last updated 2018-01-20 10:15:37 CET
Version 2.0.0<br>
Last updated 2018-03-23 14:31:47 CET
</div>
</div>
<link rel="stylesheet" href="highlight/styles/github.min.css">
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
<version>2.0.0</version>
<packaging>pom</packaging>

<name>Spring Auto REST Docs Parent POM</name>
Expand Down
2 changes: 1 addition & 1 deletion spring-auto-restdocs-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
<version>2.0.0</version>
<relativePath>..</relativePath>
</parent>

Expand Down
4 changes: 2 additions & 2 deletions spring-auto-restdocs-docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
<version>2.0.0</version>
<relativePath>..</relativePath>
</parent>

Expand All @@ -18,7 +18,7 @@

<properties>
<docs.dir>${project.basedir}/../docs</docs.dir>
<latestRelease>1.0.11</latestRelease> <!-- change this when releasing 1.0.12-SNAPSHOT -->
<latestRelease>2.0.0</latestRelease> <!-- change this when releasing 2.0.1-SNAPSHOT -->
</properties>

<build>
Expand Down
2 changes: 1 addition & 1 deletion spring-auto-restdocs-dokka-json/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-parent</artifactId>
<version>1.0.12-SNAPSHOT</version>
<version>2.0.0</version>
<relativePath>..</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion spring-auto-restdocs-example/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ apply plugin: "io.spring.dependency-management"
apply plugin: "org.asciidoctor.convert"

group = "capital.scalable"
version = "2.0.0-SNAPSHOT"
version = "2.0.0"

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

Expand Down
34 changes: 17 additions & 17 deletions spring-auto-restdocs-example/generated-docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -810,13 +810,13 @@ <h4 id="_example_request_response"><a class="anchor" href="#_example_request_res
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 459

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

[ {
Expand Down Expand Up @@ -1129,7 +1129,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 hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921' \
-H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d' \
-d '{"description":"Hot News"}'</code></pre>
</div>
</div>
Expand All @@ -1139,13 +1139,13 @@ <h4 id="_example_response"><a class="anchor" href="#_example_response"></a><a cl
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 201 Created
Location: /items/2
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: /items/2</code></pre>
X-Frame-Options: DENY</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -1366,7 +1366,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 hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921' \
-H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d' \
-d '{"description":"Hot News"}'</code></pre>
</div>
</div>
Expand All @@ -1376,13 +1376,13 @@ <h4 id="_example_response_2"><a class="anchor" href="#_example_response_2"></a><
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 124

{
Expand Down Expand Up @@ -1472,7 +1472,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 hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921'</code></pre>
-H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d'</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -1691,13 +1691,13 @@ <h4 id="_example_response_4"><a class="anchor" href="#_example_response_4"></a><
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 133

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

{
Expand Down Expand Up @@ -1968,16 +1968,16 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
"unpaged" : false
},
"total" : 1,
"last" : true,
"totalPages" : 1,
"last" : true,
"totalElements" : 1,
"first" : true,
"sort" : {
"orders" : [ ],
"sorted" : false,
"unsorted" : true
},
"numberOfElements" : 1,
"first" : true,
"size" : 20,
"number" : 0
}</code></pre>
Expand Down Expand Up @@ -2083,14 +2083,14 @@ <h4 id="_example_response_6"><a class="anchor" href="#_example_response_6"></a><
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: text/plain;charset=UTF-8
Content-Length: 28
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: text/plain;charset=UTF-8
Content-Length: 28

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

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

{
Expand Down Expand Up @@ -2554,7 +2554,7 @@ <h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_r
</div>
<div id="footer">
<div id="footer-text">
Last updated 2018-01-16 08:44:06 CET
Last updated 2018-01-30 18:01:20 CET
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
Expand Down
4 changes: 2 additions & 2 deletions spring-auto-restdocs-example/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

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

<name>Spring Auto REST Docs Example Project</name>
<description>Example project for Spring Auto REST Docs</description>
Expand All @@ -36,7 +36,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<start-class>capital.scalable.restdocs.example.Application</start-class>
<spring-restdocs.version>2.0.0.RELEASE</spring-restdocs.version>
<spring-auto-restdocs.version>2.0.0-SNAPSHOT</spring-auto-restdocs.version>
<spring-auto-restdocs.version>2.0.0</spring-auto-restdocs.version>
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion spring-auto-restdocs-json-doclet/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
<version>2.0.0</version>
<relativePath>..</relativePath>
</parent>

Expand Down

0 comments on commit 1415215

Please sign in to comment.