spring-cloud / spring-cloud/spring-cloud-gateway
RemoveJsonAttributesResponseBody filter does not exists in WebMVC context : remove it from documentation or implement it
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.9k
- Forks
- 3.5k
- Avg merge
- 20h 57m
- Merged PRs (30d)
- 8
Description
Describe the bug
Hi,
when we read Spring Gateway documentation, we can think that RemoveJsonAttributesResponseBody can be used in WebMVC context :
- https://docs.spring.io/spring-cloud-gateway/reference/spring-cloud-gateway-server-webmvc/filters/removejsonattributesresponsebody.html
- https://github.com/spring-cloud/spring-cloud-gateway/blob/main/docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/removejsonattributesresponsebody.adoc#removejsonattributesresponsebody-filter
But in fact, this filter does not exist in WebMVC context :
Caused by: java.lang.IllegalArgumentException: Unable to find operation interface org.springframework.web.servlet.function.HandlerFilterFunction for removeJsonAttributesResponseBody with args {_genkey_0=myjsonattribute}
No RemoveJsonAttributesResponseBody class found in sources : https://github.com/spring-cloud/spring-cloud-gateway/tree/main/spring-cloud-gateway-server-webmvc/src/main/java/org/springframework/cloud/gateway/server/mvc/filter
-> Please update documentation or implement this filter : it is very important, because we are doing design based on documentation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/removejsonattributesresponsebody.adoc and inspect the spring-cloud-gateway-server-webmvc/src/main/java/org/springframework/cloud/gateway/server/mvc/filter directory. Compare the documented filter with the available WebMVC filters and determine whether the documentation should be removed or the filter implemented; done means the documentation and WebMVC behavior agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring, spring-boot
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100