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

Commit 41a4417

Browse files
jmisurjmisur
authored
bumped version & restored index.html in docs/ and examples (#44)
* bumped version & restored index.html in docs/ and examples * skipped items.html
1 parent acdafb6 commit 41a4417

File tree

11 files changed

+47
-49
lines changed

11 files changed

+47
-49
lines changed

‎docs/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This folder contains `ìndex.html` for github pages.
2+
It's automatically generated from `spring-auto-restdocs-docs`.

spring-auto-restdocs-docs/highlight/LICENSE renamed to docs/highlight/LICENSE

File renamed without changes.

spring-auto-restdocs-docs/highlight/highlight.min.js renamed to docs/highlight/highlight.min.js

File renamed without changes.

spring-auto-restdocs-docs/highlight/styles/github.min.css renamed to docs/highlight/styles/github.min.css

File renamed without changes.

spring-auto-restdocs-docs/index.html renamed to docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ <h3 id="_usage"><a class="link" href="#_usage">Usage</a></h3>
559559
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;dependency&gt;
560560
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
561561
&lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
562-
&lt;version&gt;1.0.3-SNAPSHOT&lt;/version&gt;
562+
&lt;version&gt;1.0.4-SNAPSHOT&lt;/version&gt;
563563
&lt;scope&gt;test&lt;/scope&gt;
564564
&lt;/dependency&gt;</code></pre>
565565
</div>
@@ -588,7 +588,7 @@ <h3 id="_usage"><a class="link" href="#_usage">Usage</a></h3>
588588
&lt;docletArtifact&gt;
589589
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
590590
&lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt;
591-
&lt;version&gt;1.0.3-SNAPSHOT&lt;/version&gt;
591+
&lt;version&gt;1.0.4-SNAPSHOT&lt;/version&gt;
592592
&lt;/docletArtifact&gt;
593593
&lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt;
594594
&lt;reportOutputDirectory&gt;${project.build.directory}&lt;/reportOutputDirectory&gt;
@@ -1131,7 +1131,7 @@ <h4 id="_build"><a class="link" href="#_build">Build</a></h4>
11311131
</div>
11321132
<div id="footer">
11331133
<div id="footer-text">
1134-
Last updated 2016-09-15 12:35:10 CEST
1134+
Last updated 2016-09-15 15:25:01 CEST
11351135
</div>
11361136
</div>
11371137
<link rel="stylesheet" href="highlight/styles/github.min.css">

‎pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>capital.scalable</groupId>
77
<artifactId>spring-auto-restdocs-parent</artifactId>
8-
<version>1.0.3-SNAPSHOT</version>
8+
<version>1.0.4-SNAPSHOT</version>
99
<packaging>pom</packaging>
1010

1111
<name>Spring Auto REST Docs Parent POM</name>

‎spring-auto-restdocs-core/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>capital.scalable</groupId>
99
<artifactId>spring-auto-restdocs-parent</artifactId>
10-
<version>1.0.3-SNAPSHOT</version>
10+
<version>1.0.4-SNAPSHOT</version>
1111
<relativePath>..</relativePath>
1212
</parent>
1313

‎spring-auto-restdocs-docs/pom.xml‎

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>capital.scalable</groupId>
88
<artifactId>spring-auto-restdocs-parent</artifactId>
9-
<version>1.0.3-SNAPSHOT</version>
9+
<version>1.0.4-SNAPSHOT</version>
1010
<relativePath>..</relativePath>
1111
</parent>
1212

@@ -16,6 +16,10 @@
1616
<name>Spring Auto REST Docs Documentation</name>
1717
<description>Documentation for Spring Auto REST Docs</description>
1818

19+
<properties>
20+
<docs.dir>${project.basedir}/../docs</docs.dir>
21+
</properties>
22+
1923
<build>
2024
<plugins>
2125
<plugin>
@@ -38,29 +42,6 @@
3842
<sourceDocumentName>index.adoc</sourceDocumentName>
3943
</configuration>
4044
</plugin>
41-
<plugin>
42-
<artifactId>maven-clean-plugin</artifactId>
43-
<executions>
44-
<execution>
45-
<id>clean-index</id>
46-
<phase>clean</phase>
47-
<goals>
48-
<goal>clean</goal>
49-
</goals>
50-
<configuration>
51-
<filesets>
52-
<fileset>
53-
<directory>${basedir}</directory>
54-
<followSymlinks>false</followSymlinks>
55-
<includes>
56-
<include>index.html</include>
57-
</includes>
58-
</fileset>
59-
</filesets>
60-
</configuration>
61-
</execution>
62-
</executions>
63-
</plugin>
6445
<plugin>
6546
<artifactId>maven-resources-plugin</artifactId>
6647
<executions>
@@ -74,7 +55,7 @@
7455
<outputDirectory>${project.build.directory}/adoc</outputDirectory>
7556
<resources>
7657
<resource>
77-
<directory>${basedir}</directory>
58+
<directory>${project.basedir}</directory>
7859
<filtering>true</filtering>
7960
<includes>
8061
<include>*.adoc</include>
@@ -90,7 +71,7 @@
9071
<goal>copy-resources</goal>
9172
</goals>
9273
<configuration>
93-
<outputDirectory>${basedir}</outputDirectory>
74+
<outputDirectory>${docs.dir}</outputDirectory>
9475
<resources>
9576
<resource>
9677
<directory>${project.build.directory}/generated-docs</directory>

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -977,7 +977,7 @@ <h4 id="_response_structure_3"><a class="anchor" href="#_response_structure_3"><
977977
<h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_response_3"></a>2.3.4. Example request/response</h4>
978978
<div class="listingblock">
979979
<div class="content">
980-
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer 50c845ae-9389-4bb6-be8b-12856a7073ad' -d '{"description":"Hot News"}'</code></pre>
980+
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer b33bb7f7-810c-43f5-ad84-918fff1847e4' -d '{"description":"Hot News"}'</code></pre>
981981
</div>
982982
</div>
983983
<div class="listingblock">
@@ -1141,7 +1141,7 @@ <h4 id="_response_structure_4"><a class="anchor" href="#_response_structure_4"><
11411141
<h4 id="_example_request_response_4"><a class="anchor" href="#_example_request_response_4"></a>2.4.4. Example request/response</h4>
11421142
<div class="listingblock">
11431143
<div class="content">
1144-
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer 50c845ae-9389-4bb6-be8b-12856a7073ad' -d '{"description":"Hot News"}'</code></pre>
1144+
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer b33bb7f7-810c-43f5-ad84-918fff1847e4' -d '{"description":"Hot News"}'</code></pre>
11451145
</div>
11461146
</div>
11471147
<div class="listingblock">
@@ -1193,7 +1193,8 @@ <h4 id="_response_structure_5"><a class="anchor" href="#_response_structure_5"><
11931193
<h4 id="_example_request_response_5"><a class="anchor" href="#_example_request_response_5"></a>2.5.4. Example request/response</h4>
11941194
<div class="listingblock">
11951195
<div class="content">
1196-
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE -H 'Authorization: Bearer 50c845ae-9389-4bb6-be8b-12856a7073ad'</code></pre>
1196+
<pre class="highlightjs highlight"><code class="language-bash"
1197+
data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE -H 'Authorization: Bearer b33bb7f7-810c-43f5-ad84-918fff1847e4'</code></pre>
11971198
</div>
11981199
</div>
11991200
<div class="listingblock">
@@ -1547,7 +1548,7 @@ <h4 id="_response_structure_7"><a class="anchor" href="#_response_structure_7"><
15471548
<h4 id="_example_request_response_7"><a class="anchor" href="#_example_request_response_7"></a>2.7.6. Example request/response</h4>
15481549
<div class="listingblock">
15491550
<div class="content">
1550-
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/search?desc=main&amp;hint=1' -i</code></pre>
1551+
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">$ curl 'http://localhost:8080/items/search?desc=main&amp;hint=1?desc=main&amp;hint=1' -i</code></pre>
15511552
</div>
15521553
</div>
15531554
<div class="listingblock">
@@ -1584,14 +1585,14 @@ <h4 id="_example_request_response_7"><a class="anchor" href="#_example_request_r
15841585
} ],
15851586
"pageable" : null,
15861587
"total" : 1,
1588+
"totalPages" : 1,
15871589
"totalElements" : 1,
15881590
"last" : true,
1589-
"totalPages" : 1,
1591+
"size" : 0,
1592+
"number" : 0,
15901593
"sort" : null,
1591-
"numberOfElements" : 1,
15921594
"first" : true,
1593-
"size" : 0,
1594-
"number" : 0
1595+
"numberOfElements" : 1
15951596
}</code></pre>
15961597
</div>
15971598
</div>
@@ -1602,7 +1603,7 @@ <h4 id="_example_request_response_7"><a class="anchor" href="#_example_request_r
16021603
</div>
16031604
<div id="footer">
16041605
<div id="footer-text">
1605-
Last updated 2016-09-12 22:19:00 CEST
1606+
Last updated 2016-09-14 22:08:18 CEST
16061607
</div>
16071608
</div>
16081609
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css">

‎spring-auto-restdocs-example/pom.xml‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<groupId>capital.scalable</groupId>
1515
<artifactId>spring-auto-restdocs-example</artifactId>
16-
<version>1.0.3-SNAPSHOT</version>
16+
<version>1.0.4-SNAPSHOT</version>
1717

1818
<name>Spring Auto REST Docs Example Project</name>
1919
<description>Example project for Spring Auto REST Docs</description>
@@ -130,20 +130,34 @@
130130
<artifactId>maven-resources-plugin</artifactId>
131131
<executions>
132132
<execution>
133-
<id>copy-resources</id>
133+
<id>copy-index-public</id>
134134
<phase>prepare-package</phase>
135135
<goals>
136136
<goal>copy-resources</goal>
137137
</goals>
138138
<configuration>
139-
<outputDirectory>
140-
${project.build.outputDirectory}/public
141-
</outputDirectory>
139+
<outputDirectory>${project.build.outputDirectory}/public</outputDirectory>
142140
<resources>
143141
<resource>
144-
<directory>
145-
${project.build.directory}/generated-docs
146-
</directory>
142+
<directory>${project.build.directory}/generated-docs</directory>
143+
</resource>
144+
</resources>
145+
</configuration>
146+
</execution>
147+
<execution>
148+
<id>copy-index-generated-docs</id>
149+
<phase>prepare-package</phase>
150+
<goals>
151+
<goal>copy-resources</goal>
152+
</goals>
153+
<configuration>
154+
<outputDirectory>${project.basedir}/generated-docs</outputDirectory>
155+
<resources>
156+
<resource>
157+
<directory>${project.build.directory}/generated-docs</directory>
158+
<includes>
159+
<include>index.html</include>
160+
</includes>
147161
</resource>
148162
</resources>
149163
</configuration>

0 commit comments

Comments
 (0)