Skip to content

docs: clarify Retry series+statuses interaction and AddRequestHeader comma limitation#4201

Open
won-seoop wants to merge 1 commit into
spring-cloud:mainfrom
won-seoop:doc-1896-comma-header-and-1536-retry-series
Open

docs: clarify Retry series+statuses interaction and AddRequestHeader comma limitation#4201
won-seoop wants to merge 1 commit into
spring-cloud:mainfrom
won-seoop:doc-1896-comma-header-and-1536-retry-series

Conversation

@won-seoop

Copy link
Copy Markdown
Contributor

Summary

Closes #1536
Closes #1896

  • Retry filter (series + statuses interaction): When both series and statuses are set on the Retry GatewayFilter, a retry is only triggered when the response matches the series AND is listed in statuses. This was confusing to users who expected statuses alone to be sufficient. Added a clarifying sentence and guidance to set series to an empty list when retrying by specific status codes only.

  • AddRequestHeader comma limitation: The shortcut notation AddRequestHeader=Name, Value splits on the first comma, so any header value containing a literal comma is silently truncated. Added a NOTE callout with the expanded name/value workaround in both the WebFlux and WebMVC docs.

Test plan

  • Verify NOTE renders correctly in Antora docs build
  • Confirm expanded-form YAML example is syntactically valid
  • Confirm series: [] / series: null YAML example is accurate for the Retry filter

…on in AddRequestHeader

spring-cloudGH-1536: When both `series` and `statuses` are configured on the Retry
filter, a retry occurs only when the response matches both. Documents
how to retry on specific status codes without any series restriction.

spring-cloudGH-1896: The AddRequestHeader shortcut notation parses on the first
comma, so header values containing commas must use the expanded
name/value form. Added a NOTE with an example for both WebFlux and
WebMVC docs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ryanjbaxter

Copy link
Copy Markdown
Contributor

Please separate this into 2 different PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Comma separated header values Document setting specific series to null with status codes in retry filter.

3 participants