fix(resolver): use spec compliant JSON Pointer implementation #3920
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the resolver to use a spec-compliant JSON Pointer implementation. Key changes include updates to error messages in tests, switching to the new modern JSON Pointer module with updated parameter ordering in evaluation calls, and dependency version bumps in package.json.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/schema-object/index.js | Updates error message regex to reflect the new JSON Pointer error output. |
| test/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/path-item-object/index.js | Adjusts error message regex consistent with the modern implementation. |
| src/resolver/strategies/openapi-3-1-apidom/resolve.js | Switches to '@swagger-api/apidom-json-pointer/modern' and inverts the argument order for jsonPointerEvaluate; refines error handling. |
| src/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitors/dereference.js | Updates JSON Pointer calls to use the new modern module and adjusts parameter order accordingly. |
| package.json | Bumps apidom dependency versions from beta.31 to beta.37. |
| .eslintrc.js | Adds the modern JSON Pointer module to the ESLint allowed import list. |
Comments suppressed due to low confidence (2)
src/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitors/dereference.js:123
- Confirm that the updated parameter order in jsonPointerEvaluate calls is consistent with the intended usage from the new @swagger-api/apidom-json-pointer/modern module across all invocations.
let referencedElement = jsonPointerEvaluate(reference.value.result, jsonPointer);
src/resolver/strategies/openapi-3-1-apidom/resolve.js:162
- Ensure that replacing multiple error types with a single JSONPointerEvaluateError covers all failure modes that were previously handled.
if (error instanceof JSONPointerEvaluateError) {
glowcloud
approved these changes
May 15, 2025
swagger-bot
pushed a commit
that referenced
this pull request
May 15, 2025
## [3.35.1](v3.35.0...v3.35.1) (2025-05-15) ### Bug Fixes * **resolver:** use spec compliant JSON Pointer implementation ([#3920](#3920)) ([4a39db7](4a39db7))
|
🎉 This PR is included in version 3.35.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
No description provided.