Skip to content

Commit df6978d

Browse files
committed
upgrade to version 1.5.13
1 parent b325475 commit df6978d

File tree

11 files changed

+228
-90
lines changed

11 files changed

+228
-90
lines changed

docs/core-properties.html

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,16 @@
185185
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable deprecating model converter.</p></td>
186186
</tr>
187187
<tr>
188+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.model-converters.polymorphic-converter.enabled</p></td>
189+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
190+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable polymorphic model converter.</p></td>
191+
</tr>
192+
<tr>
193+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.model-converters.pageable-converter.enabled</p></td>
194+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
195+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable pageable model converter.</p></td>
196+
</tr>
197+
<tr>
188198
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.use-fqn</p></td>
189199
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
190200
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable fully qualified names.</p></td>
@@ -210,9 +220,9 @@
210220
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To expose the swagger-ui on the actuator management port.</p></td>
211221
</tr>
212222
<tr>
213-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-native-image-support</p></td>
223+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.disable-i18n</p></td>
214224
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
215-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To force enabling native images support.</p></td>
225+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable automatic translation using i18n.</p></td>
216226
</tr>
217227
</tbody>
218228
</table>
@@ -221,7 +231,7 @@
221231
</div>
222232
<div id="footer">
223233
<div id="footer-text">
224-
Last updated 2021-10-02 12:47:33 +0200
234+
Last updated 2021-11-28 13:35:15 +0100
225235
</div>
226236
</div>
227237
<link rel="stylesheet" href="js/highlight/styles/github.min.css">

docs/features.html

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -428,27 +428,6 @@ <h3 id="_exposing_swagger_ui_on_the_actuator_port">Exposing swagger-ui on the Ac
428428
</div>
429429
</div>
430430
<div class="sect2">
431-
<h3 id="_graalvm_and_spring_native_for_native_images">GraalVM and spring-native for native images</h3>
432-
<div class="paragraph">
433-
<p><code>springdoc-openapi</code>, supports out of the box <a href="https://www.graalvm.org/">GraalVM</a> native images.</p>
434-
</div>
435-
<div class="paragraph">
436-
<p>If the application uses <a href="https://docs.spring.io/spring-native/docs/current/reference/htmlsingle/">spring-native</a>, there is no additional configuration required to enable the support of native images.</p>
437-
</div>
438-
<div class="admonitionblock note">
439-
<table>
440-
<tr>
441-
<td class="icon">
442-
<i class="fa icon-note" title="Note"></i>
443-
</td>
444-
<td class="content">
445-
The url of the swagger-ui using native images, contains the version of the swagger-ui. This is related to the following enhancement request in GraalVM <a href="https://github.com/oracle/graal/issues/1108">#1108</a>.
446-
</td>
447-
</tr>
448-
</table>
449-
</div>
450-
</div>
451-
<div class="sect2">
452431
<h3 id="_integration_with_wildfly">Integration with WildFly</h3>
453432
<div class="ulist">
454433
<ul>
@@ -472,7 +451,7 @@ <h3 id="_integration_with_wildfly">Integration with WildFly</h3>
472451
</div>
473452
<div id="footer">
474453
<div id="footer-text">
475-
Last updated 2021-05-23 19:02:19 +0200
454+
Last updated 2021-11-28 13:39:38 +0100
476455
</div>
477456
</div>
478457
<link rel="stylesheet" href="js/highlight/styles/github.min.css">

docs/getting-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h2 id="getting-started">Getting Started</h2>
2929
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
3030
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
3131
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
32-
&lt;version&gt;1.5.12&lt;/version&gt;
32+
&lt;version&gt;1.5.13&lt;/version&gt;
3333
&lt;/dependency&gt;</code></pre>
3434
</div>
3535
</div>

docs/index.html

Lines changed: 96 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
</head>
2727
<body class="book toc2 toc-left">
2828
<div id="header">
29-
<h1>springdoc-openapi v1.5.12</h1>
29+
<h1>springdoc-openapi v1.5.13</h1>
3030
<div class="details">
3131
<span id="author" class="author">Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN</span><br>
3232
</div>
@@ -43,9 +43,10 @@ <h1>springdoc-openapi v1.5.12</h1>
4343
<li><a href="#spring-hateoas-support">3.4. Spring Hateoas support</a></li>
4444
<li><a href="#spring-data-rest-support">3.5. Spring Data Rest support</a></li>
4545
<li><a href="#spring-security-support">3.6. Spring security support</a></li>
46-
<li><a href="#kotlin-support">3.7. Kotlin support</a></li>
47-
<li><a href="#groovy-support">3.8. Groovy support</a></li>
48-
<li><a href="#javadoc-support">3.9. Javadoc support</a></li>
46+
<li><a href="#spring-native-support">3.7. Spring Native support</a></li>
47+
<li><a href="#kotlin-support">3.8. Kotlin support</a></li>
48+
<li><a href="#groovy-support">3.9. Groovy support</a></li>
49+
<li><a href="#javadoc-support">3.10. Javadoc support</a></li>
4950
</ul>
5051
</li>
5152
<li><a href="#features">4. Springdoc-openapi Features</a>
@@ -58,8 +59,7 @@ <h1>springdoc-openapi v1.5.12</h1>
5859
<li><a href="#selecting-the-rest-controllers-to-include-in-the-documentation">4.6. Selecting the Rest Controllers to include in the documentation</a></li>
5960
<li><a href="#spring-webfluxwebmvc-fn-with-functional-endpoints">4.7. Spring-webflux/WebMvc.fn with Functional Endpoints</a></li>
6061
<li><a href="#exposing-swagger-ui-on-the-actuator-port">4.8. Exposing swagger-ui on the Actuator port</a></li>
61-
<li><a href="#graalvm-and-spring-native-for-native-images">4.9. GraalVM and spring-native for native images</a></li>
62-
<li><a href="#integration-with-wildfly">4.10. Integration with WildFly</a></li>
62+
<li><a href="#integration-with-wildfly">4.9. Integration with WildFly</a></li>
6363
</ul>
6464
</li>
6565
<li><a href="#properties">5. Springdoc-openapi Properties</a>
@@ -240,7 +240,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
240240
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
241241
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
242242
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
243-
&lt;version&gt;1.5.12&lt;/version&gt;
243+
&lt;version&gt;1.5.13&lt;/version&gt;
244244
&lt;/dependency&gt;</code></pre>
245245
</div>
246246
</div>
@@ -337,7 +337,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
337337
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
338338
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
339339
&lt;artifactId&gt;springdoc-openapi-webmvc-core&lt;/artifactId&gt;
340-
&lt;version&gt;1.5.12&lt;/version&gt;
340+
&lt;version&gt;1.5.13&lt;/version&gt;
341341
&lt;/dependency&gt;</code></pre>
342342
</div>
343343
</div>
@@ -389,7 +389,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
389389
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
390390
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
391391
&lt;artifactId&gt;springdoc-openapi-webflux-ui&lt;/artifactId&gt;
392-
&lt;version&gt;1.5.12&lt;/version&gt;
392+
&lt;version&gt;1.5.13&lt;/version&gt;
393393
&lt;/dependency&gt;</code></pre>
394394
</div>
395395
</div>
@@ -406,7 +406,7 @@ <h3 id="spring-hateoas-support"><a class="anchor" href="#spring-hateoas-support"
406406
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
407407
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
408408
&lt;artifactId&gt;springdoc-openapi-hateoas&lt;/artifactId&gt;
409-
&lt;version&gt;1.5.12&lt;/version&gt;
409+
&lt;version&gt;1.5.13&lt;/version&gt;
410410
&lt;/dependency&gt;</code></pre>
411411
</div>
412412
</div>
@@ -431,7 +431,7 @@ <h3 id="spring-data-rest-support"><a class="anchor" href="#spring-data-rest-supp
431431
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
432432
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
433433
&lt;artifactId&gt;springdoc-openapi-data-rest&lt;/artifactId&gt;
434-
&lt;version&gt;1.5.12&lt;/version&gt;
434+
&lt;version&gt;1.5.13&lt;/version&gt;
435435
&lt;/dependency&gt;</code></pre>
436436
</div>
437437
</div>
@@ -447,13 +447,77 @@ <h3 id="spring-security-support"><a class="anchor" href="#spring-security-suppor
447447
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
448448
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
449449
&lt;artifactId&gt;springdoc-openapi-security&lt;/artifactId&gt;
450-
&lt;version&gt;1.5.12&lt;/version&gt;
450+
&lt;version&gt;1.5.13&lt;/version&gt;
451451
&lt;/dependency&gt;</code></pre>
452452
</div>
453453
</div>
454454
</div>
455455
<div class="sect2">
456-
<h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.7. Kotlin support</h3>
456+
<h3 id="spring-native-support"><a class="anchor" href="#spring-native-support"></a>3.7. Spring Native support</h3>
457+
<div class="paragraph">
458+
<p><code>springdoc-openapi</code>, supports out of the box <a href="https://www.graalvm.org/">GraalVM</a> native images.
459+
If the application uses <a href="https://docs.spring.io/spring-native/docs/current/reference/htmlsingle/">spring-native</a>, you should add the following dependency, together with the springdoc-openapi-ui/webflux-ui dependency:
460+
This dependency helps native support on springdoc-openapi.</p>
461+
</div>
462+
<div class="listingblock">
463+
<div class="content">
464+
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
465+
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
466+
&lt;artifactId&gt;springdoc-openapi-native&lt;/artifactId&gt;
467+
&lt;version&gt;1.5.13&lt;/version&gt;
468+
&lt;/dependency&gt;</code></pre>
469+
</div>
470+
</div>
471+
<div class="paragraph">
472+
<p>This is the compatibility matrix which shows the tested/validated versions with <code>springdoc-openapi</code>:</p>
473+
</div>
474+
<table class="tableblock frame-all grid-all stretch">
475+
<colgroup>
476+
<col style="width: 50%;">
477+
<col style="width: 50%;">
478+
</colgroup>
479+
<tbody>
480+
<tr>
481+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc-openapi Version</p></td>
482+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring-native Version</p></td>
483+
</tr>
484+
<tr>
485+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.5.9</p></td>
486+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.9.2</p></td>
487+
</tr>
488+
<tr>
489+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.5.10</p></td>
490+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.10.1</p></td>
491+
</tr>
492+
<tr>
493+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.5.11</p></td>
494+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.10.3</p></td>
495+
</tr>
496+
<tr>
497+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.5.12</p></td>
498+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.10.5</p></td>
499+
</tr>
500+
<tr>
501+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.5.13</p></td>
502+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.11-RC1</p></td>
503+
</tr>
504+
</tbody>
505+
</table>
506+
<div class="admonitionblock note">
507+
<table>
508+
<tr>
509+
<td class="icon">
510+
<i class="fa icon-note" title="Note"></i>
511+
</td>
512+
<td class="content">
513+
The url of the swagger-ui using native images, contains the version of the swagger-ui. This is related to the following enhancement request in GraalVM <a href="https://github.com/oracle/graal/issues/1108">#1108</a>.
514+
</td>
515+
</tr>
516+
</table>
517+
</div>
518+
</div>
519+
<div class="sect2">
520+
<h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.8. Kotlin support</h3>
457521
<div class="paragraph">
458522
<p>For a project that uses Kotlin, you should add the following dependency.
459523
This dependency improves the support of Kotlin types:</p>
@@ -463,7 +527,7 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.7. Kotlin
463527
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
464528
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
465529
&lt;artifactId&gt;springdoc-openapi-kotlin&lt;/artifactId&gt;
466-
&lt;version&gt;1.5.12&lt;/version&gt;
530+
&lt;version&gt;1.5.13&lt;/version&gt;
467531
&lt;/dependency&gt;</code></pre>
468532
</div>
469533
</div>
@@ -479,7 +543,7 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.7. Kotlin
479543
</div>
480544
</div>
481545
<div class="sect2">
482-
<h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.8. Groovy support</h3>
546+
<h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.9. Groovy support</h3>
483547
<div class="paragraph">
484548
<p>For a project that uses Groovy, you should add the following dependency, together with the springdoc-openapi-ui dependency:
485549
This dependency improves the support of Kotlin types:</p>
@@ -489,13 +553,13 @@ <h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.8. Groovy
489553
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
490554
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
491555
&lt;artifactId&gt;springdoc-openapi-groovy&lt;/artifactId&gt;
492-
&lt;version&gt;1.5.12&lt;/version&gt;
556+
&lt;version&gt;1.5.13&lt;/version&gt;
493557
&lt;/dependency&gt;</code></pre>
494558
</div>
495559
</div>
496560
</div>
497561
<div class="sect2">
498-
<h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.9. Javadoc support</h3>
562+
<h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.10. Javadoc support</h3>
499563
<div class="paragraph">
500564
<p>For a project that wants to enable javadoc support, you should add the following dependency, together with the <code>springdoc-openapi-ui</code> dependency:</p>
501565
</div>
@@ -504,7 +568,7 @@ <h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.9. Java
504568
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
505569
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
506570
&lt;artifactId&gt;springdoc-openapi-javadoc&lt;/artifactId&gt;
507-
&lt;version&gt;1.5.12&lt;/version&gt;
571+
&lt;version&gt;1.5.13&lt;/version&gt;
508572
&lt;/dependency&gt;</code></pre>
509573
</div>
510574
</div>
@@ -985,28 +1049,7 @@ <h3 id="exposing-swagger-ui-on-the-actuator-port"><a class="anchor" href="#expos
9851049
</div>
9861050
</div>
9871051
<div class="sect2">
988-
<h3 id="graalvm-and-spring-native-for-native-images"><a class="anchor" href="#graalvm-and-spring-native-for-native-images"></a>4.9. GraalVM and spring-native for native images</h3>
989-
<div class="paragraph">
990-
<p><code>springdoc-openapi</code>, supports out of the box <a href="https://www.graalvm.org/">GraalVM</a> native images.</p>
991-
</div>
992-
<div class="paragraph">
993-
<p>If the application uses <a href="https://docs.spring.io/spring-native/docs/current/reference/htmlsingle/">spring-native</a>, there is no additional configuration required to enable the support of native images.</p>
994-
</div>
995-
<div class="admonitionblock note">
996-
<table>
997-
<tr>
998-
<td class="icon">
999-
<i class="fa icon-note" title="Note"></i>
1000-
</td>
1001-
<td class="content">
1002-
The url of the swagger-ui using native images, contains the version of the swagger-ui. This is related to the following enhancement request in GraalVM <a href="https://github.com/oracle/graal/issues/1108">#1108</a>.
1003-
</td>
1004-
</tr>
1005-
</table>
1006-
</div>
1007-
</div>
1008-
<div class="sect2">
1009-
<h3 id="integration-with-wildfly"><a class="anchor" href="#integration-with-wildfly"></a>4.10. Integration with WildFly</h3>
1052+
<h3 id="integration-with-wildfly"><a class="anchor" href="#integration-with-wildfly"></a>4.9. Integration with WildFly</h3>
10101053
<div class="ulist">
10111054
<ul>
10121055
<li>
@@ -1199,6 +1242,16 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
11991242
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable deprecating model converter.</p></td>
12001243
</tr>
12011244
<tr>
1245+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.model-converters.polymorphic-converter.enabled</p></td>
1246+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
1247+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable polymorphic model converter.</p></td>
1248+
</tr>
1249+
<tr>
1250+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.model-converters.pageable-converter.enabled</p></td>
1251+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
1252+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable pageable model converter.</p></td>
1253+
</tr>
1254+
<tr>
12021255
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.use-fqn</p></td>
12031256
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
12041257
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To enable fully qualified names.</p></td>
@@ -1224,9 +1277,9 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
12241277
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To expose the swagger-ui on the actuator management port.</p></td>
12251278
</tr>
12261279
<tr>
1227-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.enable-native-image-support</p></td>
1280+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.disable-i18n</p></td>
12281281
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
1229-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To force enabling native images support.</p></td>
1282+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To disable automatic translation using i18n.</p></td>
12301283
</tr>
12311284
</tbody>
12321285
</table>
@@ -1662,7 +1715,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
16621715
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
16631716
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
16641717
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
1665-
&lt;version&gt;1.5.12&lt;/version&gt;
1718+
&lt;version&gt;1.5.13&lt;/version&gt;
16661719
&lt;/dependency&gt;</code></pre>
16671720
</div>
16681721
</div>

docs/migrating-from-springfox.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h2 id="migrating-from-springfox">Migrating from SpringFox</h2>
3333
<pre class="highlightjs highlight"><code data-lang="xml" class="language-xml hljs"> &lt;dependency&gt;
3434
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
3535
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
36-
&lt;version&gt;1.5.12&lt;/version&gt;
36+
&lt;version&gt;1.5.13&lt;/version&gt;
3737
&lt;/dependency&gt;</code></pre>
3838
</div>
3939
</div>

0 commit comments

Comments
 (0)