Skip to content

Commit 3c3c7fa

Browse files
bnasslahsenbnasslahsen
committed
doc update
1 parent fdd8544 commit 3c3c7fa

12 files changed

+56
-100
lines changed

‎docs/sitemap.xml

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,63 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!--
3-
~ /*
4-
~ *
5-
~ * *
6-
~ * * * Copyright 2019-2022 the original author or authors.
7-
~ * * *
8-
~ * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
~ * * * you may not use this file except in compliance with the License.
10-
~ * * * You may obtain a copy of the License at
11-
~ * * *
12-
~ * * * https://www.apache.org/licenses/LICENSE-2.0
13-
~ * * *
14-
~ * * * Unless required by applicable law or agreed to in writing, software
15-
~ * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
~ * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
~ * * * See the License for the specific language governing permissions and
18-
~ * * * limitations under the License.
19-
~ * *
20-
~ *
21-
~ */
22-
-->
23-
242
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
253
<url>
264
<loc>https://springdoc.org/</loc>
27-
<lastmod>2022-05-04</lastmod>
5+
<lastmod>2022-10-23</lastmod>
286
</url>
297
<url>
308
<loc>https://springdoc.org/index.html</loc>
31-
<lastmod>2022-05-04</lastmod>
9+
<lastmod>2022-10-23</lastmod>
3210
</url>
3311
<url>
3412
<loc>https://springdoc.org/core-properties.html</loc>
35-
<lastmod>2022-05-04</lastmod>
13+
<lastmod>2022-10-23</lastmod>
3614
</url>
3715
<url>
3816
<loc>https://springdoc.org/demos.html</loc>
39-
<lastmod>2022-05-04</lastmod>
17+
<lastmod>2022-10-23</lastmod>
4018
</url>
4119
<url>
4220
<loc>https://springdoc.org/faq.html</loc>
43-
<lastmod>2022-05-04</lastmod>
21+
<lastmod>2022-10-23</lastmod>
4422
</url>
4523
<url>
4624
<loc>https://springdoc.org/features.html</loc>
47-
<lastmod>2022-05-04</lastmod>
25+
<lastmod>2022-10-23</lastmod>
4826
</url>
4927
<url>
5028
<loc>https://springdoc.org/getting-started.html</loc>
51-
<lastmod>2022-05-04</lastmod>
29+
<lastmod>2022-10-23</lastmod>
5230
</url>
5331
<url>
5432
<loc>https://springdoc.org/intro.html</loc>
55-
<lastmod>2022-05-04</lastmod>
33+
<lastmod>2022-10-23</lastmod>
5634
</url>
5735
<url>
5836
<loc>https://springdoc.org/migrating-from-springfox.html</loc>
59-
<lastmod>2022-05-04</lastmod>
37+
<lastmod>2022-10-23</lastmod>
6038
</url>
6139
<url>
6240
<loc>https://springdoc.org/modules.html</loc>
63-
<lastmod>2022-05-04</lastmod>
41+
<lastmod>2022-10-23</lastmod>
6442
</url>
6543
<url>
6644
<loc>https://springdoc.org/other-resources.html</loc>
67-
<lastmod>2022-05-04</lastmod>
45+
<lastmod>2022-10-23</lastmod>
6846
</url>
6947
<url>
7048
<loc>https://springdoc.org/plugins.html</loc>
71-
<lastmod>2022-05-04</lastmod>
49+
<lastmod>2022-10-23</lastmod>
7250
</url>
7351
<url>
7452
<loc>https://springdoc.org/properties.html</loc>
75-
<lastmod>2022-05-04</lastmod>
53+
<lastmod>2022-10-23</lastmod>
7654
</url>
7755
<url>
7856
<loc>https://springdoc.org/ui-properties.html</loc>
79-
<lastmod>2022-05-04</lastmod>
57+
<lastmod>2022-10-23</lastmod>
8058
</url>
8159
<url>
8260
<loc>https://springdoc.org/thanks.html</loc>
83-
<lastmod>2022-05-04</lastmod>
61+
<lastmod>2022-10-23</lastmod>
8462
</url>
8563
</urlset>

‎docs/v2/faq.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1801,7 +1801,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18011801
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
18021802
</div>
18031803
<div class="paragraph">
1804-
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-M7.</strong></p>
1804+
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-RC1.</strong></p>
18051805
</div>
18061806
<div class="paragraph">
18071807
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -1818,7 +1818,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18181818
</tr>
18191819
<tr>
18201820
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
1821-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-M7</code>+</p></td>
1821+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-RC1</code>+</p></td>
18221822
</tr>
18231823
<tr>
18241824
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.7.x</code>, <code>1.5.x</code></p></td>
@@ -1856,7 +1856,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18561856
</div>
18571857
<div id="footer">
18581858
<div id="footer-text">
1859-
Last updated 2022-10-17 01:33:34 +0200
1859+
Last updated 2022-10-23 13:41:20 +0200
18601860
</div>
18611861
</div>
18621862
</div>

‎docs/v2/getting-started.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
4040
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
4141
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
4242
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
43-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
43+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
4444
&lt;/dependency&gt;</code></pre>
4545
</div>
4646
</div>
@@ -96,7 +96,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
9696
</div>
9797
<div id="footer">
9898
<div id="footer-text">
99-
Last updated 2022-10-17 01:33:34 +0200
99+
Last updated 2022-10-23 13:41:20 +0200
100100
</div>
101101
</div>
102102
</div>

‎docs/v2/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="generator" content="Asciidoctor 2.0.15">
88
<meta name="author" content="Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN">
9-
<title>springdoc-openapi v2.0.0-M7</title>
9+
<title>springdoc-openapi v2.0.0-RC1</title>
1010
<link rel="stylesheet" href="css/site.css">
1111
<style>
1212
#header #revnumber {
@@ -33,7 +33,7 @@
3333
<div id="main" class="contained">
3434
<div id="doc" class="doc">
3535
<div id="header">
36-
<h1>springdoc-openapi v2.0.0-M7</h1>
36+
<h1>springdoc-openapi v2.0.0-RC1</h1>
3737
<div class="details">
3838
<span id="author" class="author">Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN</span><br>
3939
</div>
@@ -293,7 +293,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
293293
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
294294
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
295295
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
296-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
296+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
297297
&lt;/dependency&gt;</code></pre>
298298
</div>
299299
</div>
@@ -402,7 +402,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
402402
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
403403
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
404404
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
405-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
405+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
406406
&lt;/dependency&gt;</code></pre>
407407
</div>
408408
</div>
@@ -454,7 +454,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
454454
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
455455
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
456456
&lt;artifactId&gt;springdoc-openapi-starter-webflux-ui&lt;/artifactId&gt;
457-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
457+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
458458
&lt;/dependency&gt;</code></pre>
459459
</div>
460460
</div>
@@ -1911,7 +1911,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
19111911
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
19121912
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
19131913
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
1914-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
1914+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
19151915
&lt;/dependency&gt;</code></pre>
19161916
</div>
19171917
</div>
@@ -4066,7 +4066,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
40664066
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
40674067
</div>
40684068
<div class="paragraph">
4069-
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-M7.</strong></p>
4069+
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-RC1.</strong></p>
40704070
</div>
40714071
<div class="paragraph">
40724072
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -4083,7 +4083,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
40834083
</tr>
40844084
<tr>
40854085
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
4086-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-M7</code>+</p></td>
4086+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-RC1</code>+</p></td>
40874087
</tr>
40884088
<tr>
40894089
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.7.x</code>, <code>1.5.x</code></p></td>
@@ -4133,7 +4133,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
41334133
</div>
41344134
<div id="footer">
41354135
<div id="footer-text">
4136-
Last updated 2022-10-17 01:33:34 +0200
4136+
Last updated 2022-10-23 13:41:20 +0200
41374137
</div>
41384138
</div>
41394139

‎docs/v2/migrating-from-springfox.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
4444
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
4545
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
4646
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
47-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
47+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
4848
&lt;/dependency&gt;</code></pre>
4949
</div>
5050
</div>
@@ -217,7 +217,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
217217
</div>
218218
<div id="footer">
219219
<div id="footer-text">
220-
Last updated 2022-10-17 01:33:34 +0200
220+
Last updated 2022-10-23 13:41:20 +0200
221221
</div>
222222
</div>
223223
</div>

‎docs/v2/modules.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h3 id="_spring_webmvc_support"><a class="anchor" href="#_spring_webmvc_support"
7373
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
7474
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
7575
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
76-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
76+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
7777
&lt;/dependency&gt;</code></pre>
7878
</div>
7979
</div>
@@ -125,7 +125,7 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
125125
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
126126
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
127127
&lt;artifactId&gt;springdoc-openapi-starter-webflux-ui&lt;/artifactId&gt;
128-
&lt;version&gt;2.0.0-M7&lt;/version&gt;
128+
&lt;version&gt;2.0.0-RC1&lt;/version&gt;
129129
&lt;/dependency&gt;</code></pre>
130130
</div>
131131
</div>
@@ -508,7 +508,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
508508
</div>
509509
<div id="footer">
510510
<div id="footer-text">
511-
Last updated 2022-10-17 01:33:34 +0200
511+
Last updated 2022-10-23 13:41:20 +0200
512512
</div>
513513
</div>
514514
</div>

‎src/docs/asciidoc/sitemap.xml

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,63 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!--
3-
~ /*
4-
~ *
5-
~ * *
6-
~ * * * Copyright 2019-2022 the original author or authors.
7-
~ * * *
8-
~ * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
~ * * * you may not use this file except in compliance with the License.
10-
~ * * * You may obtain a copy of the License at
11-
~ * * *
12-
~ * * * https://www.apache.org/licenses/LICENSE-2.0
13-
~ * * *
14-
~ * * * Unless required by applicable law or agreed to in writing, software
15-
~ * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
~ * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
~ * * * See the License for the specific language governing permissions and
18-
~ * * * limitations under the License.
19-
~ * *
20-
~ *
21-
~ */
22-
-->
23-
242
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
253
<url>
264
<loc>https://springdoc.org/</loc>
27-
<lastmod>2022-05-04</lastmod>
5+
<lastmod>2022-10-23</lastmod>
286
</url>
297
<url>
308
<loc>https://springdoc.org/index.html</loc>
31-
<lastmod>2022-05-04</lastmod>
9+
<lastmod>2022-10-23</lastmod>
3210
</url>
3311
<url>
3412
<loc>https://springdoc.org/core-properties.html</loc>
35-
<lastmod>2022-05-04</lastmod>
13+
<lastmod>2022-10-23</lastmod>
3614
</url>
3715
<url>
3816
<loc>https://springdoc.org/demos.html</loc>
39-
<lastmod>2022-05-04</lastmod>
17+
<lastmod>2022-10-23</lastmod>
4018
</url>
4119
<url>
4220
<loc>https://springdoc.org/faq.html</loc>
43-
<lastmod>2022-05-04</lastmod>
21+
<lastmod>2022-10-23</lastmod>
4422
</url>
4523
<url>
4624
<loc>https://springdoc.org/features.html</loc>
47-
<lastmod>2022-05-04</lastmod>
25+
<lastmod>2022-10-23</lastmod>
4826
</url>
4927
<url>
5028
<loc>https://springdoc.org/getting-started.html</loc>
51-
<lastmod>2022-05-04</lastmod>
29+
<lastmod>2022-10-23</lastmod>
5230
</url>
5331
<url>
5432
<loc>https://springdoc.org/intro.html</loc>
55-
<lastmod>2022-05-04</lastmod>
33+
<lastmod>2022-10-23</lastmod>
5634
</url>
5735
<url>
5836
<loc>https://springdoc.org/migrating-from-springfox.html</loc>
59-
<lastmod>2022-05-04</lastmod>
37+
<lastmod>2022-10-23</lastmod>
6038
</url>
6139
<url>
6240
<loc>https://springdoc.org/modules.html</loc>
63-
<lastmod>2022-05-04</lastmod>
41+
<lastmod>2022-10-23</lastmod>
6442
</url>
6543
<url>
6644
<loc>https://springdoc.org/other-resources.html</loc>
67-
<lastmod>2022-05-04</lastmod>
45+
<lastmod>2022-10-23</lastmod>
6846
</url>
6947
<url>
7048
<loc>https://springdoc.org/plugins.html</loc>
71-
<lastmod>2022-05-04</lastmod>
49+
<lastmod>2022-10-23</lastmod>
7250
</url>
7351
<url>
7452
<loc>https://springdoc.org/properties.html</loc>
75-
<lastmod>2022-05-04</lastmod>
53+
<lastmod>2022-10-23</lastmod>
7654
</url>
7755
<url>
7856
<loc>https://springdoc.org/ui-properties.html</loc>
79-
<lastmod>2022-05-04</lastmod>
57+
<lastmod>2022-10-23</lastmod>
8058
</url>
8159
<url>
8260
<loc>https://springdoc.org/thanks.html</loc>
83-
<lastmod>2022-05-04</lastmod>
61+
<lastmod>2022-10-23</lastmod>
8462
</url>
8563
</urlset>

‎src/docs/asciidoc/v2/faq.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -918,13 +918,13 @@ image::img/static_content_transformation.png[Illustrative example]
918918
=== What is the compatibility matrix of `springdoc-openapi` with `spring-boot` ?
919919
`springdoc-openapi 2.x` is compatible with `spring-boot 3`.
920920

921-
In general, **you should only pick the last stable version as per today 2.0.0-M7.**
921+
In general, **you should only pick the last stable version as per today 2.0.0-RC1.**
922922

923923
More precisely, this the exhaustive list of spring-boot versions against which `springdoc-openapi` has been built:
924924

925925
|===
926926
| spring-boot Versions | Minimum springdoc-openapi Versions
927-
|`3.0.x` | `2.0.0-M7`+
927+
|`3.0.x` | `2.0.0-RC1`+
928928
|`2.7.x`, `1.5.x` | `1.6.0`+
929929
|`2.6.x`, `1.5.x` | `1.6.0`+
930930
|`2.5.x`, `1.5.x` | `1.5.9`+

‎src/docs/asciidoc/v2/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For the integration between spring-boot and swagger-ui, add the library to the l
88
<dependency>
99
<groupId>org.springdoc</groupId>
1010
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
11-
<version>2.0.0-M7</version>
11+
<version>2.0.0-RC1</version>
1212
</dependency>
1313
----
1414

0 commit comments

Comments
 (0)