Skip to content

Commit aa9cc17

Browse files
bnasslahsenclaude
andcommitted
Fix remaining dead links in FAQ (root and v2)
Full external-link audit of the docs turned up a few more broken links: - faq.adoc / v2/faq.adoc: the swagger-ui configuration link displayed a github main-branch URL that 404s (swagger-ui's default branch is master); align the display text with the working master target. - v2/faq.adoc: fix the app68 and app39 sample-test links the same way as the root FAQ (relocated under v30/, and SpringDocTestApp.java renamed to SpringDocApp39Test.java). - Regenerate docs/ Note: v1 archived docs intentionally keep their historical 1.x links; dzone and baeldung URLs are bot-blocked (403) but valid; swagger.io/springshop occurrences are inside Java code samples, not hyperlinks. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 2b9867e commit aa9cc17

6 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/faq.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,7 +1589,7 @@ <h3 id="_how_can_i_enable_csrf_support"><a class="anchor" href="#_how_can_i_enab
15891589
<div class="ulist">
15901590
<ul>
15911591
<li>
1592-
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor</a></p>
1592+
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor</a></p>
15931593
</li>
15941594
</ul>
15951595
</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-31 13:58:07 +0200
2078+
Last updated 2026-07-31 14:12:58 +0200
20792079
</div>
20802080
</div>
20812081
</div>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4834,7 +4834,7 @@ <h3 id="how-can-i-enable-csrf-support"><a class="anchor" href="#how-can-i-enable
48344834
<div class="ulist">
48354835
<ul>
48364836
<li>
4837-
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor</a></p>
4837+
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor</a></p>
48384838
</li>
48394839
</ul>
48404840
</div>

docs/v2/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/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>
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>
@@ -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/main/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/main/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>
@@ -1589,7 +1589,7 @@ <h3 id="_how_can_i_enable_csrf_support"><a class="anchor" href="#_how_can_i_enab
15891589
<div class="ulist">
15901590
<ul>
15911591
<li>
1592-
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor</a></p>
1592+
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor</a></p>
15931593
</li>
15941594
</ul>
15951595
</div>
@@ -2127,7 +2127,7 @@ <h3 id="_some_parameters_are_not_generated_in_the_resulting_openapi_spec"><a cla
21272127
</div>
21282128
<div id="footer">
21292129
<div id="footer-text">
2130-
Last updated 2026-07-30 23:56:58 +0200
2130+
Last updated 2026-07-31 14:13:41 +0200
21312131
</div>
21322132
</div>
21332133
</div>

docs/v2/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2791,7 +2791,7 @@ <h3 id="how-can-i-define-multiple-openapi-definitions-in-one-spring-boot-project
27912791
<div class="ulist">
27922792
<ul>
27932793
<li>
2794-
<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>
2794+
<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>
27952795
</li>
27962796
</ul>
27972797
</div>
@@ -3362,7 +3362,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
33623362
<div class="ulist">
33633363
<ul>
33643364
<li>
3365-
<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/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/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
3365+
<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>
33663366
</li>
33673367
</ul>
33683368
</div>
@@ -4269,7 +4269,7 @@ <h3 id="how-can-i-enable-csrf-support"><a class="anchor" href="#how-can-i-enable
42694269
<div class="ulist">
42704270
<ul>
42714271
<li>
4272-
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor</a></p>
4272+
<p><a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor" target="_blank" rel="noopener">https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor</a></p>
42734273
</li>
42744274
</ul>
42754275
</div>

src/docs/asciidoc/faq.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ If the CSRF Token is required, swagger-ui automatically sends the new XSRF-TOKEN
764764

765765
If your XSRF-TOKEN isn't standards-based, you can use a requestInterceptor to manually capture and attach the latest xsrf token to requests programmatically via spring resource transformer:
766766

767-
* link:https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor[https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor, window="_blank"]
767+
* link:https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor[https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor, window="_blank"]
768768

769769
Starting from release v1.4.4 of springdoc-openapi, a new property is added to enable CSRF support, while using standard header names:
770770
[source,properties]

src/docs/asciidoc/v2/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/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"]
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"].
@@ -317,7 +317,7 @@ springdoc.swagger-ui.path= /swagger-ui/api-docs.html
317317
=== How can I customise the OpenAPI object ?
318318
* You can write your own implementation of `OpenApiCustomizer`.
319319
* An example is available on:
320-
** link:https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java[https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java, window="_blank"]
320+
** 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"]
321321

322322
[source,java]
323323
----
@@ -762,7 +762,7 @@ If the CSRF Token is required, swagger-ui automatically sends the new XSRF-TOKEN
762762

763763
If your XSRF-TOKEN isn't standards-based, you can use a requestInterceptor to manually capture and attach the latest xsrf token to requests programmatically via spring resource transformer:
764764

765-
* link:https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor[https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md#requestinterceptor, window="_blank"]
765+
* link:https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor[https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#requestinterceptor, window="_blank"]
766766

767767
Starting from release v1.4.4 of springdoc-openapi, a new property is added to enable CSRF support, while using standard header names:
768768
[source,properties]

0 commit comments

Comments
 (0)