Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail

[Current 1.0.14 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.14/docs/index.html) reference guide (based on Spring REST Docs 1.x).

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

Older releases:
[2.0.3](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.3/docs/index.html),
Expand Down
199 changes: 153 additions & 46 deletions docs/index.html

Large diffs are not rendered by default.

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.5-SNAPSHOT</version>
<version>2.0.5</version>
<packaging>pom</packaging>

<name>Spring Auto REST Docs Parent POM</name>
Expand Down
69 changes: 45 additions & 24 deletions samples/java-webflux/generated-docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -553,14 +553,20 @@ <h4 id="_response_fields"><a class="anchor" href="#_response_fields"></a><a clas
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">meta.tag</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Tag attribute. Available only if metadata type=1.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=1)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Tag attribute. (Available if metadata type=1).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">meta.order</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Order attribute. Available only if metadata type=2.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=2)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Order attribute. (Available if metadata type=2).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">meta.sub</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=2)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sub metadata (recursive). Not expanded as client should not see it. (Available if metadata type=2).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">attributes</p></td>
Expand Down Expand Up @@ -644,13 +650,14 @@ <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 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 459
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Referrer-Policy: no-referrer
Content-Length: 459
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

{
Expand Down Expand Up @@ -758,14 +765,20 @@ <h4 id="_response_fields_2"><a class="anchor" href="#_response_fields_2"></a><a
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].meta.tag</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Tag attribute. Available only if metadata type=1.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=1)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Tag attribute. (Available if metadata type=1).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].meta.order</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Order attribute. Available only if metadata type=2.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=2)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Order attribute. (Available if metadata type=2).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].meta.sub</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=2)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sub metadata (recursive). Not expanded as client should not see it. (Available if metadata type=2).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">[].attributes</p></td>
Expand Down Expand Up @@ -849,12 +862,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
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block
Content-Length: 598

Expand Down Expand Up @@ -1026,14 +1040,20 @@ <h4 id="_response_fields_3"><a class="anchor" href="#_response_fields_3"></a><a
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">meta.tag</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Tag attribute. Available only if metadata type=1.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=1)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Tag attribute. (Available if metadata type=1).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">meta.order</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Order attribute. Available only if metadata type=2.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=2)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Order attribute. (Available if metadata type=2).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">meta.sub</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true (Available if metadata type=2)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sub metadata (recursive). Not expanded as client should not see it. (Available if metadata type=2).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">attributes</p></td>
Expand Down Expand Up @@ -1119,14 +1139,15 @@ <h4 id="_example_response_3"><a class="anchor" href="#_example_response_3"></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
Content-Length: 124
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block
Content-Length: 124

{
"id" : "1",
Expand All @@ -1145,7 +1166,7 @@ <h4 id="_example_response_3"><a class="anchor" href="#_example_response_3"></a><
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-03-17 20:16:57 CET
Last updated 2019-03-25 20:17:39 CET
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
Expand Down
2 changes: 1 addition & 1 deletion samples/java-webflux/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<start-class>capital.scalable.restdocs.example.Application</start-class>
<spring-restdocs.version>2.0.3.RELEASE</spring-restdocs.version>
<spring-auto-restdocs.version>2.0.5-SNAPSHOT</spring-auto-restdocs.version>
<spring-auto-restdocs.version>2.0.5</spring-auto-restdocs.version>
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion samples/java-webmvc/build.gradle
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
buildscript {
ext {
springAutoRestDocsVersion = "2.0.5-SNAPSHOT"
springAutoRestDocsVersion = "2.0.5"
springRestDocsVersion = "2.0.3.RELEASE"
springBootVersion = "2.1.3.RELEASE"
}
Expand Down
Loading