From fabd4c44d6841a0459a77f1b992854029d6de0d8 Mon Sep 17 00:00:00 2001 From: sgibb Date: Mon, 11 Sep 2023 16:12:20 -0400 Subject: [PATCH] Fix cross references --- .../pages/spring-cloud-gateway/actuator-api.adoc | 14 +++++++------- .../circuitbreaker-filter-factory.adoc | 2 +- .../gatewayfilter-factories/fallback-headers.adoc | 2 +- .../local-cache-response-filter.adoc | 2 +- .../the-requestratelimiter-factory.adoc | 2 +- .../pages/spring-cloud-gateway/global-filters.adoc | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/actuator-api.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/actuator-api.adoc index e7121585..2de0a8d0 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/actuator-api.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/actuator-api.adoc @@ -57,13 +57,13 @@ This will default to `true` in a future release. This section details how to retrieve route filters, including: -* <> +* xref:spring-cloud-gateway/actuator-api.adoc#gateway-global-filters[Global Filters] * <> [[gateway-global-filters]] === Global Filters -To retrieve the <> applied to all routes, make a `GET` request to `/actuator/gateway/globalfilters`. The resulting response is similar to the following: +To retrieve the xref:spring-cloud-gateway/global-filters.adoc[global filters] applied to all routes, make a `GET` request to `/actuator/gateway/globalfilters`. The resulting response is similar to the following: ==== ---- @@ -81,11 +81,11 @@ To retrieve the <> applied to all routes, make a ==== The response contains the details of the global filters that are in place. -For each global filter, there is a string representation of the filter object (for example, `org.springframework.cloud.gateway.filter.ReactiveLoadBalancerClientFilter@77856cc5`) and the corresponding <> in the filter chain. +For each global filter, there is a string representation of the filter object (for example, `org.springframework.cloud.gateway.filter.ReactiveLoadBalancerClientFilter@77856cc5`) and the corresponding xref:spring-cloud-gateway/global-filters.adoc#gateway-combined-global-filter-and-gatewayfilter-ordering[order] in the filter chain. [[gateway-route-filters]] === Route Filters -To retrieve the <> applied to routes, make a `GET` request to `/actuator/gateway/routefilters`. +To retrieve the xref:spring-cloud-gateway/gatewayfilter-factories.adoc[`GatewayFilter` factories] applied to routes, make a `GET` request to `/actuator/gateway/routefilters`. The resulting response is similar to the following: ==== @@ -185,7 +185,7 @@ The following table describes the structure of each element (each is a route) of |`route_object.filters` | Array -| The <> applied to the route. +| The xref:spring-cloud-gateway/gatewayfilter-factories.adoc[`GatewayFilter` factories] applied to the route. |`order` | Number @@ -245,14 +245,14 @@ The following table describes the structure of the response: [[creating-and-deleting-a-particular-route-definition]] == Creating and Deleting a Particular Route Definition -To create a route definition, make a `POST` request to `/gateway/routes/{id_route_to_create}` with a JSON body that specifies the fields of the route (see <>). +To create a route definition, make a `POST` request to `/gateway/routes/{id_route_to_create}` with a JSON body that specifies the fields of the route (see xref:spring-cloud-gateway/actuator-api.adoc#gateway-retrieving-information-about-a-particular-route[Retrieving Information about a Particular Route]). To delete a route definition, make a `DELETE` request to `/gateway/routes/{id_route_to_delete}`. [[creating-multiple-route-definitions]] == Creating multiple Route Definitions -To create multiple route definitions in a single request, make a `POST` request to `/gateway/routes` with a JSON body that specifies the fields of the route, including the route id (see <>). +To create multiple route definitions in a single request, make a `POST` request to `/gateway/routes` with a JSON body that specifies the fields of the route, including the route id (see xref:spring-cloud-gateway/actuator-api.adoc#gateway-retrieving-information-about-a-particular-route[Retrieving Information about a Particular Route]). The route definitions will be discarded if any route raises an error during the creation of the routes. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/circuitbreaker-filter-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/circuitbreaker-filter-factory.adoc index cb401860..5eaf85b8 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/circuitbreaker-filter-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/circuitbreaker-filter-factory.adoc @@ -131,7 +131,7 @@ In case of the request being forwarded to fallback, the Spring Cloud CircuitBrea It is added to the `ServerWebExchange` as the `ServerWebExchangeUtils.CIRCUITBREAKER_EXECUTION_EXCEPTION_ATTR` attribute that can be used when handling the fallback within the gateway application. For the external controller/handler scenario, headers can be added with exception details. -You can find more information on doing so in the <>. +You can find more information on doing so in the xref:spring-cloud-gateway/gatewayfilter-factories/fallback-headers.adoc[FallbackHeaders GatewayFilter Factory section]. [[circuit-breaker-status-codes]] == Tripping The Circuit Breaker On Status Codes diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/fallback-headers.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/fallback-headers.adoc index 645b003d..ad3c6ddc 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/fallback-headers.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/fallback-headers.adoc @@ -41,5 +41,5 @@ You can overwrite the names of the headers in the configuration by setting the v * `rootCauseExceptionTypeHeaderName` (`"Root-Cause-Exception-Type"`) * `rootCauseExceptionMessageHeaderName` (`"Root-Cause-Exception-Message"`) -For more information on circuit breakers and the gateway see the <>. +For more information on circuit breakers and the gateway see the xref:spring-cloud-gateway/gatewayfilter-factories/circuitbreaker-filter-factory.adoc[Spring Cloud CircuitBreaker Factory section]. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/local-cache-response-filter.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/local-cache-response-filter.adoc index e7a3d01f..a2144361 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/local-cache-response-filter.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/local-cache-response-filter.adoc @@ -8,7 +8,7 @@ This filter allows caching the response body and headers to follow these rules: * Response data is not cached if `Cache-Control` header does not allow it (`no-store` present in the request or `no-store` or `private` present in the response). * If the response is already cached and a new request is performed with no-cache value in `Cache-Control` header, it returns a bodiless response with 304 (Not Modified). -This filter configures the local response cache per route and is available only if the `spring.cloud.gateway.filter.local-response-cache.enabled` property is enabled. And a <> is also available as feature. +This filter configures the local response cache per route and is available only if the `spring.cloud.gateway.filter.local-response-cache.enabled` property is enabled. And a xref:spring-cloud-gateway/global-filters.adoc#local-cache-response-global-filter[local response cache configured globally] is also available as feature. It accepts the first parameter to override the time to expire a cache entry (expressed in `s` for seconds, `m` for minutes, and `h` for hours) and a second parameter to set the maximum size of the cache to evict entries for this route (`KB`, `MB`, or `GB`). diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestratelimiter-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestratelimiter-factory.adoc index 8d72465e..b1efabf7 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestratelimiter-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestratelimiter-factory.adoc @@ -3,7 +3,7 @@ The `RequestRateLimiter` `GatewayFilter` factory uses a `RateLimiter` implementation to determine if the current request is allowed to proceed. If it is not, a status of `HTTP 429 - Too Many Requests` (by default) is returned. -This filter takes an optional `keyResolver` parameter and parameters specific to the rate limiter (described <>). +This filter takes an optional `keyResolver` parameter and parameters specific to the rate limiter (described xref:spring-cloud-gateway/gatewayfilter-factories/the-requestratelimiter-factory.adoc#key-resolver-section[later in this section]). `keyResolver` is a bean that implements the `KeyResolver` interface. In configuration, reference the bean by name using SpEL. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/global-filters.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/global-filters.adoc index 801055fe..c10f9cad 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/global-filters.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/global-filters.adoc @@ -12,7 +12,7 @@ NOTE: This interface and its usage are subject to change in future milestone rel When a request matches a route, the filtering web handler adds all instances of `GlobalFilter` and all route-specific instances of `GatewayFilter` to a filter chain. This combined filter chain is sorted by the `org.springframework.core.Ordered` interface, which you can set by implementing the `getOrder()` method. -As Spring Cloud Gateway distinguishes between "`pre`" and "`post`" phases for filter logic execution (see <>), the filter with the highest precedence is the first in the "`pre`"-phase and the last in the "`post`"-phase. +As Spring Cloud Gateway distinguishes between "`pre`" and "`post`" phases for filter logic execution (see xref:spring-cloud-gateway/how-it-works.adoc[How it Works]), the filter with the highest precedence is the first in the "`pre`"-phase and the last in the "`post`"-phase. The following listing configures a filter chain: @@ -87,7 +87,7 @@ This filter also implements the automatic calculation of the `max-age` value in If `max-age` is present on the original response, the value is rewritten with the number of seconds set in the `timeToLive` configuration parameter. In subsequent calls, this value is recalculated with the number of seconds left until the response expires. -Setting `spring.cloud.gateway.global-filter.local-response-cache.enabled` to `false` deactivate the local response cache for all routes, the <> allows to use this functionality at route level. +Setting `spring.cloud.gateway.global-filter.local-response-cache.enabled` to `false` deactivate the local response cache for all routes, the xref:spring-cloud-gateway/gatewayfilter-factories/local-cache-response-filter.adoc[LocalResponseCache filter] allows to use this functionality at route level. NOTE: To enable this feature, add `com.github.ben-manes.caffeine:caffeine` and `spring-boot-starter-cache` as project dependencies.