Skip to content

Commit 5cbd233

Browse files
committed
docs update
1 parent 2ec2da9 commit 5cbd233

18 files changed

+4190
-4063
lines changed

Diff for: docs/core-properties.html

+12-2
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@
266266
<tr>
267267
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-kotlin</p></td>
268268
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
269-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable Kotlin support.</p></td>
269+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolproperty resolver on @Schema (extensionean</code>. To enable Kotlin support.</p></td>
270270
</tr>
271271
<tr>
272272
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-hateoas</p></td>
@@ -303,12 +303,22 @@
303303
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
304304
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security oauth2-endpoint visible.</p></td>
305305
</tr>
306+
<tr>
307+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.api-docs.resolve-extensions-properties</p></td>
308+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
309+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable support of spring property resolver for <code>@ExtensionProperty</code>.</p></td>
310+
</tr>
311+
<tr>
312+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-default-api-docs</p></td>
313+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
314+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable default OpenAPI endpoint <code>/v3/api-docs</code>.</p></td>
315+
</tr>
306316
</tbody>
307317
</table>
308318
</div>
309319
<div id="footer">
310320
<div id="footer-text">
311-
Last updated 2023-07-29 16:28:18 +0200
321+
Last updated 2024-03-02 21:34:06 +0100
312322
</div>
313323
</div>
314324
</div>

Diff for: docs/faq.html

+24-2
Original file line numberDiff line numberDiff line change
@@ -1020,6 +1020,9 @@ <h3 id="_can_i_use_spring_property_with_swagger_annotations"><a class="anchor" h
10201020
<li>
10211021
<p>The support of spring property resolver for <code>@Schema</code>: <code>name</code> * <code>title</code> * <code>description</code> , by setting <code>springdoc.api-docs.resolve-schema-properties</code> to <code>true</code></p>
10221022
</li>
1023+
<li>
1024+
<p>The support of spring property resolver for <code>@ExtensionProperty</code> by setting <code>springdoc.api-docs.resolve-extensions-properties</code> to <code>true</code></p>
1025+
</li>
10231026
</ul>
10241027
</div>
10251028
</div>
@@ -1846,7 +1849,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18461849
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
18471850
</div>
18481851
<div class="paragraph">
1849-
<p>In general, <strong>you should only pick the last stable version as per today 2.3.0.</strong></p>
1852+
<p>In general, <strong>you should only pick the last stable version as per today 2.4.0.</strong></p>
18501853
</div>
18511854
<div class="paragraph">
18521855
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -1923,12 +1926,31 @@ <h3 id="_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_o
19231926
</table>
19241927
</div>
19251928
</div>
1929+
<div class="sect2">
1930+
<h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a class="anchor" href="#_some_parameters_are_not_generated_in_the_resulting_openapi_spec"></a>Some parameters are not generated in the resulting OpenAPI spec.</h3>
1931+
<div class="paragraph">
1932+
<p>The issue is caused by the changes introduced by <a href="https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.2-Release-Notes" target="_blank" rel="noopener">Spring-Boot 3.2.0</a>
1933+
in particular for the <strong>Parameter Name Discovery</strong>.
1934+
This can be fixed by adding the <code>-parameters</code> arg to the Maven Compiler Plugin.</p>
1935+
</div>
1936+
<div class="listingblock">
1937+
<div class="content">
1938+
<pre class="highlight"><code class="language-xml" data-lang="xml">&lt;plugin&gt;
1939+
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
1940+
&lt;artifactId&gt;maven-compiler-plugin&lt;/artifactId&gt;
1941+
&lt;configuration&gt;
1942+
&lt;parameters&gt;true&lt;/parameters&gt;
1943+
&lt;/configuration&gt;
1944+
&lt;/plugin&gt;</code></pre>
1945+
</div>
1946+
</div>
1947+
</div>
19261948
</div>
19271949
</div>
19281950
</div>
19291951
<div id="footer">
19301952
<div id="footer-text">
1931-
Last updated 2023-07-31 10:41:23 +0200
1953+
Last updated 2024-02-28 22:28:18 +0100
19321954
</div>
19331955
</div>
19341956
</div>

Diff for: docs/getting-started.html

+1-1
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.3.0&lt;/version&gt;
43+
&lt;version&gt;2.4.0&lt;/version&gt;
4444
&lt;/dependency&gt;</code></pre>
4545
</div>
4646
</div>

0 commit comments

Comments
 (0)