Skip to content

Commit a4651af

Browse files
bnasslahsenbnasslahsen
committed
Merge branch 'youngwonseo-fix/faq-customizer-example'
2 parents caf2a79 + 5de2ab0 commit a4651af

File tree

7 files changed

+17
-17
lines changed

7 files changed

+17
-17
lines changed

‎docs/getting-started.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
107107
</div>
108108
<div id="footer">
109109
<div id="footer-text">
110-
Last updated 2025-05-04 17:38:06 +0200
110+
Last updated 2025-05-04 17:47:09 +0200
111111
</div>
112112
</div>
113113
</div>

‎docs/modules.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ <h3 id="_springdoc_openapi_bom"><a class="anchor" href="#_springdoc_openapi_bom"
641641
</div>
642642
<div id="footer">
643643
<div id="footer-text">
644-
Last updated 2025-05-04 17:38:06 +0200
644+
Last updated 2025-05-04 17:47:09 +0200
645645
</div>
646646
</div>
647647
</div>

‎docs/v1/faq.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,7 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
653653
<div class="ulist">
654654
<ul>
655655
<li>
656-
<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>
656+
<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>
657657
</li>
658658
</ul>
659659
</div>
@@ -663,9 +663,9 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
663663
<div class="listingblock">
664664
<div class="content">
665665
<pre class="highlight"><code class="language-java" data-lang="java">@Bean
666-
public OpenApiCustomiser consumerTypeHeaderOpenAPICustomiser() {
667-
return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
668-
.forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
666+
public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
667+
return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
668+
.forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myGlobalHeader")));
669669
}
670670
</code></pre>
671671
</div>
@@ -2002,7 +2002,7 @@ <h3 id="_why_am_i_getting_an_error_swagger_ui_unable_to_render_definition_when_o
20022002
</div>
20032003
<div id="footer">
20042004
<div id="footer-text">
2005-
Last updated 2025-05-04 16:36:35 +0200
2005+
Last updated 2025-05-04 17:48:15 +0200
20062006
</div>
20072007
</div>
20082008
</div>

‎docs/v1/getting-started.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
9696
</div>
9797
<div id="footer">
9898
<div id="footer-text">
99-
Last updated 2025-05-04 17:38:06 +0200
99+
Last updated 2025-05-04 17:47:09 +0200
100100
</div>
101101
</div>
102102
</div>

‎docs/v1/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -2865,7 +2865,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
28652865
<div class="ulist">
28662866
<ul>
28672867
<li>
2868-
<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>
2868+
<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>
28692869
</li>
28702870
</ul>
28712871
</div>
@@ -2875,9 +2875,9 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
28752875
<div class="listingblock">
28762876
<div class="content">
28772877
<pre class="highlight"><code class="language-java" data-lang="java">@Bean
2878-
public OpenApiCustomiser consumerTypeHeaderOpenAPICustomiser() {
2879-
return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
2880-
.forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
2878+
public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
2879+
return openApi -&gt; openApi.getPaths().values().stream().flatMap(pathItem -&gt; pathItem.readOperations().stream())
2880+
.forEach(operation -&gt; operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myGlobalHeader")));
28812881
}
28822882
</code></pre>
28832883
</div>

‎docs/v1/modules.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -564,7 +564,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
564564
</div>
565565
<div id="footer">
566566
<div id="footer-text">
567-
Last updated 2025-05-04 17:38:06 +0200
567+
Last updated 2025-05-04 17:47:09 +0200
568568
</div>
569569
</div>
570570
</div>

‎src/docs/asciidoc/v1/faq.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -301,14 +301,14 @@ springdoc.swagger-ui.path= /swagger-ui/api-docs.html
301301
=== How can I customise the OpenAPI object?
302302
* You can write your own implementation of `OpenApiCustomizer`.
303303
* An example is available on:
304-
** 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"]
304+
** 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"]
305305

306306
[source,java]
307307
----
308308
@Bean
309-
public OpenApiCustomiser consumerTypeHeaderOpenAPICustomiser() {
310-
return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathItem.readOperations().stream())
311-
.forEach(operation -> operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
309+
public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
310+
return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathItem.readOperations().stream())
311+
.forEach(operation -> operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myGlobalHeader")));
312312
}
313313
----
314314

0 commit comments

Comments
 (0)