Merge branch 'youngwonseo-fix/faq-customizer-example'

Author: bnasslahsen

docs/getting-started.html

@@ -107,7 +107,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-05-04 17:38:06 +0200
+Last updated 2025-05-04 17:47:09 +0200
 </div>
 </div>
 </div>

docs/modules.html

@@ -641,7 +641,7 @@ <h3 id="_springdoc_openapi_bom"><a class="anchor" href="#_springdoc_openapi_bom"
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-05-04 17:38:06 +0200
+Last updated 2025-05-04 17:47:09 +0200
 </div>
 </div>
 </div>

docs/v1/faq.html

@@ -653,7 +653,7 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
 <div class="ulist">
 <ul>
 <li>
-<p><a href="https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app39/SpringDocApp39Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
+<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app39/SpringDocTestApp.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app39/SpringDocTestApp.java</a></p>
 </li>
 </ul>
 </div>
@@ -663,9 +663,9 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Bean
-public OpenApiCustomiser consumerTypeHeaderOpenAPICustomiser() {
-return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
-    .forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
+public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
+    return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
+            .forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myGlobalHeader")));
 }
 </code></pre>
 </div>
@@ -2002,7 +2002,7 @@ <h3 id="_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_o
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-05-04 16:36:35 +0200
+Last updated 2025-05-04 17:48:15 +0200
 </div>
 </div>
 </div>

docs/v1/getting-started.html

@@ -96,7 +96,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-05-04 17:38:06 +0200
+Last updated 2025-05-04 17:47:09 +0200
 </div>
 </div>
 </div>

docs/v1/index.html

@@ -2865,7 +2865,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
 <div class="ulist">
 <ul>
 <li>
-<p><a href="https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app39/SpringDocApp39Test.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java</a></p>
+<p><a href="https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app39/SpringDocTestApp.java" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app39/SpringDocTestApp.java</a></p>
 </li>
 </ul>
 </div>
@@ -2875,9 +2875,9 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Bean
-public OpenApiCustomiser consumerTypeHeaderOpenAPICustomiser() {
-return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
-    .forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
+public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
+    return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
+            .forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myGlobalHeader")));
 }
 </code></pre>
 </div>

docs/v1/modules.html

@@ -564,7 +564,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-05-04 17:38:06 +0200
+Last updated 2025-05-04 17:47:09 +0200
 </div>
 </div>
 </div>

src/docs/asciidoc/v1/faq.adoc

@@ -301,14 +301,14 @@ springdoc.swagger-ui.path= /swagger-ui/api-docs.html
 === How can I customise the OpenAPI object?
 * You can write your own implementation of `OpenApiCustomizer`.
 * An example is available on:
-** link:https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app39/SpringDocApp39Test.java[https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app39/SpringDocTestApp.java, window="_blank"]
+** link:https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app39/SpringDocTestApp.java[https://github.com/springdoc/springdoc-openapi/blob/main/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app39/SpringDocTestApp.java, window="_blank"]
 
 [source,java]
 ----
 @Bean
-public OpenApiCustomiser consumerTypeHeaderOpenAPICustomiser() {
-return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathItem.readOperations().stream())
-    .forEach(operation -> operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
+public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
+    return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathItem.readOperations().stream())
+            .forEach(operation -> operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myGlobalHeader")));
 }
 ----