Improve Javadoc for use of ApiVersionInserter

Closes gh-35565
This commit is contained in:
rstoyanchev
2025-10-08 12:24:21 +01:00
parent 00543becf8
commit 03e379b070
7 changed files with 31 additions and 2 deletions
@@ -447,6 +447,9 @@ public interface WebTestClient {
* Configure an {@link ApiVersionInserter} to abstract how an API version
* specified via {@link RequestHeadersSpec#apiVersion(Object)}
* is inserted into the request.
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
* built-in inserter implementation types. See the class-level Javadoc
* of {@link ApiVersionInserter} for a list of choices.
* @param apiVersionInserter the inserter to use
* @since 7.0
*/
@@ -263,6 +263,9 @@ public interface RestTestClient {
* Configure an {@link ApiVersionInserter} to abstract how an API version
* specified via {@link RequestHeadersSpec#apiVersion(Object)}
* is inserted into the request.
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
* built-in inserter implementation types. See the class-level Javadoc
* of {@link ApiVersionInserter} for a list of choices.
* @param apiVersionInserter the inserter to use
*/
<T extends B> T apiVersionInserter(ApiVersionInserter apiVersionInserter);
@@ -496,6 +496,9 @@ public abstract class AbstractMockHttpServletRequestBuilder<B extends AbstractMo
* An inserter may typically be set once (more centrally) via
* {@link org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder#defaultRequest(RequestBuilder)}, or
* {@link org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder#apiVersionInserter(ApiVersionInserter)}.
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
* built-in inserter implementation types. See the class-level Javadoc
* of {@link ApiVersionInserter} for a list of choices.
* @param versionInserter the inserter to use
* @since 7.0
*/
@@ -80,6 +80,9 @@ public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder
/**
* Set the {@link ApiVersionInserter} to use to apply to versions specified via
* {@link org.springframework.test.web.servlet.request.AbstractMockHttpServletRequestBuilder#apiVersion(Object)}.
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
* built-in inserter implementation types. See the class-level Javadoc
* of {@link ApiVersionInserter} for a list of choices.
* @param versionInserter the inserter to use
* @since 7.0
*/