refactor(schemas): update JSON Schema Validation Keywords for Arrays

asyncapi · Mar 28, 2024 · 2753611 · 2753611
1 parent f6660a9
commit 2753611
Showing 1 changed file with 96 additions and 77 deletions.
diff --git a/asyncapi-core/src/main/java/com/asyncapi/v3/schema/Schema.java b/asyncapi-core/src/main/java/com/asyncapi/v3/schema/Schema.java
@@ -256,6 +256,102 @@ Validation Keywords for Numeric Instances (number and integer)
     @JsonProperty("pattern")
     public String pattern;
 
+    /*
+        Validation Keywords for Arrays
+     */
+
+    /**
+     * The value of "items" <b>MUST</b> be either a valid JSON Schema or an array of valid JSON Schemas.
+     * <p>
+     * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
+     * <p>
+     * If "items" is a schema, validation succeeds if all elements in the array successfully validate against that schema.
+     * <p>
+     * If "items" is an array of schemas, validation succeeds if each element of the instance validates against the schema at the same
+     * position, if any.
+     * <p>
+     * Omitting this keyword has the same behavior as an empty schema.
+     *
+     * @see <a href="https://json-schema.org/draft-07/json-schema-validation#rfc.section.6.4.1">items</a>
+     */
+    @Nullable
+    @JsonProperty("items")
+    @JsonDeserialize(using = SchemaItemsDeserializer.class)
+    public Object items;
+
+    /**
+     * The value of "additionalItems" <b>MUST</b> be a valid JSON Schema.
+     * <p>
+     * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
+     * <p>
+     * If "items" is an array of schemas, validation succeeds if every instance element at a position greater than the size of "items"
+     * validates against "additionalItems".
+     * <p>
+     * Otherwise, "additionalItems" MUST be ignored, as the "items" schema (possibly the default value of an empty schema) is applied
+     * to all elements.
+     * <p>
+     * Omitting this keyword has the same behavior as an empty schema.
+     *
+     * @see <a href="https://json-schema.org/draft-07/json-schema-validation#rfc.section.6.4.2">additionalItems</a>
+     */
+    @Nullable
+    @JsonProperty("additionalItems")
+    public Schema additionalItems;
+
+    /**
+     * The value of this keyword <b>MUST</b> be a non-negative integer.
+     * <p>
+     * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
+     *
+     * @see <a href="https://json-schema.org/draft-07/json-schema-validation#rfc.section.6.4.3">maxItems</a>
+     */
+    @Nullable
+    @Min(
+            value = 0,
+            message = "The value of \"maxItems\" MUST be a non-negative integer."
+    )
+    @JsonProperty("maxItems")
+    public Integer maxItems;
+
+    /**
+     * The value of this keyword <b>MUST</b> be a non-negative integer.
+     * <p>
+     * An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword.
+     * <p>
+     * Omitting this keyword has the same behavior as a value of 0.
+     *
+     * @see <a href="https://json-schema.org/draft-07/json-schema-validation#rfc.section.6.4.4">minItems</a>
+     */
+    @Nullable
+    @JsonProperty("minItems")
+    public Integer minItems;
+
+    /**
+     * The value of this keyword <b>MUST</b> be a boolean.
+     * <p>
+     * If this keyword has boolean value false, the instance validates successfully.
+     * <p>
+     * If it has boolean value true, the instance validates successfully if all of its elements are unique.
+     * <p>
+     * Omitting this keyword has the same behavior as a value of false.
+     *
+     * @see <a href="https://json-schema.org/draft-07/json-schema-validation#rfc.section.6.4.5">uniqueItems</a>
+     */
+    @Nullable
+    @JsonProperty("uniqueItems")
+    public Boolean uniqueItems;
+
+    /**
+     * The value of this keyword <b>MUST</b> be a valid JSON Schema.
+     * <br>
+     * An array instance is valid against "contains" if at least one of its elements is valid against the given schema.
+     *
+     * @see <a href="https://json-schema.org/draft-07/json-schema-validation#rfc.section.6.4.6">contains</a>
+     */
+    @Nullable
+    @JsonProperty("contains")
+    public Schema contains;
+
     /*
         Schema Annotations
 
@@ -429,83 +525,6 @@ as assertions (Section 3.2).  While no special effort is required to
         Validation.
      */
 
-    /*
-        Validation Keywords for Arrays
-     */
-
-    /**
-     * The value of "items" MUST be either a valid JSON Schema or an array of valid JSON Schemas.
-     * <br>
-     * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
-     * <br>
-     * If "items" is a schema, validation succeeds if all elements in the array successfully validate against that schema.
-     * <br>
-     * If "items" is an array of schemas, validation succeeds if each element of the instance validates against the schema at the same
-     * position, if any.
-     * <br>
-     * Omitting this keyword has the same behavior as an empty schema.
-     */
-    @Nullable
-    @JsonDeserialize(using = SchemaItemsDeserializer.class)
-    public Object items;
-
-    /**
-     * The value of "additionalItems" MUST be a valid JSON Schema.
-     * <br>
-     * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
-     * <br>
-     * If "items" is an array of schemas, validation succeeds if every instance element at a position greater than the size of "items"
-     * validates against "additionalItems".
-     * <br>
-     * Otherwise, "additionalItems" MUST be ignored, as the "items" schema (possibly the default value of an empty schema) is applied
-     * to all elements.
-     * <br>
-     * Omitting this keyword has the same behavior as an empty schema.
-     */
-    @Nullable
-    public Schema additionalItems;
-
-    /**
-     * The value of this keyword MUST be a non-negative integer.
-     * <br>
-     * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
-     */
-    @Nullable
-    @JsonProperty
-    public Integer maxItems;
-
-    /**
-     * The value of this keyword MUST be a non-negative integer.
-     * <br>
-     * An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword.
-     * <br>
-     * Omitting this keyword has the same behavior as a value of 0.
-     */
-    @Nullable
-    @JsonProperty
-    public Integer minItems;
-
-    /**
-     * The value of this keyword MUST be a boolean.
-     * <br>
-     * If this keyword has boolean value false, the instance validates successfully.  If it has boolean value true,
-     * the instance validates successfully if all of its elements are unique.
-     * <br>
-     * Omitting this keyword has the same behavior as a value of false.
-     */
-    @Nullable
-    @JsonProperty
-    public Boolean uniqueItems;
-
-    /**
-     * The value of this keyword MUST be a valid JSON Schema.
-     * <br>
-     * An array instance is valid against "contains" if at least one of its elements is valid against the given schema.
-     */
-    @Nullable
-    @JsonProperty
-    public Schema contains;
-
     /*
         Validation Keywords for Objects
      */