Skip to content

Commit adc34f8

Browse files
bnasslahsenbnasslahsen
committed
docs update
1 parent 2077c7d commit adc34f8

10 files changed

+242
-160
lines changed

‎docs/core-properties.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,11 @@
229229
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Pre-loading setting to load OpenAPI on application startup.</p></td>
230230
</tr>
231231
<tr>
232+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.pre-loading-locales</p></td>
233+
<td class="tableblock halign-left valign-top"></td>
234+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of locales to load OpenAPI on application startup.(comma separated) If not specified, it will preload with the default Locale.</p></td>
235+
</tr>
236+
<tr>
232237
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.writer-with-order-by-keys</p></td>
233238
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
234239
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Enable a deterministic/alphabetical ordering.</p></td>
@@ -303,7 +308,7 @@
303308
</div>
304309
<div id="footer">
305310
<div id="footer-text">
306-
Last updated 2023-04-02 00:44:12 +0200
311+
Last updated 2023-07-29 16:28:18 +0200
307312
</div>
308313
</div>
309314
</div>

‎docs/faq.html

+20-1
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,7 @@ <h3 id="_how_can_i_set_swagger_properties_programmatically"><a class="anchor" hr
300300
<div class="content">
301301
<pre class="highlight"><code class="language-kotlin" data-lang="kotlin">---
302302
@Bean
303+
@Primary
303304
fun swaggerUiConfig(config: SwaggerUiConfigProperties): SwaggerUiConfigProperties {
304305
config.showCommonExtensions = true
305306
config.queryConfigEnabled = true
@@ -1303,6 +1304,7 @@ <h3 id="_what_is_a_proper_way_to_set_up_swagger_ui_to_use_provided_spec_yml"><a
13031304
SpringDocConfiguration springDocConfiguration(){
13041305
return new SpringDocConfiguration();
13051306
}
1307+
13061308
@Bean
13071309
SpringDocConfigProperties springDocConfigProperties() {
13081310
return new SpringDocConfigProperties();
@@ -1312,6 +1314,11 @@ <h3 id="_what_is_a_proper_way_to_set_up_swagger_ui_to_use_provided_spec_yml"><a
13121314
ObjectMapperProvider objectMapperProvider(SpringDocConfigProperties springDocConfigProperties){
13131315
return new ObjectMapperProvider(springDocConfigProperties);
13141316
}
1317+
1318+
@Bean
1319+
SpringDocsUIConfiguration springDocsUiConfiguration(Optional&lt;SwaggerUiConfigProperties&gt; optionalSwaggerUiConfigProperties){
1320+
return new SpringDocsUIConfiguration(optionalSwaggerUiConfigProperties);
1321+
}
13151322
</code></pre>
13161323
</div>
13171324
</div>
@@ -1820,6 +1827,18 @@ <h3 id="_is_graalvm_supported"><a class="anchor" href="#_is_graalvm_supported"><
18201827
<div class="paragraph">
18211828
<p>For the OpenAPI REST endpoints, you just need to build your application with the spring <code>native</code> profile.</p>
18221829
</div>
1830+
<div class="paragraph">
1831+
<p>If you give <code>@OpenAPIDefinition</code> or <code>@SecurityScheme</code> to a class that has no implementation, that class will disappear when you natively compile.
1832+
To avoid this, give the class a <code>@Configuration</code>.</p>
1833+
</div>
1834+
<div class="listingblock">
1835+
<div class="content">
1836+
<pre>@Configuration
1837+
@OpenAPIDefinition(info = @Info(title = "My App", description = "description"))
1838+
public class OpenAPIConfig {
1839+
}</pre>
1840+
</div>
1841+
</div>
18231842
</div>
18241843
<div class="sect2">
18251844
<h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"><a class="anchor" href="#_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"></a>What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</h3>
@@ -1909,7 +1928,7 @@ <h3 id="_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_o
19091928
</div>
19101929
<div id="footer">
19111930
<div id="footer-text">
1912-
Last updated 2023-06-30 13:28:16 +0200
1931+
Last updated 2023-07-29 16:41:55 +0200
19131932
</div>
19141933
</div>
19151934
</div>

‎docs/index.html

+25-1
Original file line numberDiff line numberDiff line change
@@ -1496,6 +1496,11 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
14961496
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Pre-loading setting to load OpenAPI on application startup.</p></td>
14971497
</tr>
14981498
<tr>
1499+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.pre-loading-locales</p></td>
1500+
<td class="tableblock halign-left valign-top"></td>
1501+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of locales to load OpenAPI on application startup.(comma separated) If not specified, it will preload with the default Locale.</p></td>
1502+
</tr>
1503+
<tr>
14991504
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.writer-with-order-by-keys</p></td>
15001505
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
15011506
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Enable a deterministic/alphabetical ordering.</p></td>
@@ -1669,7 +1674,7 @@ <h3 id="swagger-ui-properties"><a class="anchor" href="#swagger-ui-properties"><
16691674
<tr>
16701675
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.deepLinking</p></td>
16711676
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
1672-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to <code>true</code>, enables deep linking for tags and operations. See the [Deep Linking documentation](/docs/usage/deep-linking.md) for more information.</p></td>
1677+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to <code>true</code>, enables deep linking for tags and operations. See the [Deep Linking documentation](<a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking" class="bare">swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking</a>) for more information.</p></td>
16731678
</tr>
16741679
<tr>
16751680
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.defaultModelsExpandDepth</p></td>
@@ -2893,6 +2898,7 @@ <h3 id="how-can-i-set-swagger-properties-programmatically"><a class="anchor" hre
28932898
<div class="content">
28942899
<pre class="highlight"><code class="language-kotlin" data-lang="kotlin">---
28952900
@Bean
2901+
@Primary
28962902
fun swaggerUiConfig(config: SwaggerUiConfigProperties): SwaggerUiConfigProperties {
28972903
config.showCommonExtensions = true
28982904
config.queryConfigEnabled = true
@@ -3896,6 +3902,7 @@ <h3 id="what-is-a-proper-way-to-set-up-swagger-ui-to-use-provided-spec-yml"><a c
38963902
SpringDocConfiguration springDocConfiguration(){
38973903
return new SpringDocConfiguration();
38983904
}
3905+
38993906
@Bean
39003907
SpringDocConfigProperties springDocConfigProperties() {
39013908
return new SpringDocConfigProperties();
@@ -3905,6 +3912,11 @@ <h3 id="what-is-a-proper-way-to-set-up-swagger-ui-to-use-provided-spec-yml"><a c
39053912
ObjectMapperProvider objectMapperProvider(SpringDocConfigProperties springDocConfigProperties){
39063913
return new ObjectMapperProvider(springDocConfigProperties);
39073914
}
3915+
3916+
@Bean
3917+
SpringDocsUIConfiguration springDocsUiConfiguration(Optional&lt;SwaggerUiConfigProperties&gt; optionalSwaggerUiConfigProperties){
3918+
return new SpringDocsUIConfiguration(optionalSwaggerUiConfigProperties);
3919+
}
39083920
</code></pre>
39093921
</div>
39103922
</div>
@@ -4413,6 +4425,18 @@ <h3 id="is-graalvm-supported"><a class="anchor" href="#is-graalvm-supported"></a
44134425
<div class="paragraph">
44144426
<p>For the OpenAPI REST endpoints, you just need to build your application with the spring <code>native</code> profile.</p>
44154427
</div>
4428+
<div class="paragraph">
4429+
<p>If you give <code>@OpenAPIDefinition</code> or <code>@SecurityScheme</code> to a class that has no implementation, that class will disappear when you natively compile.
4430+
To avoid this, give the class a <code>@Configuration</code>.</p>
4431+
</div>
4432+
<div class="listingblock">
4433+
<div class="content">
4434+
<pre>@Configuration
4435+
@OpenAPIDefinition(info = @Info(title = "My App", description = "description"))
4436+
public class OpenAPIConfig {
4437+
}</pre>
4438+
</div>
4439+
</div>
44164440
</div>
44174441
<div class="sect2">
44184442
<h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot"><a class="anchor" href="#what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot"></a>13.78. What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</h3>

‎docs/properties.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,11 @@ <h3 id="_springdoc_openapi_core_properties"><a class="anchor" href="#_springdoc_
237237
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Pre-loading setting to load OpenAPI on application startup.</p></td>
238238
</tr>
239239
<tr>
240+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.pre-loading-locales</p></td>
241+
<td class="tableblock halign-left valign-top"></td>
242+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of locales to load OpenAPI on application startup.(comma separated) If not specified, it will preload with the default Locale.</p></td>
243+
</tr>
244+
<tr>
240245
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.writer-with-order-by-keys</p></td>
241246
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
242247
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Enable a deterministic/alphabetical ordering.</p></td>
@@ -410,7 +415,7 @@ <h3 id="_swagger_ui_properties"><a class="anchor" href="#_swagger_ui_properties"
410415
<tr>
411416
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.deepLinking</p></td>
412417
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
413-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to <code>true</code>, enables deep linking for tags and operations. See the [Deep Linking documentation](/docs/usage/deep-linking.md) for more information.</p></td>
418+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to <code>true</code>, enables deep linking for tags and operations. See the [Deep Linking documentation](<a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking" class="bare">https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking</a>) for more information.</p></td>
414419
</tr>
415420
<tr>
416421
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.defaultModelsExpandDepth</p></td>

‎docs/ui-properties.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
<tr>
107107
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.deepLinking</p></td>
108108
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
109-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to <code>true</code>, enables deep linking for tags and operations. See the [Deep Linking documentation](/docs/usage/deep-linking.md) for more information.</p></td>
109+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to <code>true</code>, enables deep linking for tags and operations. See the [Deep Linking documentation](<a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking" class="bare">https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking</a>) for more information.</p></td>
110110
</tr>
111111
<tr>
112112
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.defaultModelsExpandDepth</p></td>
@@ -268,7 +268,7 @@
268268
</div>
269269
<div id="footer">
270270
<div id="footer-text">
271-
Last updated 2022-08-07 00:58:43 +0200
271+
Last updated 2023-07-29 16:39:56 +0200
272272
</div>
273273
</div>
274274
</div>

‎docs/v1/core-properties.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,11 @@
229229
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Pre-loading setting to load OpenAPI on application startup.</p></td>
230230
</tr>
231231
<tr>
232+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.pre-loading-locales</p></td>
233+
<td class="tableblock halign-left valign-top"></td>
234+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of locales to load OpenAPI on application startup.(comma separated) If not specified, it will preload with the default Locale.</p></td>
235+
</tr>
236+
<tr>
232237
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.writer-with-order-by-keys</p></td>
233238
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
234239
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Enable a deterministic/alphabetical ordering.</p></td>
@@ -278,7 +283,7 @@
278283
</div>
279284
<div id="footer">
280285
<div id="footer-text">
281-
Last updated 2023-04-02 00:44:12 +0200
286+
Last updated 2023-07-29 16:29:55 +0200
282287
</div>
283288
</div>
284289
</div>

0 commit comments

Comments
 (0)