diff --git a/README.md b/README.md index 352c20fd..30d4cca9 100644 --- a/README.md +++ b/README.md @@ -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), @@ -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 diff --git a/docs/index.html b/docs/index.html index c109619d..7b211e11 100644 --- a/docs/index.html +++ b/docs/index.html @@ -432,7 +432,7 @@

Spring Auto REST Docs

Scalable Capital
-version 2.0.0-SNAPSHOT +version 2.0.0
Table of Contents
@@ -602,7 +602,7 @@

Usage 
<dependency>
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-core</artifactId>
-    <version>1.0.11</version>
+    <version>2.0.0</version>
     <scope>test</scope> (1)
 </dependency>
 
@@ -639,7 +639,7 @@ 
Usage
                         <docletArtifact>
                             <groupId>capital.scalable</groupId>
                             <artifactId>spring-auto-restdocs-json-doclet</artifactId>
-                            <version>1.0.11</version>
+                            <version>2.0.0</version>
                         </docletArtifact>
                         <destDir>generated-javadoc-json</destDir> (3)
                         <reportOutputDirectory>${project.build.directory}</reportOutputDirectory> (3)
@@ -684,8 +684,8 @@ 
Usage
 }
 
 dependencies {
-    testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '1.0.11' (1)
-    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' (1)
+    jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.0'
 }
 
 task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1848,8 +1848,8 @@ 

 

-Version 2.0.0-SNAPSHOT

-Last updated 2018-01-20 10:15:37 CET
+Version 2.0.0

+Last updated 2018-03-23 14:31:47 CET

diff --git a/pom.xml b/pom.xml index 756c162e..8f64e509 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.0-SNAPSHOT + 2.0.0 pom Spring Auto REST Docs Parent POM diff --git a/spring-auto-restdocs-core/pom.xml b/spring-auto-restdocs-core/pom.xml index 49d87225..af5fb427 100644 --- a/spring-auto-restdocs-core/pom.xml +++ b/spring-auto-restdocs-core/pom.xml @@ -7,7 +7,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.0-SNAPSHOT + 2.0.0 .. diff --git a/spring-auto-restdocs-docs/pom.xml b/spring-auto-restdocs-docs/pom.xml index 7ae1c6ef..ea62c735 100644 --- a/spring-auto-restdocs-docs/pom.xml +++ b/spring-auto-restdocs-docs/pom.xml @@ -6,7 +6,7 @@ capital.scalable spring-auto-restdocs-parent - 2.0.0-SNAPSHOT + 2.0.0 .. @@ -18,7 +18,7 @@ ${project.basedir}/../docs - 1.0.11 + 2.0.0 diff --git a/spring-auto-restdocs-dokka-json/pom.xml b/spring-auto-restdocs-dokka-json/pom.xml index 8ef3404f..b2716766 100644 --- a/spring-auto-restdocs-dokka-json/pom.xml +++ b/spring-auto-restdocs-dokka-json/pom.xml @@ -5,7 +5,7 @@ capital.scalable spring-auto-restdocs-parent - 1.0.12-SNAPSHOT + 2.0.0 .. diff --git a/spring-auto-restdocs-example/build.gradle b/spring-auto-restdocs-example/build.gradle index b3fb64c2..48e7987e 100644 --- a/spring-auto-restdocs-example/build.gradle +++ b/spring-auto-restdocs-example/build.gradle @@ -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""" diff --git a/spring-auto-restdocs-example/generated-docs/index.html b/spring-auto-restdocs-example/generated-docs/index.html index 0d26f7d1..26bb6f55 100644 --- a/spring-auto-restdocs-example/generated-docs/index.html +++ b/spring-auto-restdocs-example/generated-docs/index.html @@ -810,13 +810,13 @@ 

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
 
 {
@@ -1003,13 +1003,13 @@ 

 

 
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
 
 [ {
@@ -1129,7 +1129,7 @@ 

 
$ 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"}'
@@ -1139,13 +1139,13 @@ 

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
+X-Frame-Options: DENY
@@ -1366,7 +1366,7 @@ 

$ 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"}'
@@ -1376,13 +1376,13 @@

< 
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
 
 {
@@ -1472,7 +1472,7 @@ 

 

 
$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-    -H 'Authorization: Bearer 9519f971-ce91-4298-959f-7ed6bf379921'

+    -H 'Authorization: Bearer 7c73f031-9208-46ed-ba75-9af975a05c2d'
@@ -1691,13 +1691,13 @@

< 
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
 
 {
@@ -1918,13 +1918,13 @@ 
<
 

 

 
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
 
 {
@@ -1968,16 +1968,16 @@ 
<
     "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
 }

@@ -2083,14 +2083,14 @@ 
<
 

 

 
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"
@@ -2232,13 +2232,13 @@ 
<
 

 

 
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
 
 {
@@ -2511,13 +2511,13 @@ 

 

 
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
 
 {
@@ -2554,7 +2554,7 @@ 

 

-Last updated 2018-01-16 08:44:06 CET
+Last updated 2018-01-30 18:01:20 CET
 

 

 
diff --git a/spring-auto-restdocs-example/pom.xml b/spring-auto-restdocs-example/pom.xml
index d871a961..56984d2c 100644
--- a/spring-auto-restdocs-example/pom.xml
+++ b/spring-auto-restdocs-example/pom.xml
@@ -13,7 +13,7 @@
 
     capital.scalable
     spring-auto-restdocs-example
-    2.0.0-SNAPSHOT 
+    2.0.0 
 
     Spring Auto REST Docs Example Project
     Example project for Spring Auto REST Docs
@@ -36,7 +36,7 @@
         UTF-8
         capital.scalable.restdocs.example.Application
         2.0.0.RELEASE
-        2.0.0-SNAPSHOT
+        2.0.0
     
 
     
diff --git a/spring-auto-restdocs-json-doclet/pom.xml b/spring-auto-restdocs-json-doclet/pom.xml
index 3d941a53..52353e32 100644
--- a/spring-auto-restdocs-json-doclet/pom.xml
+++ b/spring-auto-restdocs-json-doclet/pom.xml
@@ -5,7 +5,7 @@
     
         capital.scalable
         spring-auto-restdocs-parent
-        2.0.0-SNAPSHOT
+        2.0.0
         ..