Skip to content

Commit feb1aa9

Browse files
committed
doc update
1 parent ba5d061 commit feb1aa9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+10093
-294
lines changed

docs/css/font-awesome.css

+2,337
Large diffs are not rendered by default.

docs/css/site.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/css/site.css.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/faq.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1915,7 +1915,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
19151915
<p><code>springdoc-openapi</code> is compatible with <code>spring-boot 1</code> and <code>spring-boot 2</code>.</p>
19161916
</div>
19171917
<div class="paragraph">
1918-
<p>In general, <strong>you should only pick the last stable version as per today 1.6.15.</strong></p>
1918+
<p>In general, <strong>you should only pick the last stable version as per today 1.7.0.</strong></p>
19191919
</div>
19201920
<div class="paragraph">
19211921
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>

docs/fonts/FontAwesome.otf

132 KB
Binary file not shown.

docs/fonts/fontawesome-webfont.eot

162 KB
Binary file not shown.

docs/fonts/fontawesome-webfont.svg

+2,671
Loading

docs/fonts/fontawesome-webfont.ttf

162 KB
Binary file not shown.

docs/fonts/fontawesome-webfont.woff

95.7 KB
Binary file not shown.

docs/fonts/fontawesome-webfont.woff2

75.4 KB
Binary file not shown.

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-ui&lt;/artifactId&gt;
43-
&lt;version&gt;1.6.15&lt;/version&gt;
43+
&lt;version&gt;1.7.0&lt;/version&gt;
4444
&lt;/dependency&gt;</code></pre>
4545
</div>
4646
</div>

docs/index.html

+22-103
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<div id="main" class="contained">
4646
<div id="doc" class="doc">
4747
<div id="header">
48-
<h1>springdoc-openapi v1.6.15</h1>
48+
<h1>springdoc-openapi v1.7.0</h1>
4949
<div class="details">
5050
<span id="author" class="author">The library for OpenAPI 3 with spring-boot By Badr NASS LAHSEN</span><br>
5151
</div>
@@ -62,12 +62,11 @@ <h1>springdoc-openapi v1.6.15</h1>
6262
<li><a href="#spring-hateoas-support">3.4. Spring Hateoas support</a></li>
6363
<li><a href="#spring-data-rest-support">3.5. Spring Data Rest support</a></li>
6464
<li><a href="#spring-security-support">3.6. Spring Security support</a></li>
65-
<li><a href="#spring-native-support">3.7. Spring Native support</a></li>
66-
<li><a href="#actuator-support">3.8. Actuator support</a></li>
67-
<li><a href="#spring-cloud-function-web-support">3.9. Spring Cloud Function Web support</a></li>
68-
<li><a href="#kotlin-support">3.10. Kotlin support</a></li>
69-
<li><a href="#groovy-support">3.11. Groovy support</a></li>
70-
<li><a href="#javadoc-support">3.12. Javadoc support</a></li>
65+
<li><a href="#actuator-support">3.7. Actuator support</a></li>
66+
<li><a href="#spring-cloud-function-web-support">3.8. Spring Cloud Function Web support</a></li>
67+
<li><a href="#kotlin-support">3.9. Kotlin support</a></li>
68+
<li><a href="#groovy-support">3.10. Groovy support</a></li>
69+
<li><a href="#javadoc-support">3.11. Javadoc support</a></li>
7170
</ul>
7271
</li>
7372
<li><a href="#features">4. Springdoc-openapi Features</a>
@@ -333,7 +332,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
333332
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
334333
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
335334
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
336-
&lt;version&gt;1.6.15&lt;/version&gt;
335+
&lt;version&gt;1.7.0&lt;/version&gt;
337336
&lt;/dependency&gt;</code></pre>
338337
</div>
339338
</div>
@@ -442,7 +441,7 @@ <h3 id="spring-webmvc-support"><a class="anchor" href="#spring-webmvc-support"><
442441
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
443442
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
444443
&lt;artifactId&gt;springdoc-openapi-webmvc-core&lt;/artifactId&gt;
445-
&lt;version&gt;1.6.15&lt;/version&gt;
444+
&lt;version&gt;1.7.0&lt;/version&gt;
446445
&lt;/dependency&gt;</code></pre>
447446
</div>
448447
</div>
@@ -494,7 +493,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
494493
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
495494
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
496495
&lt;artifactId&gt;springdoc-openapi-webflux-ui&lt;/artifactId&gt;
497-
&lt;version&gt;1.6.15&lt;/version&gt;
496+
&lt;version&gt;1.7.0&lt;/version&gt;
498497
&lt;/dependency&gt;</code></pre>
499498
</div>
500499
</div>
@@ -511,7 +510,7 @@ <h3 id="spring-hateoas-support"><a class="anchor" href="#spring-hateoas-support"
511510
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
512511
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
513512
&lt;artifactId&gt;springdoc-openapi-hateoas&lt;/artifactId&gt;
514-
&lt;version&gt;1.6.15&lt;/version&gt;
513+
&lt;version&gt;1.7.0&lt;/version&gt;
515514
&lt;/dependency&gt;</code></pre>
516515
</div>
517516
</div>
@@ -527,7 +526,7 @@ <h3 id="spring-data-rest-support"><a class="anchor" href="#spring-data-rest-supp
527526
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
528527
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
529528
&lt;artifactId&gt;springdoc-openapi-data-rest&lt;/artifactId&gt;
530-
&lt;version&gt;1.6.15&lt;/version&gt;
529+
&lt;version&gt;1.7.0&lt;/version&gt;
531530
&lt;/dependency&gt;</code></pre>
532531
</div>
533532
</div>
@@ -543,93 +542,13 @@ <h3 id="spring-security-support"><a class="anchor" href="#spring-security-suppor
543542
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
544543
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
545544
&lt;artifactId&gt;springdoc-openapi-security&lt;/artifactId&gt;
546-
&lt;version&gt;1.6.15&lt;/version&gt;
545+
&lt;version&gt;1.7.0&lt;/version&gt;
547546
&lt;/dependency&gt;</code></pre>
548547
</div>
549548
</div>
550549
</div>
551550
<div class="sect2">
552-
<h3 id="spring-native-support"><a class="anchor" href="#spring-native-support"></a>3.7. Spring Native support</h3>
553-
<div class="paragraph">
554-
<p><code>springdoc-openapi</code>, supports out of the box <a href="https://www.graalvm.org/">GraalVM</a> native images.
555-
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, in combination with the (<code>springdoc-openapi-ui</code> or <code>springdoc-openapi-webflux-ui</code>) dependency:
556-
- This dependency helps native support on springdoc-openapi (Only available since <code>v1.5.13</code>).</p>
557-
</div>
558-
<div class="listingblock">
559-
<div class="content">
560-
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
561-
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
562-
&lt;artifactId&gt;springdoc-openapi-native&lt;/artifactId&gt;
563-
&lt;version&gt;1.6.15&lt;/version&gt;
564-
&lt;/dependency&gt;</code></pre>
565-
</div>
566-
</div>
567-
<div class="paragraph">
568-
<p>This is the compatibility matrix which shows the tested/validated versions with <code>springdoc-openapi</code>:</p>
569-
</div>
570-
<table class="tableblock frame-all grid-all stretch">
571-
<colgroup>
572-
<col style="width: 50%;">
573-
<col style="width: 50%;">
574-
</colgroup>
575-
<tbody>
576-
<tr>
577-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc-openapi Version</p></td>
578-
<td class="tableblock halign-left valign-top"><p class="tableblock">spring-native Version</p></td>
579-
</tr>
580-
<tr>
581-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.6.11+</code></p></td>
582-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.12.1</code></p></td>
583-
</tr>
584-
<tr>
585-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.6.7</code></p></td>
586-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.11.4</code></p></td>
587-
</tr>
588-
<tr>
589-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.6.3</code></p></td>
590-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.11.1</code></p></td>
591-
</tr>
592-
<tr>
593-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.6.0</code></p></td>
594-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.11.0</code></p></td>
595-
</tr>
596-
<tr>
597-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.13</code></p></td>
598-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.11-RC1</code></p></td>
599-
</tr>
600-
<tr>
601-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.12</code></p></td>
602-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.10.5</code></p></td>
603-
</tr>
604-
<tr>
605-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.11</code></p></td>
606-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.10.3</code></p></td>
607-
</tr>
608-
<tr>
609-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.10</code></p></td>
610-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.10.1</code></p></td>
611-
</tr>
612-
<tr>
613-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.5.9</code></p></td>
614-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.9.2</code></p></td>
615-
</tr>
616-
</tbody>
617-
</table>
618-
<div class="admonitionblock note">
619-
<table>
620-
<tr>
621-
<td class="icon">
622-
<i class="fa icon-note" title="Note"></i>
623-
</td>
624-
<td class="content">
625-
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>.
626-
</td>
627-
</tr>
628-
</table>
629-
</div>
630-
</div>
631-
<div class="sect2">
632-
<h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.8. Actuator support</h3>
551+
<h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.7. Actuator support</h3>
633552
<div class="ulist">
634553
<ul>
635554
<li>
@@ -793,7 +712,7 @@ <h3 id="actuator-support"><a class="anchor" href="#actuator-support"></a>3.8. Ac
793712
</div>
794713
</div>
795714
<div class="sect2">
796-
<h3 id="spring-cloud-function-web-support"><a class="anchor" href="#spring-cloud-function-web-support"></a>3.9. Spring Cloud Function Web support</h3>
715+
<h3 id="spring-cloud-function-web-support"><a class="anchor" href="#spring-cloud-function-web-support"></a>3.8. Spring Cloud Function Web support</h3>
797716
<div class="paragraph">
798717
<p><code>spring-cloud-function-web</code> exposes Java Function as REST endpoint automatically.
799718
* Since version <code>v1.6.3</code>, the support of functional endpoints has been added.</p>
@@ -888,7 +807,7 @@ <h3 id="spring-cloud-function-web-support"><a class="anchor" href="#spring-cloud
888807
</div>
889808
</div>
890809
<div class="sect2">
891-
<h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.10. Kotlin support</h3>
810+
<h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.9. Kotlin support</h3>
892811
<div class="paragraph">
893812
<p>For a project that uses Kotlin, you should add the following dependency.
894813
This dependency improves the support of Kotlin types:</p>
@@ -898,7 +817,7 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.10. Kotli
898817
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
899818
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
900819
&lt;artifactId&gt;springdoc-openapi-kotlin&lt;/artifactId&gt;
901-
&lt;version&gt;1.6.15&lt;/version&gt;
820+
&lt;version&gt;1.7.0&lt;/version&gt;
902821
&lt;/dependency&gt;</code></pre>
903822
</div>
904823
</div>
@@ -914,7 +833,7 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.10. Kotli
914833
</div>
915834
</div>
916835
<div class="sect2">
917-
<h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.11. Groovy support</h3>
836+
<h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.10. Groovy support</h3>
918837
<div class="paragraph">
919838
<p>For a project that uses Groovy, you should add the following dependency, in combination with the springdoc-openapi-ui dependency:
920839
This dependency improves the support of Kotlin types:</p>
@@ -924,13 +843,13 @@ <h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.11. Groov
924843
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
925844
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
926845
&lt;artifactId&gt;springdoc-openapi-groovy&lt;/artifactId&gt;
927-
&lt;version&gt;1.6.15&lt;/version&gt;
846+
&lt;version&gt;1.7.0&lt;/version&gt;
928847
&lt;/dependency&gt;</code></pre>
929848
</div>
930849
</div>
931850
</div>
932851
<div class="sect2">
933-
<h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.12. Javadoc support</h3>
852+
<h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.11. Javadoc support</h3>
934853
<div class="paragraph">
935854
<p>For a project that wants to enable javadoc support, you should add the following dependency, in combination with the <code>springdoc-openapi-ui</code> dependency:</p>
936855
</div>
@@ -939,7 +858,7 @@ <h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.12. Jav
939858
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
940859
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
941860
&lt;artifactId&gt;springdoc-openapi-javadoc&lt;/artifactId&gt;
942-
&lt;version&gt;1.6.15&lt;/version&gt;
861+
&lt;version&gt;1.7.0&lt;/version&gt;
943862
&lt;/dependency&gt;</code></pre>
944863
</div>
945864
</div>
@@ -2073,7 +1992,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
20731992
<pre class="highlight"><code class="language-xml" data-lang="xml"> &lt;dependency&gt;
20741993
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
20751994
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
2076-
&lt;version&gt;1.6.15&lt;/version&gt;
1995+
&lt;version&gt;1.7.0&lt;/version&gt;
20771996
&lt;/dependency&gt;</code></pre>
20781997
</div>
20791998
</div>
@@ -4345,7 +4264,7 @@ <h3 id="what-is-the-compatibility-matrix-of-springdoc-openapi-with-spring-boot">
43454264
<p><code>springdoc-openapi</code> is compatible with <code>spring-boot 1</code> and <code>spring-boot 2</code>.</p>
43464265
</div>
43474266
<div class="paragraph">
4348-
<p>In general, <strong>you should only pick the last stable version as per today 1.6.15.</strong></p>
4267+
<p>In general, <strong>you should only pick the last stable version as per today 1.7.0.</strong></p>
43494268
</div>
43504269
<div class="paragraph">
43514270
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>

docs/js/setup.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/js/site.js

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/js/site.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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-ui&lt;/artifactId&gt;
47-
&lt;version&gt;1.6.15&lt;/version&gt;
47+
&lt;version&gt;1.7.0&lt;/version&gt;
4848
&lt;/dependency&gt;</code></pre>
4949
</div>
5050
</div>

0 commit comments

Comments
 (0)