Skip to content

fix(resolver): dereference same-document $refs for non-http(s) base URIs #4258

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.

Sign up for GitHub

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

Open
arpitnath wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(resolver): dereference same-document $refs for non-http(s) base URIs #4258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce2bce9
fix(resolver): dereference same-document $refs for non-http(s) base URIs
arpitnath Aug 7, 2026
fca1aa2
Merge branch 'main' into fix/oas31-unknown-scheme-ref-resolution
arpitnath Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...pidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitors/dereference.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,13 @@ class OpenAPI3_1SwaggerClientDereferenceVisitor extends OpenAPI3_1DereferenceVis
* No SchemaElement($id=URL) was not found, so we're going to try to resolve
* the URL and assume the returned response is a JSON Schema.
*/
if (isURL && error instanceof EvaluationJsonSchemaUriError) {
const isSameDocumentReference =
$refBaseURIStrippedHash === url.stripHash(this.reference.uri);

if (
(isURL || (isUnknownURI && isSameDocumentReference)) &&
error instanceof EvaluationJsonSchemaUriError
) {
if (isAnchor(uriToAnchor($refBaseURI))) {
// we're dealing with JSON Schema $anchor here
isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
Expand Down
16 changes: 16 additions & 0 deletions test/resolver/strategies/openapi-3-1-apidom/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,22 @@ describe('resolve', () => {
expect(resolvedSpec).toMatchSnapshot();
});
});

describe('and baseDoc option has a non-http(s) scheme', () => {
test('should dereference internal $refs', async () => {
const spec = globalThis.loadJsonFile(path.join(fixturePath, 'petstore.json'));
const resolvedSpec = await SwaggerClient.resolve({
spec,
baseDoc: 'file:///app/index.html',
});

expect(resolvedSpec.errors).toEqual([]);
expect(
resolvedSpec.spec.paths['/pets'].get.responses['200'].content['application/json']
.schema
).toMatchObject({ type: 'array' });
});
});
});

describe('and url option is provided', () => {
Expand Down