Skip to content

Commit c82b67d

Browse files
committed
Update for 2.0.0-M2
1 parent 4c9eb8b commit c82b67d

File tree

8 files changed

+33
-20
lines changed

8 files changed

+33
-20
lines changed

docs/faq.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1355,6 +1355,9 @@ <h3 id="_how_can_i_extract_fields_from_parameter_object">How can I extract field
13551355
<li>
13561356
<p>This annotation does not support nested parameter objects.</p>
13571357
</li>
1358+
<li>
1359+
<p>POJO object must contain getters for fields with mandatory prefix <code>get</code>. Otherwise, the swagger documentation will not show the fields of the annotated entity.</p>
1360+
</li>
13581361
</ul>
13591362
</div>
13601363
</div>
@@ -1795,7 +1798,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
17951798
</div>
17961799
<div id="footer">
17971800
<div id="footer-text">
1798-
Last updated 2022-02-27 16:18:35 +0100
1801+
Last updated 2022-04-08 19:19:25 +0200
17991802
</div>
18001803
</div>
18011804
<script src="js/highlight/highlight.min.js"></script>

docs/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3446,6 +3446,9 @@ <h3 id="how-can-i-extract-fields-from-parameter-object"><a class="anchor" href="
34463446
<li>
34473447
<p>This annotation does not support nested parameter objects.</p>
34483448
</li>
3449+
<li>
3450+
<p>POJO object must contain getters for fields with mandatory prefix <code>get</code>. Otherwise, the swagger documentation will not show the fields of the annotated entity.</p>
3451+
</li>
34493452
</ul>
34503453
</div>
34513454
</div>

docs/v2/faq.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1346,6 +1346,9 @@ <h3 id="_how_can_i_extract_fields_from_parameter_object">How can I extract field
13461346
<li>
13471347
<p>This annotation does not support nested parameter objects.</p>
13481348
</li>
1349+
<li>
1350+
<p>POJO object must contain getters for fields with mandatory prefix <code>get</code>. Otherwise, the swagger documentation will not show the fields of the annotated entity.</p>
1351+
</li>
13491352
</ul>
13501353
</div>
13511354
</div>
@@ -1635,7 +1638,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
16351638
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
16361639
</div>
16371640
<div class="paragraph">
1638-
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-M1.</strong></p>
1641+
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-M2.</strong></p>
16391642
</div>
16401643
<div class="paragraph">
16411644
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -1652,7 +1655,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
16521655
</tr>
16531656
<tr>
16541657
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
1655-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-M1</code>+</p></td>
1658+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-M2</code>+</p></td>
16561659
</tr>
16571660
<tr>
16581661
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.6.x</code>, <code>1.5.x</code></p></td>
@@ -1686,7 +1689,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
16861689
</div>
16871690
<div id="footer">
16881691
<div id="footer-text">
1689-
Last updated 2022-02-27 16:18:10 +0100
1692+
Last updated 2022-04-08 19:20:55 +0200
16901693
</div>
16911694
</div>
16921695
<script src="js/highlight/highlight.min.js"></script>

docs/v2/getting-started.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h2 id="getting-started">Getting Started</h2>
3030
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
3131
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
3232
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
33-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
33+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
3434
&lt;/dependency&gt;</code></pre>
3535
</div>
3636
</div>
@@ -86,7 +86,7 @@ <h2 id="getting-started">Getting Started</h2>
8686
</div>
8787
<div id="footer">
8888
<div id="footer-text">
89-
Last updated 2022-02-06 00:25:12 +0100
89+
Last updated 2022-04-07 20:33:32 +0200
9090
</div>
9191
</div>
9292
<script src="js/highlight/highlight.min.js"></script>

docs/v2/index.html

Lines changed: 12 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-M1</title>
9+
<title>springdoc-openapi v2.0.0-M2</title>
1010
<link rel="stylesheet" href="css/spring.css">
1111
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
1212
<link rel="stylesheet" href="js/highlight/styles/github.min.css">
@@ -18,7 +18,7 @@
1818
</head>
1919
<body class="book toc2 toc-left">
2020
<div id="header">
21-
<h1>springdoc-openapi v2.0.0-M1</h1>
21+
<h1>springdoc-openapi v2.0.0-M2</h1>
2222
<div class="details">
2323
<span id="author" class="author">Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN</span><br>
2424
</div>
@@ -230,7 +230,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
230230
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
231231
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
232232
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
233-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
233+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
234234
&lt;/dependency&gt;</code></pre>
235235
</div>
236236
</div>
@@ -327,7 +327,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
327327
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
328328
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
329329
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
330-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
330+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
331331
&lt;/dependency&gt;</code></pre>
332332
</div>
333333
</div>
@@ -379,7 +379,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
379379
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
380380
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
381381
&lt;artifactId&gt;springdoc-openapi-starter-webflux-ui&lt;/artifactId&gt;
382-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
382+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
383383
&lt;/dependency&gt;</code></pre>
384384
</div>
385385
</div>
@@ -1746,7 +1746,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
17461746
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
17471747
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
17481748
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
1749-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
1749+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
17501750
&lt;/dependency&gt;</code></pre>
17511751
</div>
17521752
</div>
@@ -3317,6 +3317,9 @@ <h3 id="how-can-i-extract-fields-from-parameter-object"><a class="anchor" href="
33173317
<li>
33183318
<p>This annotation does not support nested parameter objects.</p>
33193319
</li>
3320+
<li>
3321+
<p>POJO object must contain getters for fields with mandatory prefix <code>get</code>. Otherwise, the swagger documentation will not show the fields of the annotated entity.</p>
3322+
</li>
33203323
</ul>
33213324
</div>
33223325
</div>
@@ -3606,7 +3609,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
36063609
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
36073610
</div>
36083611
<div class="paragraph">
3609-
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-M1.</strong></p>
3612+
<p>In general, <strong>you should only pick the last stable version as per today 2.0.0-M2.</strong></p>
36103613
</div>
36113614
<div class="paragraph">
36123615
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -3623,7 +3626,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
36233626
</tr>
36243627
<tr>
36253628
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3.0.x</code></p></td>
3626-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-M1</code>+</p></td>
3629+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.0.0-M2</code>+</p></td>
36273630
</tr>
36283631
<tr>
36293632
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2.6.x</code>, <code>1.5.x</code></p></td>
@@ -3657,7 +3660,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
36573660
</div>
36583661
<div id="footer">
36593662
<div id="footer-text">
3660-
Last updated 2022-02-06 00:25:12 +0100
3663+
Last updated 2022-04-07 20:33:47 +0200
36613664
</div>
36623665
</div>
36633666
<script src="js/highlight/highlight.min.js"></script>

docs/v2/migrating-from-springfox.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ <h2 id="migrating-from-springfox">Migrating from SpringFox</h2>
3434
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
3535
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
3636
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
37-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
37+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
3838
&lt;/dependency&gt;</code></pre>
3939
</div>
4040
</div>
@@ -204,7 +204,7 @@ <h2 id="migrating-from-springfox">Migrating from SpringFox</h2>
204204
</div>
205205
<div id="footer">
206206
<div id="footer-text">
207-
Last updated 2022-02-06 00:25:12 +0100
207+
Last updated 2022-04-07 20:33:32 +0200
208208
</div>
209209
</div>
210210
<script src="js/highlight/highlight.min.js"></script>

docs/v2/modules.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h3 id="_spring_webmvc_support">Spring WebMvc support</h3>
6363
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
6464
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
6565
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
66-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
66+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
6767
&lt;/dependency&gt;</code></pre>
6868
</div>
6969
</div>
@@ -115,7 +115,7 @@ <h3 id="_spring_webflux_support">Spring WebFlux support</h3>
115115
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
116116
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
117117
&lt;artifactId&gt;springdoc-openapi-starter-webflux-ui&lt;/artifactId&gt;
118-
&lt;version&gt;2.0.0-M1&lt;/version&gt;
118+
&lt;version&gt;2.0.0-M2&lt;/version&gt;
119119
&lt;/dependency&gt;</code></pre>
120120
</div>
121121
</div>
@@ -493,7 +493,7 @@ <h3 id="_javadoc_support">Javadoc support</h3>
493493
</div>
494494
<div id="footer">
495495
<div id="footer-text">
496-
Last updated 2022-02-06 00:25:12 +0100
496+
Last updated 2022-04-07 20:33:32 +0200
497497
</div>
498498
</div>
499499
<script src="js/highlight/highlight.min.js"></script>

src/docs/asciidoc/v2/faq.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -626,6 +626,7 @@ springdoc.group-configs[0].packages-to-scan=test.org.springdoc.api
626626
* Request parameter annotated with @ParameterObject will help adding each field of the parameter as a separate request parameter.
627627
* This is compatible with Spring MVC request parameters mapping to POJO object.
628628
* This annotation does not support nested parameter objects.
629+
* POJO object must contain getters for fields with mandatory prefix `get`. Otherwise, the swagger documentation will not show the fields of the annotated entity.
629630

630631
=== How can I use the last `springdoc-openapi` SNAPSHOT ?
631632
* For testing purposes only, you can test temporarily using the last `springdoc-openapi` SNAPSHOT

0 commit comments

Comments
 (0)