feat: support the HTTP QUERY method (RFC 10008) - #4007
Open
gentritabazi wants to merge 1 commit into
Open
Conversation
gentritabazi
force-pushed
the
feat/http-query-method
branch
from
July 14, 2026 07:33
5ab2c5f to
17aba2a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
PathItemObjecthas noqueryoperation field, so routes declared with the new HTTP QUERY method (RFC 10008, added toRequestMethodin nestjs/nest#17162) cannot be represented in the generated OpenAPI document.Issue Number: N/A
What is the new behavior?
PathItemObjectaccepts an optionalqueryoperation, so controllers usingRequestMethod.QUERYare exposed under thequerymethod in the generated document — including theirrequestBody(QUERY is defined as a safe method that carries a body). A test covers a@RequestMapping({ method: RequestMethod.QUERY })route end to end throughSwaggerExplorer, asserting the method, path, request body schema, and response.Note: the
queryoperation key requires OpenAPI >= 3.2.0, so documents using it should set the version viaDocumentBuilder#setOpenAPIVersion('3.2.0').Does this PR introduce a breaking change?
Other information
Depends on nestjs/nest#17162 (
RequestMethod.QUERY). The added test will pass once a@nestjs/commonrelease includes that enum member.