Skip to content

Commit d1a34b8

Browse files
committed
upgrade to next version
1 parent 2633737 commit d1a34b8

20 files changed

+464
-287
lines changed

docs/core-properties.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,11 @@
126126
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
127127
</tr>
128128
<tr>
129+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
130+
<td class="tableblock halign-left valign-top"></td>
131+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
132+
</tr>
133+
<tr>
129134
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].packages-to-scan</p></td>
130135
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td>
131136
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to scan for a group (comma separated)</p></td>
@@ -237,7 +242,7 @@
237242
</div>
238243
<div id="footer">
239244
<div id="footer-text">
240-
Last updated 2021-12-25 11:36:58 +0100
245+
Last updated 2022-04-07 20:08:36 +0200
241246
</div>
242247
</div>
243248
<script src="js/highlight/highlight.min.js"></script>

docs/faq.html

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,24 @@ <h3 id="_how_can_i_explicitly_set_which_packages_to_scan">How can I explicitly s
261261
</div>
262262
</div>
263263
<div class="sect2">
264+
<h3 id="_how_can_i_set_swagger_properties_programmatically">How can I set Swagger properties programmatically?</h3>
265+
<div class="paragraph">
266+
<p>These can be set by creating a <code>swaggerUiConfig</code> bean as follows:</p>
267+
</div>
268+
<div class="listingblock">
269+
<div class="content">
270+
<pre class="highlightjs highlight"><code class="language-kotlin hljs" data-lang="kotlin">---
271+
@Bean
272+
fun swaggerUiConfig(config: SwaggerUiConfigProperties): SwaggerUiConfigProperties {
273+
config.showCommonExtensions = true
274+
config.queryConfigEnabled = true
275+
return config
276+
}
277+
---</code></pre>
278+
</div>
279+
</div>
280+
</div>
281+
<div class="sect2">
264282
<h3 id="_how_can_i_ignore_some_field_of_model">How can I ignore some field of model ?</h3>
265283
<div class="ulist">
266284
<ul>
@@ -1777,7 +1795,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
17771795
</div>
17781796
<div id="footer">
17791797
<div id="footer-text">
1780-
Last updated 2022-02-05 12:18:36 +0100
1798+
Last updated 2022-02-27 16:18:35 +0100
17811799
</div>
17821800
</div>
17831801
<script src="js/highlight/highlight.min.js"></script>

docs/index.html

Lines changed: 164 additions & 131 deletions
Large diffs are not rendered by default.

docs/plugins.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,8 @@ <h3 id="_gradle_plugin">Gradle plugin</h3>
9292
<div class="listingblock">
9393
<div class="content">
9494
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">plugins {
95-
id("org.springframework.boot") version "2.3.0.RELEASE"
96-
id("com.github.johnrengelman.processes") version "0.5.0"
97-
id("org.springdoc.openapi-gradle-plugin") version "1.3.3"
95+
id("org.springframework.boot") version "2.6.6"
96+
id("org.springdoc.openapi-gradle-plugin") version "1.3.4"
9897
}</code></pre>
9998
</div>
10099
</div>
@@ -132,7 +131,7 @@ <h3 id="_gradle_plugin">Gradle plugin</h3>
132131
</div>
133132
<div id="footer">
134133
<div id="footer-text">
135-
Last updated 2022-02-05 12:13:59 +0100
134+
Last updated 2022-04-07 20:09:08 +0200
136135
</div>
137136
</div>
138137
<script src="js/highlight/highlight.min.js"></script>

docs/properties.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,11 @@ <h3 id="_springdoc_openapi_core_properties">springdoc-openapi core properties</h
132132
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
133133
</tr>
134134
<tr>
135+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
136+
<td class="tableblock halign-left valign-top"></td>
137+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
138+
</tr>
139+
<tr>
135140
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].packages-to-scan</p></td>
136141
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td>
137142
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to scan for a group (comma separated)</p></td>
@@ -448,6 +453,16 @@ <h3 id="_swagger_ui_properties">swagger-ui properties</h3>
448453
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable CSRF support</p></td>
449454
</tr>
450455
<tr>
456+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.csrf.use-local-storage</p></td>
457+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
458+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To get the CSRF token from the Local Storage.</p></td>
459+
</tr>
460+
<tr>
461+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.csrf.use-session-storage</p></td>
462+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
463+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To get the CSRF token from the Session Storage.</p></td>
464+
</tr>
465+
<tr>
451466
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.csrf.cookie-name</p></td>
452467
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>XSRF-TOKEN</code></p></td>
453468
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. Optional CSRF, to set the CSRF cookie name.</p></td>

docs/ui-properties.html

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,16 @@
206206
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable CSRF support</p></td>
207207
</tr>
208208
<tr>
209+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.csrf.use-local-storage</p></td>
210+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
211+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To get the CSRF token from the Local Storage.</p></td>
212+
</tr>
213+
<tr>
214+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.csrf.use-session-storage</p></td>
215+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
216+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To get the CSRF token from the Session Storage.</p></td>
217+
</tr>
218+
<tr>
209219
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.swagger-ui.csrf.cookie-name</p></td>
210220
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>XSRF-TOKEN</code></p></td>
211221
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. Optional CSRF, to set the CSRF cookie name.</p></td>
@@ -252,7 +262,7 @@
252262
</div>
253263
<div id="footer">
254264
<div id="footer-text">
255-
Last updated 2021-12-25 11:47:51 +0100
265+
Last updated 2022-02-27 16:15:35 +0100
256266
</div>
257267
</div>
258268
<script src="js/highlight/highlight.min.js"></script>

docs/v2/core-properties.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,11 @@
126126
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
127127
</tr>
128128
<tr>
129+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
130+
<td class="tableblock halign-left valign-top"></td>
131+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
132+
</tr>
133+
<tr>
129134
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].packages-to-scan</p></td>
130135
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td>
131136
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>.The list of packages to scan for a group (comma separated)</p></td>
@@ -267,7 +272,7 @@
267272
</div>
268273
<div id="footer">
269274
<div id="footer-text">
270-
Last updated 2022-01-27 15:04:56 +0100
275+
Last updated 2022-04-07 20:08:18 +0200
271276
</div>
272277
</div>
273278
<script src="js/highlight/highlight.min.js"></script>

docs/v2/faq.html

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,24 @@ <h3 id="_how_can_i_explicitly_set_which_packages_to_scan">How can I explicitly s
261261
</div>
262262
</div>
263263
<div class="sect2">
264+
<h3 id="_how_can_i_set_swagger_properties_programmatically">How can I set Swagger properties programmatically?</h3>
265+
<div class="paragraph">
266+
<p>These can be set by creating a <code>swaggerUiConfig</code> bean as follows:</p>
267+
</div>
268+
<div class="listingblock">
269+
<div class="content">
270+
<pre class="highlightjs highlight"><code class="language-kotlin hljs" data-lang="kotlin">---
271+
@Bean
272+
fun swaggerUiConfig(config: SwaggerUiConfigProperties): SwaggerUiConfigProperties {
273+
config.showCommonExtensions = true
274+
config.queryConfigEnabled = true
275+
return config
276+
}
277+
---</code></pre>
278+
</div>
279+
</div>
280+
</div>
281+
<div class="sect2">
264282
<h3 id="_how_can_i_ignore_some_field_of_model">How can I ignore some field of model ?</h3>
265283
<div class="ulist">
266284
<ul>
@@ -1668,7 +1686,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
16681686
</div>
16691687
<div id="footer">
16701688
<div id="footer-text">
1671-
Last updated 2022-02-06 00:25:12 +0100
1689+
Last updated 2022-02-27 16:18:10 +0100
16721690
</div>
16731691
</div>
16741692
<script src="js/highlight/highlight.min.js"></script>

0 commit comments

Comments
 (0)