Add clarification for route match behavior (#19363)

* Add clarification for route match behavior * Update website/content/docs/connect/config-entries/service-defaults.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --------- Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
hashicorp · Oct 25, 2023 · 6360c74 · 6360c74
1 parent a7803bd
commit 6360c74
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/agent/structs/config_entry.go b/agent/structs/config_entry.go
@@ -418,6 +418,7 @@ type InstanceLevelRateLimits struct {
 	RequestsMaxBurst int `alias:"requests_max_burst"`
 
 	// Routes is a list of rate limits applied to specific routes.
+	// For a given request, the first matching route will be applied, if any.
 	// Overrides any top-level configuration.
 	Routes []InstanceLevelRouteRateLimits
 }

diff --git a/api/config_entry.go b/api/config_entry.go
@@ -341,6 +341,7 @@ type InstanceLevelRateLimits struct {
 	RequestsMaxBurst int `alias:"requests_max_burst"`
 
 	// Routes is a list of rate limits applied to specific routes.
+	// For a given request, the first matching route will be applied, if any
 	// Overrides any top-level configuration.
 	Routes []InstanceLevelRouteRateLimits
 }

diff --git a/website/content/docs/connect/config-entries/service-defaults.mdx b/website/content/docs/connect/config-entries/service-defaults.mdx
@@ -649,7 +649,7 @@ Specifies a list of rate limiting configurations to apply to specific routes to
 - `PathPrefix`
 - `PathRegex`
 
-Refer to [Examples](#enable-request-rate-limit-on-a-prefixed-path) for example configurations.
+Consul applies the rate limit configuration to the first matching route for each request. Refer to [Examples](#enable-request-rate-limit-on-a-prefixed-path) for example configurations.
 
 #### Values