2.0.1 Release (#223)

ScaCap · Mar 29, 2018 · e64b58b · e64b58b
1 parent 499de90
commit e64b58b
Show file tree

Hide file tree

Showing 12 changed files with 153 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -22,13 +22,15 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail
 
 ## Documentation
 
-[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).
+[Current 2.0.1 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.1/docs/index.html) reference guide (based on Spring REST Docs 2.x).
 
-[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).
+[Current 1.0.13 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.13/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.
+Latest master [2.0.2-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
 
-Older releases: 
+Older releases:
+[2.0.0](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.0/docs/index.html),
+[1.0.12](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.12/docs/index.html),
 [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),

diff --git a/docs/index.html b/docs/index.html
@@ -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.1-SNAPSHOT</span>
+<span id="revnumber">version 2.0.1</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -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;2.0.0&lt;/version&gt;
+    &lt;version&gt;2.0.1&lt;/version&gt;
     &lt;scope&gt;test&lt;/scope&gt; <i class="conum" data-value="1"></i><b>(1)</b>
 &lt;/dependency&gt;
 
@@ -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;2.0.0&lt;/version&gt;
+                            &lt;version&gt;2.0.1&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>
@@ -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: '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'
+    testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.1' <i class="conum" data-value="1"></i><b>(1)</b>
+    jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.1'
 }
 
 task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1235,6 +1235,18 @@ <h4 id="_configuration_4"><a class="link" href="#_configuration_4">Configuration
 </div>
 <div class="sect2">
 <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snippet</a></h3>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+Section snippets only work if AsciiDoc is used. Markdown is not supported, because Markdown has no includes.
+</td>
+</tr>
+</table>
+</div>
 <div class="paragraph">
 <p>The section snippet combines most common snippets into one convenient file.
 It helps you being even more lazy, because a single line of AsciiDoc is sufficient to document one endpoint.
@@ -1252,14 +1264,14 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
 <pre class="highlightjs highlight"><code class="language-asciidoc hljs" data-lang="asciidoc">[[resources-{{link}}]]
 === {{title}}
 
-include::{snippets}/{{path}}/auto-method-path.adoc[]
+include::auto-method-path.adoc[]
 
-include::{snippets}/{{path}}/auto-description.adoc[]
+include::auto-description.adoc[]
 {{#sections}}
 
 ==== {{header}}
 
-include::{snippets}/{{path}}/{{fileName}}.adoc[]
+include::{{fileName}}.adoc[]
 {{/sections}}</code></pre>
 </div>
 </div>
@@ -1848,8 +1860,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 2.0.1-SNAPSHOT<br>
-Last updated 2018-03-23 17:48:09 CET
+Version 2.0.1<br>
+Last updated 2018-03-29 11:56:38 CEST
 </div>
 </div>
 <link rel="stylesheet" href="highlight/styles/github.min.css">

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-parent</artifactId>
-    <version>2.0.1-SNAPSHOT</version>
+    <version>2.0.1</version>
     <packaging>pom</packaging>
 
     <name>Spring Auto REST Docs Parent POM</name>

diff --git a/samples/java-webmvc/build.gradle b/samples/java-webmvc/build.gradle
@@ -18,7 +18,7 @@ apply plugin: "io.spring.dependency-management"
 apply plugin: "org.asciidoctor.convert"
 
 group = "capital.scalable"
-version = "2.0.1-SNAPSHOT"
+version = "2.0.1"
 
 description = """Spring Auto REST Docs Example Project"""
 

diff --git a/samples/java-webmvc/generated-docs/index.html b/samples/java-webmvc/generated-docs/index.html
@@ -5,7 +5,7 @@
 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 1.5.6.1">
-<title>Example API Documentation</title>
+<title>Java Web MVC Example API Documentation</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
@@ -427,7 +427,7 @@
 </head>
 <body class="book toc2 toc-right">
 <div id="header">
-<h1>Example API Documentation</h1>
+<h1>Java Web MVC Example API Documentation</h1>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel0">
@@ -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 e9f9040c-925f-482b-8bf6-3601a1693407' \
+    -H 'Authorization: Bearer 23d918a4-653f-4e61-9b46-b5e72fd2ba7c' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -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 e9f9040c-925f-482b-8bf6-3601a1693407' \
+    -H 'Authorization: Bearer 23d918a4-653f-4e61-9b46-b5e72fd2ba7c' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -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 e9f9040c-925f-482b-8bf6-3601a1693407'</code></pre>
+    -H 'Authorization: Bearer 23d918a4-653f-4e61-9b46-b5e72fd2ba7c'</code></pre>
 </div>
 </div>
 </div>
@@ -1961,25 +1961,25 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
       "sorted" : false,
       "unsorted" : true
     },
+    "offset" : 0,
     "pageSize" : 20,
     "pageNumber" : 0,
-    "offset" : 0,
     "paged" : true,
     "unpaged" : false
   },
   "total" : 1,
-  "last" : true,
-  "totalPages" : 1,
   "totalElements" : 1,
-  "first" : true,
+  "totalPages" : 1,
+  "last" : true,
+  "size" : 20,
+  "number" : 0,
+  "numberOfElements" : 1,
   "sort" : {
     "orders" : [ ],
     "sorted" : false,
     "unsorted" : true
   },
-  "numberOfElements" : 1,
-  "size" : 20,
-  "number" : 0
+  "first" : true
 }</code></pre>
 </div>
 </div>
@@ -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-03-29 11:51:15 CEST
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">

diff --git a/samples/java-webmvc/pom.xml b/samples/java-webmvc/pom.xml
@@ -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.1-SNAPSHOT</spring-auto-restdocs.version>
+        <spring-auto-restdocs.version>2.0.1</spring-auto-restdocs.version>
     </properties>
 
     <dependencies>