Rename SchemaId to DialectId

justin-tay · justin-tay · commit a6701f97ef38 · 2025-09-23T18:59:40.000+08:00
diff --git a/src/main/java/com/networknt/schema/DialectId.java b/src/main/java/com/networknt/schema/DialectId.java
@@ -16,33 +16,35 @@
 package com.networknt.schema;
 
 /**
- * Schema Identifier used in $schema.
+ * The dialect id is an IRI that points to the meta-schema that can be used to
+ * validate schemas written for that dialect. The dialect used for a particular
+ * schema is indicated using the $schema keyword.
  */
-public class SchemaId {
+public class DialectId {
     /**
      * Draft 4.
      */
-    public static final String V4 = "http://json-schema.org/draft-04/schema#";
+    public static final String DRAFT_4 = "http://json-schema.org/draft-04/schema#";
 
     /**
      * Draft 6.
      */
-    public static final String V6 = "http://json-schema.org/draft-06/schema#";
+    public static final String DRAFT_6 = "http://json-schema.org/draft-06/schema#";
 
     /**
      * Draft 7.
      */
-    public static final String V7 = "http://json-schema.org/draft-07/schema#";
+    public static final String DRAFT_7 = "http://json-schema.org/draft-07/schema#";
 
     /**
      * Draft 2019-09.
      */
-    public static final String V201909 = "https://json-schema.org/draft/2019-09/schema";
+    public static final String DRAFT_2019_09 = "https://json-schema.org/draft/2019-09/schema";
 
     /**
      * Draft 2020-12.
      */
-    public static final String V202012 = "https://json-schema.org/draft/2020-12/schema";
+    public static final String DRAFT_2020_12 = "https://json-schema.org/draft/2020-12/schema";
 
     /**
      * OpenAPI 3.0.
diff --git a/src/main/java/com/networknt/schema/JsonSchemaFactory.java b/src/main/java/com/networknt/schema/JsonSchemaFactory.java
@@ -832,15 +832,15 @@ static protected String normalizeMetaSchemaUri(String id) {
             if (id.contains("://json-schema.org/draft")) {
                 // unnormalized $schema
                 if (id.contains("/draft-07/")) {
-                    id = SchemaId.V7;
+                    id = DialectId.DRAFT_7;
                 } else if (id.contains("/draft/2019-09/")) {
-                    id = SchemaId.V201909;
+                    id = DialectId.DRAFT_2019_09;
                 } else if (id.contains("/draft/2020-12/")) {
-                    id = SchemaId.V202012;
+                    id = DialectId.DRAFT_2020_12;
                 } else if (id.contains("/draft-04/")) {
-                    id = SchemaId.V4;
+                    id = DialectId.DRAFT_4;
                 } else if (id.contains("/draft-06/")) {
-                    id = SchemaId.V6;
+                    id = DialectId.DRAFT_6;
                 } 
             }
         }
diff --git a/src/main/java/com/networknt/schema/Specification.java b/src/main/java/com/networknt/schema/Specification.java
@@ -29,23 +29,23 @@ public enum Version {
         /**
          * Draft 4.
          */
-        DRAFT_4(4, SchemaId.V4),
+        DRAFT_4(4, DialectId.DRAFT_4),
         /**
          * Draft 6.
          */
-        DRAFT_6(6, SchemaId.V6),
+        DRAFT_6(6, DialectId.DRAFT_6),
         /**
          * Draft 7.
          */
-        DRAFT_7(7, SchemaId.V7),
+        DRAFT_7(7, DialectId.DRAFT_7),
         /**
          * Draft 2019-09.
          */
-        DRAFT_2019_09(8, SchemaId.V201909),
+        DRAFT_2019_09(8, DialectId.DRAFT_2019_09),
         /**
          * Draft 2020-12.
          */
-        DRAFT_2020_12(9, SchemaId.V202012);
+        DRAFT_2020_12(9, DialectId.DRAFT_2020_12);
 
         private final int order;
         private final String dialectId;
diff --git a/src/main/java/com/networknt/schema/Version201909.java b/src/main/java/com/networknt/schema/Version201909.java
@@ -11,7 +11,7 @@
  * Draft 2019-09 dialect.
  */
 public class Version201909 implements JsonSchemaVersion {
-    private static final String IRI = SchemaId.V201909;
+    private static final String IRI = DialectId.DRAFT_2019_09;
     private static final String ID = "$id";
     private static final Map<String, Boolean> VOCABULARY;
 
diff --git a/src/main/java/com/networknt/schema/Version202012.java b/src/main/java/com/networknt/schema/Version202012.java
@@ -11,7 +11,7 @@
  * Draft 2020-12 dialect.
  */
 public class Version202012 implements JsonSchemaVersion {
-    private static final String IRI = SchemaId.V202012;
+    private static final String IRI = DialectId.DRAFT_2020_12;
     private static final String ID = "$id";
     private static final Map<String, Boolean> VOCABULARY;
 
diff --git a/src/main/java/com/networknt/schema/Version4.java b/src/main/java/com/networknt/schema/Version4.java
@@ -10,7 +10,7 @@
  * Draft 4 dialect.
  */
 public class Version4 implements JsonSchemaVersion {
-    private static final String IRI = SchemaId.V4;
+    private static final String IRI = DialectId.DRAFT_4;
     private static final String ID = "id";
     
     private static class Holder {
diff --git a/src/main/java/com/networknt/schema/Version6.java b/src/main/java/com/networknt/schema/Version6.java
@@ -10,7 +10,7 @@
  * Draft 6 dialect.
  */
 public class Version6 implements JsonSchemaVersion {
-    private static final String IRI = SchemaId.V6;
+    private static final String IRI = DialectId.DRAFT_6;
     // Draft 6 uses "$id"
     private static final String ID = "$id";
 
diff --git a/src/main/java/com/networknt/schema/Version7.java b/src/main/java/com/networknt/schema/Version7.java
@@ -10,7 +10,7 @@
  * Draft 7 dialect.
  */
 public class Version7 implements JsonSchemaVersion {
-    private static final String IRI = SchemaId.V7;
+    private static final String IRI = DialectId.DRAFT_7;
     private static final String ID = "$id";
 
     private static class Holder {
diff --git a/src/main/java/com/networknt/schema/oas/OpenApi30.java b/src/main/java/com/networknt/schema/oas/OpenApi30.java
@@ -4,7 +4,7 @@
 
 import com.networknt.schema.Formats;
 import com.networknt.schema.JsonMetaSchema;
-import com.networknt.schema.SchemaId;
+import com.networknt.schema.DialectId;
 import com.networknt.schema.Specification;
 import com.networknt.schema.keyword.AnnotationKeyword;
 import com.networknt.schema.keyword.NonValidationKeyword;
@@ -14,7 +14,7 @@
  * OpenAPI 3.0.
  */
 public class OpenApi30 {
-    private static final String IRI = SchemaId.OPENAPI_3_0;
+    private static final String IRI = DialectId.OPENAPI_3_0;
     private static final String ID = "id";
     
     private static class Holder {
diff --git a/src/main/java/com/networknt/schema/oas/OpenApi31.java b/src/main/java/com/networknt/schema/oas/OpenApi31.java
@@ -6,7 +6,7 @@
 
 import com.networknt.schema.Formats;
 import com.networknt.schema.JsonMetaSchema;
-import com.networknt.schema.SchemaId;
+import com.networknt.schema.DialectId;
 import com.networknt.schema.Specification;
 import com.networknt.schema.keyword.NonValidationKeyword;
 import com.networknt.schema.keyword.ValidatorTypeCode;
@@ -15,7 +15,7 @@
  * OpenAPI 3.1.
  */
 public class OpenApi31 {
-    private static final String IRI = SchemaId.OPENAPI_3_1;
+    private static final String IRI = DialectId.OPENAPI_3_1;
     private static final String ID = "$id";
     private static final Map<String, Boolean> VOCABULARY;
 
diff --git a/src/test/java/com/networknt/schema/ExampleTest.java b/src/test/java/com/networknt/schema/ExampleTest.java
@@ -40,13 +40,13 @@ void exampleSchemaLocation() {
                 + "  }\r\n"
                 + "}";
         // The example-main.json schema defines $schema with Draft 07
-        assertEquals(SchemaId.V7, schema.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_7, schema.getValidationContext().getMetaSchema().getIri());
         List<Error> assertions = schema.validate(input, InputFormat.JSON);
         assertEquals(1, assertions.size());
         
         // The example-ref.json schema defines $schema with Draft 2019-09
         JsonSchema refSchema = schema.getValidationContext().getSchemaResources().get("https://www.example.org/example-ref.json#");
-        assertEquals(SchemaId.V201909, refSchema.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_2019_09, refSchema.getValidationContext().getMetaSchema().getIri());
     }
 
     @Test
@@ -63,12 +63,12 @@ void exampleClasspath() {
                 + "  }\r\n"
                 + "}";
         // The example-main.json schema defines $schema with Draft 07
-        assertEquals(SchemaId.V7, schema.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_7, schema.getValidationContext().getMetaSchema().getIri());
         List<Error> assertions = schema.validate(input, InputFormat.JSON);
         assertEquals(1, assertions.size());
         
         // The example-ref.json schema defines $schema with Draft 2019-09
         JsonSchema refSchema = schema.getValidationContext().getSchemaResources().get("classpath:schema/example-ref.json#");
-        assertEquals(SchemaId.V201909, refSchema.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_2019_09, refSchema.getValidationContext().getMetaSchema().getIri());
     }
 }
diff --git a/src/test/java/com/networknt/schema/Issue475Test.java b/src/test/java/com/networknt/schema/Issue475Test.java
@@ -53,7 +53,7 @@ void draft4() throws Exception {
         JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.getInstance(Version.DRAFT_4, builder -> builder
                 .schemaMappers(schemaMappers -> schemaMappers.mapPrefix("http://json-schema.org", "classpath:")));
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
-        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(SchemaId.V4), config);
+        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(DialectId.DRAFT_4), config);
 
         List<Error> assertions = schema.validate(JsonMapperFactory.getInstance().readTree(INVALID_INPUT));
         assertEquals(2, assertions.size());
@@ -67,7 +67,7 @@ void draft6() throws Exception {
         JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.getInstance(Version.DRAFT_6, builder -> builder
                 .schemaMappers(schemaMappers -> schemaMappers.mapPrefix("http://json-schema.org", "classpath:")));
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
-        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(SchemaId.V6), config);
+        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(DialectId.DRAFT_6), config);
 
         List<Error> assertions = schema.validate(JsonMapperFactory.getInstance().readTree(INVALID_INPUT));
         assertEquals(2, assertions.size());
@@ -81,7 +81,7 @@ void draft7() throws Exception {
         JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.getInstance(Version.DRAFT_7, builder -> builder
                 .schemaMappers(schemaMappers -> schemaMappers.mapPrefix("http://json-schema.org", "classpath:")));
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
-        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(SchemaId.V7), config);
+        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(DialectId.DRAFT_7), config);
 
         List<Error> assertions = schema.validate(JsonMapperFactory.getInstance().readTree(INVALID_INPUT));
         assertEquals(2, assertions.size());
@@ -95,7 +95,7 @@ void draft201909() throws Exception {
         JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.getInstance(Version.DRAFT_2019_09, builder -> builder
                 .schemaMappers(schemaMappers -> schemaMappers.mapPrefix("https://json-schema.org", "classpath:")));
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
-        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(SchemaId.V201909), config);
+        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(DialectId.DRAFT_2019_09), config);
 
         List<Error> assertions = schema.validate(JsonMapperFactory.getInstance().readTree(INVALID_INPUT));
         assertEquals(2, assertions.size());
@@ -109,7 +109,7 @@ void draft202012() throws Exception {
         JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.getInstance(Version.DRAFT_2020_12, builder -> builder
                 .schemaMappers(schemaMappers -> schemaMappers.mapPrefix("https://json-schema.org", "classpath:")));
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
-        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(SchemaId.V202012), config);
+        JsonSchema schema = jsonSchemaFactory.getSchema(SchemaLocation.of(DialectId.DRAFT_2020_12), config);
 
         List<Error> assertions = schema.validate(JsonMapperFactory.getInstance().readTree(INVALID_INPUT));
         assertEquals(2, assertions.size());
diff --git a/src/test/java/com/networknt/schema/RefTest.java b/src/test/java/com/networknt/schema/RefTest.java
@@ -25,7 +25,7 @@ void shouldLoadRelativeClasspathReference() throws JsonProcessingException {
                 + "    }\r\n"
                 + "  }\r\n"
                 + "}";
-        assertEquals(SchemaId.V4, schema.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_4, schema.getValidationContext().getMetaSchema().getIri());
         List<Error> errors = schema.validate(OBJECT_MAPPER.readTree(input));
         assertEquals(1, errors.size());
         Error error = errors.iterator().next();
@@ -48,7 +48,7 @@ void shouldLoadSchemaResource() throws JsonProcessingException {
                 + "    }\r\n"
                 + "  }\r\n"
                 + "}";
-        assertEquals(SchemaId.V4, schema.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_4, schema.getValidationContext().getMetaSchema().getIri());
         List<Error> errors = schema.validate(OBJECT_MAPPER.readTree(input));
         assertEquals(1, errors.size());
         Error error = errors.iterator().next();
@@ -59,8 +59,8 @@ void shouldLoadSchemaResource() throws JsonProcessingException {
         assertEquals("field1", error.getProperty());
         JsonSchema driver = schema.getValidationContext().getSchemaResources().get("https://www.example.org/driver#");
         JsonSchema common = schema.getValidationContext().getSchemaResources().get("https://www.example.org/common#");
-        assertEquals(SchemaId.V4, driver.getValidationContext().getMetaSchema().getIri());
-        assertEquals(SchemaId.V7, common.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_4, driver.getValidationContext().getMetaSchema().getIri());
+        assertEquals(DialectId.DRAFT_7, common.getValidationContext().getMetaSchema().getIri());
 
     }
 }
diff --git a/src/test/java/com/networknt/schema/UnknownMetaSchemaTest.java b/src/test/java/com/networknt/schema/UnknownMetaSchemaTest.java
@@ -64,7 +64,7 @@ void testNormalize() throws JsonSchemaException {
         String uri02 = "http://json-schema.org/draft-07/schema#";
         String uri03 = "http://json-schema.org/draft-07/schema?key=value";
         String uri04 = "http://json-schema.org/draft-07/schema?key=value&key2=value2";
-        String expected = SchemaId.V7;
+        String expected = DialectId.DRAFT_7;
 
         Assertions.assertEquals(expected, JsonSchemaFactory.normalizeMetaSchemaUri(uri01));
         Assertions.assertEquals(expected, JsonSchemaFactory.normalizeMetaSchemaUri(uri02));
diff --git a/src/test/java/com/networknt/schema/resource/MetaSchemaMapperTest.java b/src/test/java/com/networknt/schema/resource/MetaSchemaMapperTest.java
@@ -25,19 +25,19 @@
 import org.junit.jupiter.params.provider.EnumSource;
 
 import com.networknt.schema.AbsoluteIri;
-import com.networknt.schema.SchemaId;
+import com.networknt.schema.DialectId;
 
 /**
  * MetaSchemaMapperTest.
  */
 class MetaSchemaMapperTest {
 
     enum MapInput {
-        V4(SchemaId.V4),
-        V6(SchemaId.V6),
-        V7(SchemaId.V7),
-        V201909(SchemaId.V201909),
-        V202012(SchemaId.V202012);
+        V4(DialectId.DRAFT_4),
+        V6(DialectId.DRAFT_6),
+        V7(DialectId.DRAFT_7),
+        V201909(DialectId.DRAFT_2019_09),
+        V202012(DialectId.DRAFT_2020_12);
 
         String iri;
 
diff --git a/src/test/java/com/networknt/schema/walk/JsonSchemaWalkListenerTest.java b/src/test/java/com/networknt/schema/walk/JsonSchemaWalkListenerTest.java
@@ -39,7 +39,7 @@
 import com.networknt.schema.JsonSchema;
 import com.networknt.schema.JsonSchemaFactory;
 import com.networknt.schema.JsonSchemaRef;
-import com.networknt.schema.SchemaId;
+import com.networknt.schema.DialectId;
 import com.networknt.schema.SchemaLocation;
 import com.networknt.schema.SchemaValidatorsConfig;
 import com.networknt.schema.Specification.Version;
@@ -392,7 +392,7 @@ public void onWalkEnd(WalkEvent walkEvent, List<Error> errors) {
                 })
                 .build();
         JsonSchema schema = JsonSchemaFactory.getInstance(Version.DRAFT_2019_09)
-                .getSchema(SchemaLocation.of(SchemaId.V201909), config);
+                .getSchema(SchemaLocation.of(DialectId.DRAFT_2019_09), config);
         String inputData = "{\r\n"
                 + "  \"$schema\": \"https://json-schema.org/draft/2019-09/schema\",\r\n"
                 + "  \"type\": \"object\",\r\n"
