Updates documentation to correct RewriteLocationResponseHeaderGateway…

…FilterFactory parameters and default value Fixes #2753 Co-authored-by: ice2shell <[email protected]>
spring-cloud · Mar 8, 2024 · f6182df · f6182df
1 parent c40af36
commit f6182df
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/...loud-gateway/gatewayfilter-factories/rewritelocationresponseheader-factory.adoc b/...loud-gateway/gatewayfilter-factories/rewritelocationresponseheader-factory.adoc
@@ -2,7 +2,7 @@
 = `RewriteLocationResponseHeader` `GatewayFilter` Factory
 
 The `RewriteLocationResponseHeader` `GatewayFilter` factory modifies the value of the `Location` response header, usually to get rid of backend-specific details.
-It takes the `stripVersionMode`, `locationHeaderName`, `hostValue`, and `protocolsRegex` parameters.
+It takes the `Mode`, `locationHeaderName`, `hostValue`, and `protocols` parameters.
 The following listing configures a `RewriteLocationResponseHeader` `GatewayFilter`:
 
 .application.yml
@@ -20,7 +20,7 @@ spring:
 
 For example, for a request of `POST https://api.example.com/some/object/name`, the `Location` response header value of `https://object-service.prod.example.net/v2/some/object/id` is rewritten as `https://api.example.com/some/object/id`.
 
-The `stripVersionMode` parameter has the following possible values: `NEVER_STRIP`, `AS_IN_REQUEST` (default), and `ALWAYS_STRIP`.
+The `Mode` parameter has the following possible values: `NEVER_STRIP`, `AS_IN_REQUEST` (default), and `ALWAYS_STRIP`.
 
 * `NEVER_STRIP`: The version is not stripped, even if the original request path contains no version.
 * `AS_IN_REQUEST`: The version is stripped only if the original request path contains no version.
@@ -29,7 +29,7 @@ The `stripVersionMode` parameter has the following possible values: `NEVER_STRIP
 The `hostValue` parameter, if provided, is used to replace the `host:port` portion of the response `Location` header.
 If it is not provided, the value of the `Host` request header is used.
 
-The `protocolsRegex` parameter must be a valid regex `String`, against which the protocol name is matched.
+The `protocols` parameter must be a valid regex `String`, against which the protocol name is matched.
 If it is not matched, the filter does nothing.
-The default is `http|https|ftp|ftps`.
+The default is `https?|ftps?`.