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

Commit ddc78c7

Browse files
authored
mentioned snapshot in docs (#164)
* mentioned snapshot in docs * docs regen
1 parent d36be87 commit ddc78c7

File tree

3 files changed

+77
-9
lines changed

3 files changed

+77
-9
lines changed

docs/index.html

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,7 @@ <h1>Spring Auto REST Docs</h1>
434434
<ul class="sectlevel2">
435435
<li><a href="#gettingstarted-requirements">Requirements</a></li>
436436
<li><a href="#gettingstarted-usage">Usage</a></li>
437+
<li><a href="#gettingstarted-snapshot">Snapshot build</a></li>
437438
<li><a href="#gettingstarted-sample">Sample application</a></li>
438439
</ul>
439440
</li>
@@ -764,6 +765,40 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
764765
</div>
765766
</div>
766767
<div class="sect2">
768+
<h3 id="gettingstarted-snapshot"><a class="link" href="#gettingstarted-snapshot">Snapshot build</a></h3>
769+
<div class="paragraph">
770+
<p>If you want to experiment with snapshot builds, add this repository:</p>
771+
</div>
772+
<div class="listingblock">
773+
<div class="title">Maven</div>
774+
<div class="content">
775+
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;repositories&gt;
776+
&lt;repository&gt;
777+
&lt;id&gt;sonatype-snapshots&lt;/id&gt;
778+
&lt;url&gt;https://oss.sonatype.org/content/repositories/snapshots&lt;/url&gt;
779+
&lt;releases&gt;
780+
&lt;enabled&gt;false&lt;/enabled&gt;
781+
&lt;/releases&gt;
782+
&lt;snapshots&gt;
783+
&lt;enabled&gt;true&lt;/enabled&gt;
784+
&lt;/snapshots&gt;
785+
&lt;/repository&gt;
786+
&lt;/repositories&gt;</code></pre>
787+
</div>
788+
</div>
789+
<div class="listingblock">
790+
<div class="title">Gradle</div>
791+
<div class="content">
792+
<pre class="highlightjs highlight"><code class="language-javascript" data-lang="javascript">repositories {
793+
mavenCentral()
794+
maven {
795+
url "https://oss.sonatype.org/content/repositories/snapshots"
796+
}
797+
}</code></pre>
798+
</div>
799+
</div>
800+
</div>
801+
<div class="sect2">
767802
<h3 id="gettingstarted-sample"><a class="link" href="#gettingstarted-sample">Sample application</a></h3>
768803
<div class="paragraph">
769804
<p><a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/spring-auto-restdocs-example">This project</a>
@@ -1659,7 +1694,7 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
16591694
</div>
16601695
<div id="footer">
16611696
<div id="footer-text">
1662-
Last updated 2017-11-02 10:44:00 CET
1697+
Last updated 2017-11-02 11:56:48 CET
16631698
</div>
16641699
</div>
16651700
<link rel="stylesheet" href="highlight/styles/github.min.css">

spring-auto-restdocs-docs/getting-started.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,39 @@ public void setUp() throws Exception {
172172
}
173173
----
174174

175+
[[gettingstarted-snapshot]]
176+
=== Snapshot build
177+
178+
If you want to experiment with snapshot builds, add this repository:
179+
180+
[source,xml]
181+
.Maven
182+
----
183+
<repositories>
184+
<repository>
185+
<id>sonatype-snapshots</id>
186+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
187+
<releases>
188+
<enabled>false</enabled>
189+
</releases>
190+
<snapshots>
191+
<enabled>true</enabled>
192+
</snapshots>
193+
</repository>
194+
</repositories>
195+
----
196+
197+
[source,javascript]
198+
.Gradle
199+
----
200+
repositories {
201+
mavenCentral()
202+
maven {
203+
url "https://oss.sonatype.org/content/repositories/snapshots"
204+
}
205+
}
206+
----
207+
175208
[[gettingstarted-sample]]
176209
=== Sample application
177210

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1117,7 +1117,7 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
11171117
<div class="content">
11181118
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
11191119
-H 'Content-Type: application/json' \
1120-
-H 'Authorization: Bearer f6c4621b-bf20-4c4c-9d69-6710a70b0a3b' \
1120+
-H 'Authorization: Bearer 4a42db4d-2c0a-4c01-b48d-17a8b5d31624' \
11211121
-d '{"description":"Hot News"}'</code></pre>
11221122
</div>
11231123
</div>
@@ -1352,7 +1352,7 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
13521352
<div class="content">
13531353
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
13541354
-H 'Content-Type: application/json' \
1355-
-H 'Authorization: Bearer f6c4621b-bf20-4c4c-9d69-6710a70b0a3b' \
1355+
-H 'Authorization: Bearer 4a42db4d-2c0a-4c01-b48d-17a8b5d31624' \
13561356
-d '{"description":"Hot News"}'</code></pre>
13571357
</div>
13581358
</div>
@@ -1455,7 +1455,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
14551455
<div class="listingblock">
14561456
<div class="content">
14571457
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
1458-
-H 'Authorization: Bearer f6c4621b-bf20-4c4c-9d69-6710a70b0a3b'</code></pre>
1458+
-H 'Authorization: Bearer 4a42db4d-2c0a-4c01-b48d-17a8b5d31624'</code></pre>
14591459
</div>
14601460
</div>
14611461
</div>
@@ -1935,14 +1935,14 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
19351935
"pageSize" : 20
19361936
},
19371937
"total" : 1,
1938-
"totalElements" : 1,
1939-
"totalPages" : 1,
19401938
"last" : true,
1939+
"totalPages" : 1,
1940+
"totalElements" : 1,
19411941
"size" : 20,
19421942
"number" : 0,
1943-
"numberOfElements" : 1,
1943+
"sort" : null,
19441944
"first" : true,
1945-
"sort" : null
1945+
"numberOfElements" : 1
19461946
}</code></pre>
19471947
</div>
19481948
</div>
@@ -2406,7 +2406,7 @@ <h4 id="_example_response_9"><a class="anchor" href="#_example_response_9"></a><
24062406
</div>
24072407
<div id="footer">
24082408
<div id="footer-text">
2409-
Last updated 2017-11-02 10:03:56 CET
2409+
Last updated 2017-11-02 11:03:07 CET
24102410
</div>
24112411
</div>
24122412
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css">

0 commit comments

Comments
 (0)