docs: Improve SpringQueryMap documentation by bombo-dev · Pull Request #1163 · spring-cloud/spring-cloud-openfeign

bombo-dev · 2025-02-11T16:17:02Z

Problem

When using the @SpringQueryMap annotation, it was difficult to discover the existence of the QueryMapEncoder class.
The reference path is as follows:
@SpringQueryMap -> @QueryMap -> @Param Usage All

Additionally, when using @SpringQueryMap, the default injected implementation is FieldQueryMapEncoder.
However, in FeignClientsConfiguration, the injected bean can change depending on the @ConditionalOnClass condition.

@Bean
@ConditionalOnClass(name = "org.springframework.data.domain.Pageable")
@ConditionalOnMissingBean
public QueryMapEncoder feignQueryMapEncoderPageable() {
	PageableSpringQueryMapEncoder queryMapEncoder = new PageableSpringQueryMapEncoder();
	if (springDataWebProperties != null) {
		queryMapEncoder.setPageParameter(springDataWebProperties.getPageable().getPageParameter());
		queryMapEncoder.setSizeParameter(springDataWebProperties.getPageable().getSizeParameter());
		queryMapEncoder.setSortParameter(springDataWebProperties.getSort().getSortParameter());
	}
	return queryMapEncoder;
}

Although FieldQueryMapEncoder is marked as deprecated in QueryMapEncoder, it still functions as the default implementation.

Solution

I have explicitly specified this behavior in the annotation documentation.
I encountered this issue while debugging, and it took me a long time to identify the cause.
By adding this information, I hope others can find the relevant details more quickly.

Consideration

I initially considered adding the note:

"The default implementation is FieldQueryMapEncoder, but it can change to PageableSpringQueryMapEncoder depending on the conditions."

However, since this behavior is subject to change, I decided not to include it.
If necessary, I am open to adding this detail.

…cloud#1045) Bumps [com.google.protobuf:protobuf-java](https://github.com/protocolbuffers/protobuf) from 3.25.3 to 3.25.4. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/main/protobuf_release.bzl) - [Commits](protocolbuffers/protobuf@v3.25.3...v3.25.4) --- updated-dependencies: - dependency-name: com.google.protobuf:protobuf-java dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…g-cloud#1042) Bumps [com.fasterxml.jackson.dataformat:jackson-dataformat-smile](https://github.com/FasterXML/jackson-dataformats-binary) from 2.17.1 to 2.17.2. - [Commits](FasterXML/jackson-dataformats-binary@jackson-dataformats-binary-2.17.1...jackson-dataformats-binary-2.17.2) --- updated-dependencies: - dependency-name: com.fasterxml.jackson.dataformat:jackson-dataformat-smile dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

# Conflicts: # pom.xml

--- updated-dependencies: - dependency-name: "@antora/collector-extension" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@springio/asciidoctor-extensions](https://github.com/spring-io/asciidoctor-extensions) from 1.0.0-alpha.10 to 1.0.0-alpha.13. - [Changelog](https://github.com/spring-io/asciidoctor-extensions/blob/main/CHANGELOG.adoc) - [Commits](spring-io/asciidoctor-extensions@v1.0.0-alpha.10...v1.0.0-alpha.13) --- updated-dependencies: - dependency-name: "@springio/asciidoctor-extensions" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…d#1063) Bumps [antora](https://gitlab.com/antora/antora) from 3.2.0-alpha.4 to 3.2.0-alpha.6. - [Changelog](https://gitlab.com/antora/antora/blob/main/CHANGELOG.adoc) - [Commits](https://gitlab.com/antora/antora/compare/v3.2.0-alpha.4...v3.2.0-alpha.6) --- updated-dependencies: - dependency-name: antora dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

# Conflicts: # docs/package.json

* Make Content-Encoding configurable A new configuration property was added to make the Content-Encoding configurable when using the feign request compression. The default values are the same as the previous hardcoded values. Closes issue 1048

Bumps commons-io:commons-io from 2.16.1 to 2.17.0. --- updated-dependencies: - dependency-name: commons-io:commons-io dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…cloud#1090) Bumps [com.google.protobuf:protobuf-java](https://github.com/protocolbuffers/protobuf) from 3.25.4 to 3.25.5. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/main/protobuf_release.bzl) - [Commits](protocolbuffers/protobuf@v3.25.4...v3.25.5) --- updated-dependencies: - dependency-name: com.google.protobuf:protobuf-java dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

spring-cloud#1087) Bumps [com.google.protobuf:protobuf-java](https://github.com/protocolbuffers/protobuf) from 3.25.4 to 3.25.5. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/main/protobuf_release.bzl) - [Commits](protocolbuffers/protobuf@v3.25.4...v3.25.5) --- updated-dependencies: - dependency-name: com.google.protobuf:protobuf-java dependency-type: direct:development ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [io.github.openfeign:feign-bom](https://github.com/openfeign/feign) from 13.3 to 13.4. - [Release notes](https://github.com/openfeign/feign/releases) - [Changelog](https://github.com/OpenFeign/feign/blob/master/CHANGELOG.md) - [Commits](OpenFeign/feign@13.3...13.4) --- updated-dependencies: - dependency-name: io.github.openfeign:feign-bom dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* polishing feignClientsRegistrar * update the date in the license and add author

…g-cloud#1097) Bumps [com.fasterxml.jackson.dataformat:jackson-dataformat-smile](https://github.com/FasterXML/jackson-dataformats-binary) from 2.17.2 to 2.18.0. - [Commits](FasterXML/jackson-dataformats-binary@jackson-dataformats-binary-2.17.2...jackson-dataformats-binary-2.18.0) --- updated-dependencies: - dependency-name: com.fasterxml.jackson.dataformat:jackson-dataformat-smile dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

@see

…onfiguration In SpringQueryMap - Added @see references to feign.QueryMapEncoder and FeignClientsConfiguration - Improved documentation for better discoverability Signed-off-by: Bombo-Dev <[email protected]>

OlgaMaciaszek

Hello @bombo-dev, thanks for submitting the PR. Looks good, but could you submit this against 4.1.x instead of main, so that it also gets picked to earlier release trains?

bombo-dev · 2025-03-12T23:28:37Z

Hello @bombo-dev, thanks for submitting the PR. Looks good, but could you submit this against 4.1.x instead of main, so that it also gets picked to earlier release trains?

Hello @OlgaMaciaszek, thank you for your response.
I have changed the base branch from main to 4.1.x. I appreciate your guidance.

OlgaMaciaszek · 2025-03-13T09:39:42Z

Hello @bombo-dev the base branch cannot be just changed. The easiest way to correctly change the branch would be to close this PR and create a new one by applying your commits to the 4.1.x branch.

ryanjbaxter and others added 30 commits August 7, 2024 11:22

Fixing compile errors for new Boot and Spring Framework versions

f0dbdc9

Bumping versions

b715d5e

Update SNAPSHOT to 4.2.0-M1

f232205

Going back to snapshots

72e74b2

Bumping versions

88b05dd

Update GitHub actions.

fc1093e

Merge remote-tracking branch 'origin/main'

16229ce

Update dependabot.

e0c3f7e

Merge remote-tracking branch 'origin/4.1.x'

220faec

# Conflicts: # pom.xml

Add dependabot checks for npm.

cea0947

Bumping versions

b5c78b1

Merge remote-tracking branch 'origin/4.1.x'

73af460

Merge remote-tracking branch 'origin/main'

076dd29

Merge remote-tracking branch 'origin/4.1.x'

a11a442

# Conflicts: # docs/package.json

Merge remote-tracking branch 'origin/4.1.x'

d3ecd5c

Adds ignorecase field to pageable spring (spring-cloud#1047)

fec17ae

Merge remote-tracking branch 'origin/4.1.x'

eca3b0b

polishing FeignClientsRegistrar (spring-cloud#1038)

1c00226

* polishing feignClientsRegistrar * update the date in the license and add author

Merge remote-tracking branch 'origin/4.1.x'

964d3c8

spring-builds and others added 8 commits January 25, 2025 04:44

Bumping versions

ad19228

Update SNAPSHOT to 4.3.0-M1

ee1bbd9

Going back to snapshots

5095ef4

Merge remote-tracking branch 'origin/4.1.x' into 4.2.x

b5ca153

Merge remote-tracking branch 'origin/4.2.x'

a3befcc

Update dependabot settings.

596b2be

Merge remote-tracking branch 'origin/4.1.x' into 4.2.x

99239f6

Merge remote-tracking branch 'origin/4.2.x'

0d30431

spring-cloud-issues added the waiting-for-triage label Feb 11, 2025

docs: docs: Add references to Feign QueryMapEncoder and FeignClientsC…

6153105

…onfiguration In SpringQueryMap - Added @see references to feign.QueryMapEncoder and FeignClientsConfiguration - Improved documentation for better discoverability Signed-off-by: Bombo-Dev <[email protected]>

bombo-dev force-pushed the docs-querymap branch from b63e575 to 6153105 Compare February 11, 2025 16:31

OlgaMaciaszek added documentation and removed waiting-for-triage labels Mar 12, 2025

OlgaMaciaszek added this to 2024.0.1, 2025.0.0-M3 and 2023.0.6 Mar 12, 2025

OlgaMaciaszek moved this to In Progress in 2023.0.6 Mar 12, 2025

OlgaMaciaszek moved this to In Progress in 2024.0.1 Mar 12, 2025

OlgaMaciaszek moved this to In Progress in 2025.0.0-M3 Mar 12, 2025

OlgaMaciaszek added this to the 4.1.5 milestone Mar 12, 2025

OlgaMaciaszek requested changes Mar 12, 2025

View reviewed changes

bombo-dev changed the base branch from main to 4.1.x March 12, 2025 23:26

bombo-dev mentioned this pull request Mar 14, 2025

docs: Improve SpringQueryMap documentation #1172

Closed

bombo-dev closed this Mar 14, 2025

github-project-automation Bot moved this from In Progress to Done in 2023.0.6 Mar 14, 2025

github-project-automation Bot moved this from In Progress to Done in 2025.0.0-M3 Mar 14, 2025

github-project-automation Bot moved this from In Progress to Done in 2024.0.1 Mar 14, 2025

bombo-dev mentioned this pull request Mar 14, 2025

docs: Improve SpringQueryMap documentation #1173

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Improve SpringQueryMap documentation#1163

docs: Improve SpringQueryMap documentation#1163
bombo-dev wants to merge 84 commits intospring-cloud:4.1.xfrom
bombo-dev:docs-querymap

bombo-dev commented Feb 11, 2025

Uh oh!

OlgaMaciaszek left a comment

Uh oh!

bombo-dev commented Mar 12, 2025

Uh oh!

OlgaMaciaszek commented Mar 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Conversation

bombo-dev commented Feb 11, 2025

Problem

Solution

Consideration

Uh oh!

OlgaMaciaszek left a comment

Choose a reason for hiding this comment

Uh oh!

bombo-dev commented Mar 12, 2025

Uh oh!

OlgaMaciaszek commented Mar 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants