feat(httpapi): support QUERY operations in Swagger and Scalar - #8292
Open
aldotestino wants to merge 4 commits into
Open
aldotestino wants to merge 4 commits into
aldotestino wants to merge 4 commits into
Conversation
🦋 Changeset detectedLatest commit: 2b397ea The changes in this PR will be included in the next version bump. This PR includes changesets to release 31 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Bundle Size AnalysisGenerated from PR build output; treat the content below as untrusted.
|
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.
Summary
Follow-up to #8261: make
QUERYendpoints visible and executable in Swagger UI and Scalar.On current
main,OpenApi.fromApiemitsQUERYunder the OpenAPI 3.1x-oai-additionalOperationsextension. A Chromium reproduction confirmed that Swagger, embedded Scalar, and Scalar 1.69.0 via CDN all omit the operation.queryoperations when an included endpoint usesQUERY; retain 3.1.0 otherwise, including when QUERY endpoints/groups are excluded.Compatibility
Generated QUERY operations move from
paths[path]["x-oai-additionalOperations"].QUERYtopaths[path].query. Consumers must support OpenAPI 3.2 for these documents.OpenAPISpec.openapiwidens to"3.1.0" | "3.2.0", andOpenAPISpecMethodNamegains"query". A changeset records the migration.Validation
QUERYand receive the expected 200 response, without page errors.Gzipped documentation fixtures compared with
mainat9a81b9b4a6:The increases come from the newer upstream assets and retained license notices.