Skip to content

docs(server-webflux): updating gateway actuator documentation as per …#4163

Merged
ryanjbaxter merged 2 commits into
spring-cloud:mainfrom
03hjain:issue-3246-gateway-actuator-updates
May 20, 2026
Merged

docs(server-webflux): updating gateway actuator documentation as per …#4163
ryanjbaxter merged 2 commits into
spring-cloud:mainfrom
03hjain:issue-3246-gateway-actuator-updates

Conversation

@03hjain

@03hjain 03hjain commented May 6, 2026

Copy link
Copy Markdown

…issue raised

Fixes gh-3246

Link : #3246

Signed-off-by: Himanshu Jain <03hjain@gmail.com>

…issue raised

    Fixes spring-cloudgh-3246

    Signed-off-by: Himanshu Jain <03hjain@gmail.com>

Signed-off-by: Himanshu Jain <03hjain@gmail.com>
@03hjain 03hjain force-pushed the issue-3246-gateway-actuator-updates branch from 813c9d3 to d6d93f6 Compare May 6, 2026 01:45
@ryanjbaxter

Copy link
Copy Markdown
Contributor

There are a lot of changed here that make it hard to pick out which ones are related to the issue this is trying to solve. Can you comment on the specific changes that address the issue so we know where to focus our attention. In addition some changes seem unnecessary (like spaces) can you remove those?

@03hjain

03hjain commented May 8, 2026

Copy link
Copy Markdown
Author

Hi @ryanjbaxter, thanks for the review..Here's where the key changes are:

  1. GET /routes example — the original showed internal Java Lambda class strings that users never actually see. Updated it to show the real verbose output (the default), and fixed the table to match.
  2. GET /routes/{id} — added the missing intro sentence and a note explaining that the response format is different from what you need to send in a POST — this was a core part of the confusion in the issue. Also fixed the table which incorrectly listed predicates as an Array when it's actually a single predicate string.
  3. "Creating and Deleting" section — this is the main fix for the issue:
  • Added a warning that trying to delete a config-defined route silently returns 200 OK without actually doing anything
  • Added a working POST body example — the original just pointed to the GET response format which doesn't work for POST at all
  • Added a warning about a bug where POSTing to an existing route ID duplicates it and causes a 500 on the next GET /routes
  • Added the delete then recreate steps as the correct way to update a route
  1. Recap table — updated the POST and DELETE descriptions to reflect the above.

NOTE: I am cleaning up and fixing the commit to avoid any other changes which is not listed above. Will be pushing now. Thanks

When `spring.cloud.gateway.actuator.verbose.enabled=false`, the response uses an internal non-verbose format where predicates and filters are shown as raw Java class strings instead of human-readable descriptions.
Verbose mode is enabled by default and is the recommended setting.
====
NOTE: When `spring.cloud.gateway.actuator.verbose.enabled=false`, predicates and filters are shown as raw Java class strings instead of human-readable descriptions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The right property is spring.cloud.gateway.server.webflux.actuator.verbose.enabled

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. Looks like I referred wrong page link https://docs.spring.io/spring-cloud-gateway/reference/spring-cloud-gateway-server-webflux/actuator-api.html , Let me double check and fix.

Comment thread docs/modules/ROOT/pages/spring-cloud-gateway-server-webflux/actuator-api.adoc Outdated
…issue raised

Fixes spring-cloudgh-3246

Signed-off-by: Himanshu Jain <03hjain@gmail.com>
@03hjain 03hjain force-pushed the issue-3246-gateway-actuator-updates branch from 5cb8a65 to f6a5a6d Compare May 20, 2026 02:12
@ryanjbaxter ryanjbaxter added this to the 5.0.2 milestone May 20, 2026
@github-project-automation github-project-automation Bot moved this to Todo in 2025.1.2 May 20, 2026
@ryanjbaxter ryanjbaxter merged commit 59d25c9 into spring-cloud:main May 20, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in 2025.1.2 May 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

Documentation for gateway actuators is patchy

3 participants