Skip to content

Commit 756c920

Browse files
bnasslahsenbnasslahsen
committed
docs update
1 parent 07d0f19 commit 756c920

File tree

6 files changed

+12
-194
lines changed

6 files changed

+12
-194
lines changed

‎docs/demos.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
7070
<div class="ulist">
7171
<ul>
7272
<li>
73-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/2.x" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/2.x</a></p>
73+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/master" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/master</a></p>
7474
</li>
7575
</ul>
7676
</div>
@@ -80,7 +80,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
8080
</div>
8181
<div id="footer">
8282
<div id="footer-text">
83-
Last updated 2023-06-20 13:20:53 +0200
83+
Last updated 2024-05-28 15:08:22 +0200
8484
</div>
8585
</div>
8686
</div>

‎docs/faq.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3 id="_how_can_i_define_multiple_openapi_definitions_in_one_spring_boot_projec
111111
<div class="ulist">
112112
<ul>
113113
<li>
114-
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/2.x/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/app68" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/tree/master/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app68</a></p>
114+
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68</a></p>
115115
</li>
116116
</ul>
117117
</div>
@@ -1206,7 +1206,7 @@ <h3 id="_where_can_i_find_the_source_code_of_the_demo_applications"><a class="an
12061206
<div class="ulist">
12071207
<ul>
12081208
<li>
1209-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/2.x" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/2.x</a></p>
1209+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos</a></p>
12101210
</li>
12111211
</ul>
12121212
</div>
@@ -1950,7 +1950,7 @@ <h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a cla
19501950
</div>
19511951
<div id="footer">
19521952
<div id="footer-text">
1953-
Last updated 2024-02-28 22:28:18 +0100
1953+
Last updated 2024-05-28 15:10:18 +0200
19541954
</div>
19551955
</div>
19561956
</div>

‎docs/index.html‎

Lines changed: 3 additions & 185 deletions
Original file line numberDiff line numberDiff line change
@@ -281,20 +281,6 @@ <h2 id="Introduction"><a class="anchor" href="#Introduction"></a>1. Introduction
281281
</div>
282282
<div class="paragraph">
283283
<p>This is a community-based project, not maintained by the Spring Framework Contributors (Pivotal).</p>
284-
</div>
285-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
286-
crossorigin="anonymous"></script>
287-
<!-- HEADER2 -->
288-
<ins class="adsbygoogle"
289-
style="display:block"
290-
data-ad-client="ca-pub-8127371937306964"
291-
data-ad-slot="2654893709"
292-
data-ad-format="auto"
293-
data-full-width-responsive="true"></ins>
294-
<script>
295-
(adsbygoogle = window.adsbygoogle || []).push({});
296-
</script>
297-
</div>
298284
</div>
299285
<div class="sect1">
300286
<h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Getting Started</h2>
@@ -357,20 +343,6 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
357343
<pre class="highlight"><code class="language-properties" data-lang="properties"># swagger-ui custom path
358344
springdoc.swagger-ui.path=/swagger-ui.html</code></pre>
359345
</div>
360-
</div>
361-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
362-
crossorigin="anonymous"></script>
363-
<!-- HEADER2 -->
364-
<ins class="adsbygoogle"
365-
style="display:block"
366-
data-ad-client="ca-pub-8127371937306964"
367-
data-ad-slot="2654893709"
368-
data-ad-format="auto"
369-
data-full-width-responsive="true"></ins>
370-
<script>
371-
(adsbygoogle = window.adsbygoogle || []).push({});
372-
</script>
373-
</div>
374346
</div>
375347
<div class="sect1">
376348
<h2 id="modules"><a class="anchor" href="#modules"></a>3. Springdoc-openapi Modules</h2>
@@ -955,20 +927,6 @@ <h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.11. Jav
955927
</td>
956928
</tr>
957929
</table>
958-
</div>
959-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
960-
crossorigin="anonymous"></script>
961-
<!-- HEADER2 -->
962-
<ins class="adsbygoogle"
963-
style="display:block"
964-
data-ad-client="ca-pub-8127371937306964"
965-
data-ad-slot="2654893709"
966-
data-ad-format="auto"
967-
data-full-width-responsive="true"></ins>
968-
<script>
969-
(adsbygoogle = window.adsbygoogle || []).push({});
970-
</script>
971-
</div>
972930
</div>
973931
</div>
974932
<div class="sect1">
@@ -1276,20 +1234,6 @@ <h3 id="integration-with-wildfly"><a class="anchor" href="#integration-with-wild
12761234
&lt;version&gt;0.1.0&lt;/version&gt;
12771235
&lt;/dependency&gt;</code></pre>
12781236
</div>
1279-
</div>
1280-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
1281-
crossorigin="anonymous"></script>
1282-
<!-- HEADER2 -->
1283-
<ins class="adsbygoogle"
1284-
style="display:block"
1285-
data-ad-client="ca-pub-8127371937306964"
1286-
data-ad-slot="2654893709"
1287-
data-ad-format="auto"
1288-
data-full-width-responsive="true"></ins>
1289-
<script>
1290-
(adsbygoogle = window.adsbygoogle || []).push({});
1291-
</script>
1292-
</div>
12931237
</div>
12941238
</div>
12951239
<div class="sect1">
@@ -1851,20 +1795,6 @@ <h3 id="swagger-ui-properties"><a class="anchor" href="#swagger-ui-properties"><
18511795
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. If set to true, the swagger-ui will be accessible from the application root path directly.</p></td>
18521796
</tr>
18531797
</tbody>
1854-
</table>
1855-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
1856-
crossorigin="anonymous"></script>
1857-
<!-- HEADER2 -->
1858-
<ins class="adsbygoogle"
1859-
style="display:block"
1860-
data-ad-client="ca-pub-8127371937306964"
1861-
data-ad-slot="2654893709"
1862-
data-ad-format="auto"
1863-
data-full-width-responsive="true"></ins>
1864-
<script>
1865-
(adsbygoogle = window.adsbygoogle || []).push({});
1866-
</script>
1867-
</div>
18681798
</div>
18691799
</div>
18701800
<div class="sect1">
@@ -1973,20 +1903,6 @@ <h3 id="gradle-plugin"><a class="anchor" href="#gradle-plugin"></a>6.2. Gradle p
19731903
<p><a href="https://github.com/springdoc/springdoc-openapi-gradle-plugin" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-gradle-plugin</a></p>
19741904
</li>
19751905
</ul>
1976-
</div>
1977-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
1978-
crossorigin="anonymous"></script>
1979-
<!-- HEADER2 -->
1980-
<ins class="adsbygoogle"
1981-
style="display:block"
1982-
data-ad-client="ca-pub-8127371937306964"
1983-
data-ad-slot="2654893709"
1984-
data-ad-format="auto"
1985-
data-full-width-responsive="true"></ins>
1986-
<script>
1987-
(adsbygoogle = window.adsbygoogle || []).push({});
1988-
</script>
1989-
</div>
19901906
</div>
19911907
</div>
19921908
<div class="sect1">
@@ -2030,23 +1946,9 @@ <h3 id="source-code-of-the-demo-applications"><a class="anchor" href="#source-co
20301946
<div class="ulist">
20311947
<ul>
20321948
<li>
2033-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/2.x" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/2.x</a></p>
1949+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/master" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/master</a></p>
20341950
</li>
20351951
</ul>
2036-
</div>
2037-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
2038-
crossorigin="anonymous"></script>
2039-
<!-- HEADER2 -->
2040-
<ins class="adsbygoogle"
2041-
style="display:block"
2042-
data-ad-client="ca-pub-8127371937306964"
2043-
data-ad-slot="2654893709"
2044-
data-ad-format="auto"
2045-
data-full-width-responsive="true"></ins>
2046-
<script>
2047-
(adsbygoogle = window.adsbygoogle || []).push({});
2048-
</script>
2049-
</div>
20501952
</div>
20511953
</div>
20521954
<div class="sect1">
@@ -2236,20 +2138,6 @@ <h2 id="migrating-from-springdoc-v1"><a class="anchor" href="#migrating-from-spr
22362138
<p>Replace <code>springdoc-openapi-webflux-ui</code> by <code>springdoc-openapi-starter-webflux-ui</code></p>
22372139
</li>
22382140
</ul>
2239-
</div>
2240-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
2241-
crossorigin="anonymous"></script>
2242-
<!-- HEADER2 -->
2243-
<ins class="adsbygoogle"
2244-
style="display:block"
2245-
data-ad-client="ca-pub-8127371937306964"
2246-
data-ad-slot="2654893709"
2247-
data-ad-format="auto"
2248-
data-full-width-responsive="true"></ins>
2249-
<script>
2250-
(adsbygoogle = window.adsbygoogle || []).push({});
2251-
</script>
2252-
</div>
22532141
</div>
22542142
<div class="sect1">
22552143
<h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-springfox"></a>9. Migrating from SpringFox</h2>
@@ -2433,20 +2321,6 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
24332321
</div>
24342322
</li>
24352323
</ul>
2436-
</div>
2437-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
2438-
crossorigin="anonymous"></script>
2439-
<!-- HEADER2 -->
2440-
<ins class="adsbygoogle"
2441-
style="display:block"
2442-
data-ad-client="ca-pub-8127371937306964"
2443-
data-ad-slot="2654893709"
2444-
data-ad-format="auto"
2445-
data-full-width-responsive="true"></ins>
2446-
<script>
2447-
(adsbygoogle = window.adsbygoogle || []).push({});
2448-
</script>
2449-
</div>
24502324
</div>
24512325
<div class="sect1">
24522326
<h2 id="other-resources"><a class="anchor" href="#other-resources"></a>10. Other resources</h2>
@@ -2504,20 +2378,6 @@ <h3 id="dependencies-repository"><a class="anchor" href="#dependencies-repositor
25042378
<p><a href="https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/" target="_blank" rel="noopener">https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/</a></p>
25052379
</li>
25062380
</ul>
2507-
</div>
2508-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
2509-
crossorigin="anonymous"></script>
2510-
<!-- HEADER2 -->
2511-
<ins class="adsbygoogle"
2512-
style="display:block"
2513-
data-ad-client="ca-pub-8127371937306964"
2514-
data-ad-slot="2654893709"
2515-
data-ad-format="auto"
2516-
data-full-width-responsive="true"></ins>
2517-
<script>
2518-
(adsbygoogle = window.adsbygoogle || []).push({});
2519-
</script>
2520-
</div>
25212381
</div>
25222382
</div>
25232383
<div class="sect1">
@@ -2601,20 +2461,6 @@ <h3 id="benefits-of-being-a-gold-sponsor"><a class="anchor" href="#benefits-of-b
26012461
<p>If issues are not created by the end of the month, the remaining ones are lost.</p>
26022462
</li>
26032463
</ul>
2604-
</div>
2605-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
2606-
crossorigin="anonymous"></script>
2607-
<!-- HEADER2 -->
2608-
<ins class="adsbygoogle"
2609-
style="display:block"
2610-
data-ad-client="ca-pub-8127371937306964"
2611-
data-ad-slot="2654893709"
2612-
data-ad-format="auto"
2613-
data-full-width-responsive="true"></ins>
2614-
<script>
2615-
(adsbygoogle = window.adsbygoogle || []).push({});
2616-
</script>
2617-
</div>
26182464
</div>
26192465
</div>
26202466
<div class="sect1">
@@ -2634,20 +2480,6 @@ <h2 id="thanks"><a class="anchor" href="#thanks"></a>12. Special Thanks</h2>
26342480
<div class="content">
26352481
<img src="img/jetbrains.svg" alt="JetBrains">
26362482
</div>
2637-
</div>
2638-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
2639-
crossorigin="anonymous"></script>
2640-
<!-- HEADER2 -->
2641-
<ins class="adsbygoogle"
2642-
style="display:block"
2643-
data-ad-client="ca-pub-8127371937306964"
2644-
data-ad-slot="2654893709"
2645-
data-ad-format="auto"
2646-
data-full-width-responsive="true"></ins>
2647-
<script>
2648-
(adsbygoogle = window.adsbygoogle || []).push({});
2649-
</script>
2650-
</div>
26512483
</div>
26522484
<div class="sect1">
26532485
<h2 id="faq"><a class="anchor" href="#faq"></a>13. F.A.Q</h2>
@@ -2731,7 +2563,7 @@ <h3 id="how-can-i-define-multiple-openapi-definitions-in-one-spring-boot-project
27312563
<div class="ulist">
27322564
<ul>
27332565
<li>
2734-
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/2.x/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/app68" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/tree/master/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app68</a></p>
2566+
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68</a></p>
27352567
</li>
27362568
</ul>
27372569
</div>
@@ -3826,7 +3658,7 @@ <h3 id="where-can-i-find-the-source-code-of-the-demo-applications"><a class="anc
38263658
<div class="ulist">
38273659
<ul>
38283660
<li>
3829-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/2.x" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/2.x</a></p>
3661+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos</a></p>
38303662
</li>
38313663
</ul>
38323664
</div>
@@ -4563,20 +4395,6 @@ <h3 id="some-parameters-are-not-generated-in-the-resulting-openapi-spec"><a clas
45634395
&lt;/configuration&gt;
45644396
&lt;/plugin&gt;</code></pre>
45654397
</div>
4566-
</div>
4567-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
4568-
crossorigin="anonymous"></script>
4569-
<!-- HEADER2 -->
4570-
<ins class="adsbygoogle"
4571-
style="display:block"
4572-
data-ad-client="ca-pub-8127371937306964"
4573-
data-ad-slot="2654893709"
4574-
data-ad-format="auto"
4575-
data-full-width-responsive="true"></ins>
4576-
<script>
4577-
(adsbygoogle = window.adsbygoogle || []).push({});
4578-
</script>
4579-
</div>
45804398
</div>
45814399
</div>
45824400
</div>

‎docs/modules.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
619619
</div>
620620
<div id="footer">
621621
<div id="footer-text">
622-
Last updated 2024-03-12 11:47:39 +0100
622+
Last updated 2024-05-12 13:59:45 +0200
623623
</div>
624624
</div>
625625
</div>

‎src/docs/asciidoc/demos.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
image::img/pets.png[pets.png]
1414

1515
=== Source code of the Demo Applications
16-
* link:https://github.com/springdoc/springdoc-openapi-demos/tree/2.x[https://github.com/springdoc/springdoc-openapi-demos/tree/2.x, window="_blank"]
16+
* link:https://github.com/springdoc/springdoc-openapi-demos/tree/master[https://github.com/springdoc/springdoc-openapi-demos/tree/master, window="_blank"]

‎src/docs/asciidoc/faq.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public GroupedOpenApi groupOpenApi() {
6060

6161
For more details about the usage, you can have a look at the following sample Test:
6262

63-
* link:https://github.com/springdoc/springdoc-openapi/tree/2.x/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/app68[https://github.com/springdoc/springdoc-openapi/tree/master/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app68, window="_blank"]
63+
* link:https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68[https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68, window="_blank"]
6464

6565
=== How can I configure Swagger UI?
6666
* The support of the swagger official properties is available on `springdoc-openapi`. See link:https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/[Official documentation, window="_blank"].
@@ -562,7 +562,7 @@ public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
562562

563563
=== Where can I find the source code of the demo applications?
564564
* The source code of the application is available at the following GitHub repository:
565-
** link:https://github.com/springdoc/springdoc-openapi-demos/tree/2.x[https://github.com/springdoc/springdoc-openapi-demos/tree/2.x, window="_blank"]
565+
** link:https://github.com/springdoc/springdoc-openapi-demos[https://github.com/springdoc/springdoc-openapi-demos, window="_blank"]
566566

567567
=== Does this library supports annotations from interfaces?
568568
* Yes

0 commit comments

Comments
 (0)