add base uri customizer for OpenAPI 3.2

hauner · hauner · commit f1e0fc9125d1 · 2025-08-02T19:00:57.000+02:00
diff --git a/json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/schema/Resolver.java b/json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/schema/Resolver.java
@@ -6,13 +6,15 @@
 package io.openapiprocessor.jsonschema.schema;
 
 import io.openapiprocessor.jsonschema.support.Types;
+import io.openapiprocessor.jsonschema.support.Uris;
 import org.checkerframework.checker.nullness.qual.Nullable;
-import org.checkerframework.checker.nullness.qual.PolyNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.net.URI;
 
+import static io.openapiprocessor.jsonschema.schema.SchemaVersionUtil.getSchemaVersion;
+
 /**
  * loads the base document and resolves all internal and external $ref's. In case of an external
  * $ref it automatically downloads the referenced document if {@code autoLoadSchemas} is enabled.
@@ -26,8 +28,9 @@ public class Resolver {
     private static final Logger log = LoggerFactory.getLogger (Resolver.class);
 
     public static class Settings {
-        private SchemaVersion version;
+        private final SchemaVersion version;
         private boolean autoLoadSchemas = false;
+        private @Nullable BaseUriCustomizer baseUriCustomizer;
 
         public Settings (SchemaVersion version) {
             this.version = version;
@@ -38,11 +41,26 @@ public Settings autoLoadSchemas (boolean load) {
             return this;
         }
 
+        public Settings baseUriCustomizer(BaseUriCustomizer provider) {
+            this.baseUriCustomizer = provider;
+            return this;
+        }
+
         public SchemaVersion getVersion () {
             return version;
         }
     }
 
+    public interface BaseUriCustomizer {
+        /**
+         * get a base uri from a document if available.
+         *
+         * @param document the document
+         * @return base uri or null
+         */
+        @Nullable URI get (URI documentUri, Object document);
+    }
+
     private final DocumentStore documents;
     private final DocumentLoader loader;
 
@@ -95,9 +113,9 @@ public ResolverResult resolve (String resourcePath, Settings settings) {
     public ResolverResult resolve (URI documentUri, Object document, Settings settings) {
         ReferenceRegistry registry = new ReferenceRegistry ();
 
-        documents.addId (documentUri, document);
-        Scope scope = Scope.createScope (documentUri, document, settings.version);
-        Bucket bucket = toBucket (scope, document);
+        Scope scope = createScope(documentUri, document, settings);
+        documents.addId (scope.getBaseUri(), document);
+        Bucket bucket = Bucket.createBucket(scope, document);
 
         if (bucket == null) {
             return new ResolverResult (scope, document, registry, documents);
@@ -114,10 +132,23 @@ public ResolverResult resolve (URI documentUri, Object document, Settings settin
         return new ResolverResult (scope, document, registry, documents);
     }
 
-    private @Nullable Bucket toBucket (Scope scope, @PolyNull Object source) {
-        if (!Types.isObject (source)) {
-            return null;
+    Scope createScope(URI documentUri, Object document, Settings settings) {
+        SchemaVersion version = getSchemaVersion(documentUri, document, settings.version);
+
+        if (settings.baseUriCustomizer != null) {
+            @Nullable URI baseUri = settings.baseUriCustomizer.get(documentUri, document);
+            if (baseUri != null) {
+                return Scope.createScope(documentUri, Uris.resolve(documentUri, baseUri), version);
+            }
         }
-        return new Bucket (scope, Types.asObject (source));
+
+        if (Types.isObject(document)) {
+            String id = version.getIdProvider().getId(Types.asObject(document));
+            if (id != null) {
+                return Scope.createScope(documentUri, Uris.resolve(documentUri, id), version);
+            }
+        }
+
+        return Scope.createScope(documentUri, null, version);
     }
 }
diff --git a/json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/schema/Scope.java b/json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/schema/Scope.java
@@ -54,6 +54,10 @@ public static Scope createScope (URI documentUri, Object document, SchemaVersion
         return new Scope (documentUri, Uris.resolve(documentUri, id), version);
     }
 
+    public static Scope createScope (URI documentUri, @Nullable URI baseUri, SchemaVersion version) {
+        return new Scope (documentUri, baseUri, version);
+    }
+
     /**
      * create the scope for the {@code document}. If {@code document} contains an id, it is the base uri, otherwise the
      * scope is the {@code documentUri}. If the {@code documentUri} matches a know json schema the result scope will use
diff --git a/json-schema-validator/src/test/kotlin/io/openapiprocessor/jsonschema/schema/ResolverSpec.kt b/json-schema-validator/src/test/kotlin/io/openapiprocessor/jsonschema/schema/ResolverSpec.kt
@@ -182,4 +182,22 @@ class ResolverSpec: StringSpec({
             resolver.resolve(URI("memory:/instant.yaml"), settings)
         }
     }
+
+    "baseUri customizer can change base uri" {
+        Memory.add("/schema.yaml", "${'$'}self: /base.yaml")
+
+        val store = DocumentStore()
+        val loader = DocumentLoader(UriReader(), JacksonConverter())
+
+        val settings = Resolver.Settings (SchemaVersion.Draft4)
+            .baseUriCustomizer { documentUri, document ->
+                URI.create("/base.yaml")
+            }
+
+        val resolver = Resolver(store, loader)
+        val result = resolver.resolve(URI("memory:/schema.yaml"), settings)
+
+        result.scope.documentUri shouldBe URI("memory:/schema.yaml")
+        result.scope.baseUri shouldBe URI("memory:/base.yaml")
+    }
 })
