Skip to content

Commit 85c18ca

Browse files
committed
Update docs on supported versions with baseline notation
Closes gh-36316
1 parent 22bd8bd commit 85c18ca

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

framework-docs/modules/ROOT/pages/web/webflux/controller/ann-requestmapping.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,8 @@ Once API versioning is enabled, you can begin to map requests with versions.
394394
The `@RequestMapping` `version` attribute supports the following:
395395

396396
- Fixed version ("1.2") -- matches the given version only
397-
- Baseline version ("1.2+") -- matches the given version and above
397+
- Baseline version ("1.2+") -- matches the given and
398+
xref:web/webflux/config.adoc#webflux-config-api-version[supported versions] above
398399
- No value -- matches any version, but is superseded by a more specific version match
399400

400401
If multiple controller methods have a version less than or equal to the request version,
@@ -443,6 +444,9 @@ For request with version `"1.3"`:
443444
- (3) matches as it matches 1.2 and above, and is *chosen* as the highest match
444445
- (4) is higher and does not match
445446

447+
NOTE: Version 1.3 must be present in the mappings, or be
448+
xref:web/webflux/config.adoc#webflux-config-api-version[configured as supported].
449+
446450
For request with version `"1.5"`:
447451

448452
- (1) matches as it matches any version
@@ -459,10 +463,6 @@ versioned alternative was introduced. Therefore, even though an unversioned cont
459463
method is considered a match for any version, it is in fact given the lowest priority,
460464
and is effectively superseded by any alternative controller method with a version.
461465

462-
NOTE: The above assumes the request version is a
463-
xref:web/webflux/config.adoc#webflux-config-api-version["supported" version],
464-
or otherwise it would fail.
465-
466466
See xref:web/webflux-versioning.adoc[API Versioning] for more details on underlying
467467
infrastructure and support for API Versioning.
468468

framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-requestmapping.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ Once API versioning is enabled, you can begin to map requests with versions.
425425
The `@RequestMapping` `version` attribute supports the following:
426426

427427
- Fixed version ("1.2") -- matches the given version only
428-
- Baseline version ("1.2+") -- matches the given version and above
428+
- Baseline version ("1.2+") -- matches the given and xref:web/webmvc/mvc-config/api-version.adoc[supported versions] above
429429
- No value -- matches any version, but is superseded by a more specific version match
430430

431431
If multiple controller methods have a version less than or equal to the request version,
@@ -463,7 +463,7 @@ Java::
463463
----
464464
<1> match any version
465465
<2> match version 1.1
466-
<3> match version 1.2 and above
466+
<3> match version 1.2 and supported versions above
467467
<4> match version 1.5
468468
======
469469

@@ -474,6 +474,9 @@ For request with version `"1.3"`:
474474
- (3) matches as it matches 1.2 and above, and is *chosen* as the highest match
475475
- (4) is higher and does not match
476476

477+
NOTE: Version 1.3 must be present in the mappings, or be
478+
xref:web/webmvc/mvc-config/api-version.adoc[configured as supported].
479+
477480
For request with version `"1.5"`:
478481

479482
- (1) matches as it matches any version
@@ -490,10 +493,6 @@ versioned alternative was introduced. Therefore, even though an unversioned cont
490493
method is considered a match for any version, it is in fact given the lowest priority,
491494
and is effectively superseded by any alternative controller method with a version.
492495

493-
NOTE: The above assumes the request version is a
494-
xref:web/webmvc/mvc-config/api-version.adoc["supported" version], or otherwise it
495-
would fail.
496-
497496
See xref:web/webmvc-versioning.adoc[API Versioning] for more details on underlying
498497
infrastructure and support for API Versioning.
499498

0 commit comments

Comments
 (0)