-
Notifications
You must be signed in to change notification settings - Fork 198
feat: add support for 'x-query' operation in PathItem type #2501
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
🦋 Changeset detectedLatest commit: 5d52434 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 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 |
|
📦 A new experimental 🧪 version v0.0.0-snapshot.1768999175 of Redocly CLI has been published for testing. Install with NPM: npm install @redocly/cli@0.0.0-snapshot.1768999175
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1768999175
# or
npm install @redocly/respect-core@0.0.0-snapshot.1768999175 |
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||
|
| "@redocly/openapi-core": patch | ||
| --- | ||
|
|
||
| Added bundling and dereference handling for `x-query` operations in OpenAPI 3.0 and 3.1. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Added bundling and dereference handling for `x-query` operations in OpenAPI 3.0 and 3.1. | |
| Allowed `x-query` operations names in OpenAPI 3.0 and 3.1 similar to `query` in OpenAPI 3.2. |
@Redocly/technical-writers, could you re-review it?
tatomyr
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
I wonder if the original issue is still relevant though. I think that anyone who wants to use query can simply switch to OAS 3.2 as it's backward compatible with previous 3.x versions.
What/Why/How?
What: Add support for parsing
x-queryas anOperationon OAS3PathItemWhy: Refs nested under
x-querywere not being resolved/bundled the same way as refs under standard HTTP operations (e.g.get).How: Extend the OAS3 type tree to treat
x-queryas anOperation.Reference
Issue: https://github.com/Redocly/redocly/issues/12876
PR: https://github.com/Redocly/redocly/pull/20434
Testing
Screenshots (optional)
Check yourself
Security