Skip to content

Conversation

@n0rahh
Copy link

@n0rahh n0rahh commented Jan 21, 2026

What/Why/How?

What: Add support for parsing x-query as an Operation on OAS3 PathItem

Why: Refs nested under x-query were 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-query as an Operation.

Reference

Issue: https://github.com/Redocly/redocly/issues/12876
PR: https://github.com/Redocly/redocly/pull/20434

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with Redoc/Realm/Reunite (internal)
  • All new/updated code is covered by tests
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

@changeset-bot
Copy link

changeset-bot bot commented Jan 21, 2026

🦋 Changeset detected

Latest commit: 5d52434

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@redocly/openapi-core Patch
@redocly/cli Patch
@redocly/respect-core Patch

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

@n0rahh n0rahh added the snapshot Create experimental release PR label Jan 21, 2026
@github-actions
Copy link
Contributor

📦 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

⚠️ Note: This is a development build and may contain unstable features.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 78.67% (🎯 78%) 6209 / 7892
🔵 Statements 78.09% (🎯 78%) 6413 / 8212
🔵 Functions 81.99% (🎯 81%) 1266 / 1544
🔵 Branches 70.45% (🎯 70%) 4258 / 6044
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
packages/core/src/types/oas3.ts 75.36% 31.81% 66.66% 75.36% 344, 351, 460-463, 494-518
Generated in workflow #8385 for commit 5d52434 by the Vitest Coverage Report Action

@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

CLI Version Mean Time ± Std Dev (s) Relative Performance (Lower is Faster)
cli-latest 3.452s ± 0.033s ▓ 1.00x
cli-next 3.437s ± 0.008s ▓ 1.00x (Fastest)

@n0rahh n0rahh marked this pull request as ready for review January 22, 2026 11:07
@n0rahh n0rahh requested review from a team as code owners January 22, 2026 11:07
"@redocly/openapi-core": patch
---

Added bundling and dereference handling for `x-query` operations in OpenAPI 3.0 and 3.1.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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?

Copy link
Collaborator

@tatomyr tatomyr left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

snapshot Create experimental release PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants