Skip to content

Commit 2b9867e

Browse files
bnasslahsenclaude
andcommitted
Fix dead sample-test links in FAQ (#106)
The FAQ referenced sample tests on the springdoc-openapi spring-boot-4 branch (now renamed to main) and at paths that have since moved, so several links 404'd — including the app68 link reported in #106. - app68: point to main and the relocated v30/app68 path - app39: point to main, the v30/app39 path, and the renamed SpringDocApp39Test.java (was SpringDocTestApp.java) - app1: switch the spring-boot-4 branch reference to main - Regenerate docs/ Fixes #106 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent d337660 commit 2b9867e

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/faq.html

Lines changed: 4 additions & 4 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/spring-boot-4/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/spring-boot-4/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/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/v30/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/v30/app68</a></p>
115115
</li>
116116
</ul>
117117
</div>
@@ -662,7 +662,7 @@ <h3 id="_how_can_i_test_the_swagger_ui"><a class="anchor" href="#_how_can_i_test
662662
<div class="ulist">
663663
<ul>
664664
<li>
665-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java</a></p>
665+
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java</a></p>
666666
</li>
667667
</ul>
668668
</div>
@@ -682,7 +682,7 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
682682
<div class="ulist">
683683
<ul>
684684
<li>
685-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
685+
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/v30/app39/SpringDocApp39Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/v30/app39/SpringDocApp39Test.java</a></p>
686686
</li>
687687
</ul>
688688
</div>
@@ -2075,7 +2075,7 @@ <h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a cla
20752075
</div>
20762076
<div id="footer">
20772077
<div id="footer-text">
2078-
Last updated 2026-07-30 23:56:58 +0200
2078+
Last updated 2026-07-31 13:58:07 +0200
20792079
</div>
20802080
</div>
20812081
</div>

docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3356,7 +3356,7 @@ <h3 id="how-can-i-define-multiple-openapi-definitions-in-one-spring-boot-project
33563356
<div class="ulist">
33573357
<ul>
33583358
<li>
3359-
<p><a href="https://github.com/springdoc/springdoc-openapi/tree/spring-boot-4/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/spring-boot-4/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68</a></p>
3359+
<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/v30/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/v30/app68</a></p>
33603360
</li>
33613361
</ul>
33623362
</div>
@@ -3907,7 +3907,7 @@ <h3 id="how-can-i-test-the-swagger-ui"><a class="anchor" href="#how-can-i-test-t
39073907
<div class="ulist">
39083908
<ul>
39093909
<li>
3910-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java</a></p>
3910+
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java</a></p>
39113911
</li>
39123912
</ul>
39133913
</div>
@@ -3927,7 +3927,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
39273927
<div class="ulist">
39283928
<ul>
39293929
<li>
3930-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
3930+
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/v30/app39/SpringDocApp39Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/v30/app39/SpringDocApp39Test.java</a></p>
39313931
</li>
39323932
</ul>
39333933
</div>

src/docs/asciidoc/faq.adoc

Lines changed: 3 additions & 3 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/spring-boot-4/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app68[https://github.com/springdoc/springdoc-openapi/tree/spring-boot-4/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/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/v30/app68[https://github.com/springdoc/springdoc-openapi/tree/main/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/v30/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"].
@@ -314,12 +314,12 @@ springdoc.swagger-ui.path= /swagger-ui/api-docs.html
314314

315315
=== How can I test the Swagger UI?
316316
* You can have a look on this sample test of the UI:
317-
** link:https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java[https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java, window="_blank"]
317+
** link:https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java[https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1Test.java, window="_blank"]
318318

319319
=== How can I customise the OpenAPI object ?
320320
* You can write your own implementation of `OpenApiCustomizer`.
321321
* An example is available on:
322-
** link:https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java[https://github.com/springdoc/springdoc-openapi/blob/spring-boot-4/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java, window="_blank"]
322+
** link:https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/v30/app39/SpringDocApp39Test.java[https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/v30/app39/SpringDocApp39Test.java, window="_blank"]
323323

324324
[source,java]
325325
----

0 commit comments

Comments
 (0)