Skip to content

Commit 17b1e38

Browse files
committed
docs update
1 parent 73c55a3 commit 17b1e38

10 files changed

+35
-14
lines changed

docs/core-properties.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -308,12 +308,17 @@
308308
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
309309
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Adjust indentation when parsing the <code>@Operation</code> annotation in Kotlin.</p></td>
310310
</tr>
311+
<tr>
312+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.allowed-locales</p></td>
313+
<td class="tableblock halign-left valign-top"></td>
314+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of allowed locales for OpenAPI (comma separated, for example <code>US,fr-CA</code>).</p></td>
315+
</tr>
311316
</tbody>
312317
</table>
313318
</div>
314319
<div id="footer">
315320
<div id="footer-text">
316-
Last updated 2025-01-24 10:18:05 +0100
321+
Last updated 2025-01-25 21:28:01 +0100
317322
</div>
318323
</div>
319324
</div>

docs/faq.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2011,7 +2011,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
20112011
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
20122012
</div>
20132013
<div class="paragraph">
2014-
<p>In general, <strong>you should only pick the last stable version as per today 2.8.3.</strong></p>
2014+
<p>In general, <strong>you should only pick the last stable version as per today 2.8.4.</strong></p>
20152015
</div>
20162016
<div class="paragraph">
20172017
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>

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

docs/index.html

+12-7
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<meta property="og:site_name" content="OpenAPI 3 Library for spring-boot" />
1919
<meta property="og:image" content="https://springdoc.org/img/banner-logo.svg" />
2020
<meta name="author" content="Library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN">
21-
<title>springdoc-openapi v2.8.3</title>
21+
<title>springdoc-openapi v2.8.4</title>
2222
<link rel="stylesheet" href="css/site.css">
2323
<style>
2424
#header #revnumber {
@@ -55,7 +55,7 @@
5555
<div id="main" class="contained">
5656
<div id="doc" class="doc">
5757
<div id="header">
58-
<h1>springdoc-openapi v2.8.3</h1>
58+
<h1>springdoc-openapi v2.8.4</h1>
5959
<div id="toc" class="toc2">
6060
<div id="toctitle">Table of Contents</div>
6161
<ul class="sectlevel1">
@@ -309,7 +309,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
309309
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
310310
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
311311
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
312-
&lt;version&gt;2.8.3&lt;/version&gt;
312+
&lt;version&gt;2.8.4&lt;/version&gt;
313313
&lt;/dependency&gt;</code></pre>
314314
</div>
315315
</div>
@@ -417,7 +417,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
417417
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
418418
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
419419
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
420-
&lt;version&gt;2.8.3&lt;/version&gt;
420+
&lt;version&gt;2.8.4&lt;/version&gt;
421421
&lt;/dependency&gt;</code></pre>
422422
</div>
423423
</div>
@@ -469,7 +469,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
469469
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
470470
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
471471
&lt;artifactId&gt;springdoc-openapi-starter-webflux-api&lt;/artifactId&gt;
472-
&lt;version&gt;2.8.3&lt;/version&gt;
472+
&lt;version&gt;2.8.4&lt;/version&gt;
473473
&lt;/dependency&gt;</code></pre>
474474
</div>
475475
</div>
@@ -1567,6 +1567,11 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
15671567
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
15681568
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Adjust indentation when parsing the <code>@Operation</code> annotation in Kotlin.</p></td>
15691569
</tr>
1570+
<tr>
1571+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.allowed-locales</p></td>
1572+
<td class="tableblock halign-left valign-top"></td>
1573+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of allowed locales for OpenAPI (comma separated, for example <code>US,fr-CA</code>).</p></td>
1574+
</tr>
15701575
</tbody>
15711576
</table>
15721577
</div>
@@ -2215,7 +2220,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
22152220
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
22162221
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
22172222
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
2218-
&lt;version&gt;2.8.3&lt;/version&gt;
2223+
&lt;version&gt;2.8.4&lt;/version&gt;
22192224
&lt;/dependency&gt;</code></pre>
22202225
</div>
22212226
</div>
@@ -4535,7 +4540,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
45354540
<p><code>springdoc-openapi 2.x</code> is compatible with <code>spring-boot 3</code>.</p>
45364541
</div>
45374542
<div class="paragraph">
4538-
<p>In general, <strong>you should only pick the last stable version as per today 2.8.3.</strong></p>
4543+
<p>In general, <strong>you should only pick the last stable version as per today 2.8.4.</strong></p>
45394544
</div>
45404545
<div class="paragraph">
45414546
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>

docs/migrating-from-springfox.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
4444
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
4545
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
4646
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-ui&lt;/artifactId&gt;
47-
&lt;version&gt;2.8.3&lt;/version&gt;
47+
&lt;version&gt;2.8.4&lt;/version&gt;
4848
&lt;/dependency&gt;</code></pre>
4949
</div>
5050
</div>

docs/modules.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h3 id="_spring_webmvc_support"><a class="anchor" href="#_spring_webmvc_support"
7373
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
7474
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
7575
&lt;artifactId&gt;springdoc-openapi-starter-webmvc-api&lt;/artifactId&gt;
76-
&lt;version&gt;2.8.3&lt;/version&gt;
76+
&lt;version&gt;2.8.4&lt;/version&gt;
7777
&lt;/dependency&gt;</code></pre>
7878
</div>
7979
</div>
@@ -125,7 +125,7 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
125125
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
126126
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
127127
&lt;artifactId&gt;springdoc-openapi-starter-webflux-api&lt;/artifactId&gt;
128-
&lt;version&gt;2.8.3&lt;/version&gt;
128+
&lt;version&gt;2.8.4&lt;/version&gt;
129129
&lt;/dependency&gt;</code></pre>
130130
</div>
131131
</div>

docs/properties.html

+5
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,11 @@ <h3 id="_springdoc_openapi_core_properties"><a class="anchor" href="#_springdoc_
316316
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
317317
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Adjust indentation when parsing the <code>@Operation</code> annotation in Kotlin.</p></td>
318318
</tr>
319+
<tr>
320+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.allowed-locales</p></td>
321+
<td class="tableblock halign-left valign-top"></td>
322+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of allowed locales for OpenAPI (comma separated, for example <code>US,fr-CA</code>).</p></td>
323+
</tr>
319324
</tbody>
320325
</table>
321326
</div>

docs/v1/properties.html

+5
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,11 @@ <h3 id="_springdoc_openapi_core_properties"><a class="anchor" href="#_springdoc_
316316
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
317317
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. Adjust indentation when parsing the <code>@Operation</code> annotation in Kotlin.</p></td>
318318
</tr>
319+
<tr>
320+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.allowed-locales</p></td>
321+
<td class="tableblock halign-left valign-top"></td>
322+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>List of Strings</code>. The list of allowed locales for OpenAPI (comma separated, for example <code>US,fr-CA</code>).</p></td>
323+
</tr>
319324
</tbody>
320325
</table>
321326
</div>

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<version>3.1.2-SNAPSHOT</version>
1010

1111
<properties>
12-
<springdoc.version>2.8.3</springdoc.version>
12+
<springdoc.version>2.8.4</springdoc.version>
1313
<springdoc-legacy.version>1.8.0</springdoc-legacy.version>
1414
<java.version>1.8</java.version>
1515
<refdocs.build.directory>${project.basedir}/docs</refdocs.build.directory>

src/docs/asciidoc/core-properties.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,6 @@
5656
|springdoc.api-docs.resolve-extensions-properties | `false` | `Boolean`. To enable support of spring property resolver for `@ExtensionProperty`.
5757
|springdoc.enable-default-api-docs | `true` | `Boolean`. To enable default OpenAPI endpoint `/v3/api-docs`.
5858
|springdoc.trim-kotlin-indent | `false` | `Boolean`. Adjust indentation when parsing the `@Operation` annotation in Kotlin.
59+
|springdoc.allowed-locales | | `List of Strings`. The list of allowed locales for OpenAPI (comma separated, for example `US,fr-CA`).
5960
|===
6061

0 commit comments

Comments
 (0)