Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@bnasslahsen
bnasslahsen committed Mar 12, 2024
1 parent 2ec2da9 commit 5cbd233
Show file tree
Hide file tree
Showing 18 changed files with 4,190 additions and 4,063 deletions.
14 changes: 12 additions & 2 deletions docs/core-properties.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-kotlin</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable Kotlin support.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolproperty resolver on @Schema (extensionean</code>. To enable Kotlin support.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-hateoas</p></td>
Expand Down Expand Up @@ -303,12 +303,22 @@
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security oauth2-endpoint visible.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.api-docs.resolve-extensions-properties</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<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>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-default-api-docs</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<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>
</tr>
</tbody>
</table>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-07-29 16:28:18 +0200
Last updated 2024-03-02 21:34:06 +0100
</div>
</div>
</div>
Expand Down
26 changes: 24 additions & 2 deletions docs/faq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1020,6 +1020,9 @@ <h3 id="_can_i_use_spring_property_with_swagger_annotations"><a class="anchor" h
<li>
<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>
</li>
<li>
<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>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -1846,7 +1849,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
</div>
<div class="paragraph">
<p>In general, <strong>you should only pick the last stable version as per today 2.3.0.</strong></p>
<p>In general, <strong>you should only pick the last stable version as per today 2.4.0.</strong></p>
</div>
<div class="paragraph">
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
Expand Down Expand Up @@ -1923,12 +1926,31 @@ <h3 id="_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_o
</table>
</div>
</div>
<div class="sect2">
<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>
<div class="paragraph">
<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>
in particular for the <strong>Parameter Name Discovery</strong>.
This can be fixed by adding the <code>-parameters</code> arg to the Maven Compiler Plugin.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-xml" data-lang="xml">&lt;plugin&gt;
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
&lt;artifactId&gt;maven-compiler-plugin&lt;/artifactId&gt;
&lt;configuration&gt;
&lt;parameters&gt;true&lt;/parameters&gt;
&lt;/configuration&gt;
&lt;/plugin&gt;</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-07-31 10:41:23 +0200
Last updated 2024-02-28 22:28:18 +0100
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
&lt;version&gt;2.3.0&lt;/version&gt;
&lt;version&gt;2.4.0&lt;/version&gt;
&lt;/dependency&gt;</code></pre>
</div>
</div>
Expand Down
Loading

0 comments on commit 5cbd233

Please sign in to comment.