init draft4 vocabulary

openapi-parser-validator/src/main/java/io/openapiparser/schema/Keywords.java

@@ -5,16 +5,68 @@
 
 package io.openapiparser.schema;
 
-// TODO move to Vocabulary Objects...
 public interface Keywords {
- String DEPENDENT_REQUIRED = "dependentRequired";
- String DYNAMIC_REF = "$dynamicRef";
+ // misc
  String HASH = "#";
+
+ // core
  String ID = "$id";
  String ID4 = "id";
+ String SCHEMA = "$schema";
+
+ String REF = "$ref";
+ String DYNAMIC_REF = "$dynamicRef";
  String RECURSIVE_ANCHOR = "$recursiveAnchor";
  String RECURSIVE_REF = "$recursiveRef";
- String REF = "$ref";
- String SCHEMA = "$schema";
  String VOCABULARY = "$vocabulary";
+
+ // applicators
+ String ALL_OF = "allOf";
+ String ANY_OF = "anyOf";
+ String ONE_OF = "oneOf";
+ String NOT = "not";
+
+ // meta data
+ String TITLE = "title";
+ String DEFAULT = "default";
+ String DESCRIPTION = "description";
+
+ // format
+ String FORMAT = "format";
+
+ // validation: number
+ String MULTIPLE_OF = "multipleOf";
+ String MAXIMUM = "maximum";
+ String MINIMUM = "minimum";
+ String EXCLUSIVE_MAXIMUM = "exclusiveMaximum";
+ String EXCLUSIVE_MINIMUM = "exclusiveMinimum";
+
+ // validation: strings
+ String MAX_LENGTH = "maxLength";
+ String MIN_LENGTH = "minLength";
+ String PATTERN = "pattern";
+
+ // validation: arrays
+ String ADDITIONAL_ITEMS = "additionalItems";
+ String ITEMS = "items";
+ String MAX_ITEMS = "maxItems";
+ String MIN_ITEMS = "minItems";
+ String UNIQUE_ITEMS = "uniqueItems";
+
+ // validation: objects
+ String ADDITIONAL_PROPERTIES = "additionalProperties";
+ String DEPENDENCIES = "dependencies";
+ String MAX_PROPERTIES = "maxProperties";
+ String MIN_PROPERTIES = "minProperties";
+ String PATTERN_PROPERTIES = "patternProperties";
+ String PROPERTIES = "properties";
+ String REQUIRED = "required";
+
+ // validation: any
+ String DEFINITIONS = "definitions";
+ String ENUM = "enum";
+ String TYPE = "type";
+
+ // todo
+ String DEPENDENT_REQUIRED = "dependentRequired";
 }

openapi-parser-validator/src/main/java/io/openapiparser/schema/SchemaKeywords.java

@@ -9,14 +9,16 @@
 
 import java.util.*;
 
-import static io.openapiparser.schema.KeywordType.*;
-import static io.openapiparser.schema.Keywords.DEPENDENT_REQUIRED;
+import static io.openapiparser.schema.Keywords.*;
 
+// VocabularyFactory
 public class SchemaKeywords {
  public static final SchemaKeywords draft201909 = new SchemaKeywords (initDraft201909 ());
  public static final SchemaKeywords draft7 = new SchemaKeywords (initDraft7 ());
  public static final SchemaKeywords draft6 = new SchemaKeywords (initDraft6 ());
- public static final SchemaKeywords draft4 = new SchemaKeywords (initDraft4 ());
+ public static final SchemaKeywords draft4 = new SchemaKeywords (initDraft4Old ());
+
+ public static final Vocabulary draft4V = new Vocabulary(initDraft4 ());
 
  private final Map<String, Keyword> keywords;
 
@@ -44,11 +46,11 @@ private static Map<String, Keyword> initDraft201909 () {
  Map<String, Keyword> keywords = new HashMap<> (initDraft7 ());
 
  // core
- keywords.put ("$anchor", keyword (STRING));
- keywords.put ("$defs", keyword (SCHEMA_MAP));
+ keywords.put ("$anchor", keyword (KeywordType.STRING));
+ keywords.put ("$defs", keyword (KeywordType.SCHEMA_MAP));
 
- keywords.put ("dependentSchemas", keyword(SCHEMA_MAP));
- keywords.put(DEPENDENT_REQUIRED, keyword(OBJECT));
+ keywords.put ("dependentSchemas", keyword(KeywordType.SCHEMA_MAP));
+ keywords.put(DEPENDENT_REQUIRED, keyword(KeywordType.OBJECT));
 
  return Collections.unmodifiableMap (keywords);
  }
@@ -57,20 +59,20 @@ private static Map<String, Keyword> initDraft7 () {
  Map<String, Keyword> keywords = new HashMap<> (initDraft6 ());
 
  // core
- keywords.put ("$comment", keyword (STRING));
+ keywords.put ("$comment", keyword (KeywordType.STRING));
 
  // validation: sub schemas
- keywords.put ("if", keyword (SCHEMA));
- keywords.put ("then", keyword (SCHEMA));
- keywords.put ("else", keyword (SCHEMA));
+ keywords.put ("if", keyword (KeywordType.SCHEMA));
+ keywords.put ("then", keyword (KeywordType.SCHEMA));
+ keywords.put ("else", keyword (KeywordType.SCHEMA));
 
  // validation: annotations
- keywords.put ("readOnly", keyword (BOOLEAN));
- keywords.put ("writeOnly", keyword (BOOLEAN));
+ keywords.put ("readOnly", keyword (KeywordType.BOOLEAN));
+ keywords.put ("writeOnly", keyword (KeywordType.BOOLEAN));
 
  // validation: non json data
- keywords.put ("contentMediaType", keyword (STRING));
- keywords.put ("contentEncoding", keyword (STRING));
+ keywords.put ("contentMediaType", keyword (KeywordType.STRING));
+ keywords.put ("contentEncoding", keyword (KeywordType.STRING));
 
  return Collections.unmodifiableMap (keywords);
  }
@@ -79,24 +81,24 @@ private static Map<String, Keyword> initDraft6 () {
  Map<String, Keyword> keywords = new HashMap<> (initDraft4 ());
 
  // core
- keywords.put ("$id", keyword (URI));
+ keywords.put ("$id", keyword (KeywordType.URI));
  // delete id
 
  // validation: numbers
- keywords.put ("exclusiveMaximum", keyword(NUMBER));
- keywords.put ("exclusiveMinimum", keyword(NUMBER));
+ keywords.put ("exclusiveMaximum", keyword(KeywordType.NUMBER));
+ keywords.put ("exclusiveMinimum", keyword(KeywordType.NUMBER));
 
  // validation: arrays
- keywords.put ("contains", keyword (SCHEMA));
+ keywords.put ("contains", keyword (KeywordType.SCHEMA));
 
  // validation: objects
- keywords.put ("propertyNames", keyword (SCHEMA));
+ keywords.put ("propertyNames", keyword (KeywordType.SCHEMA));
 
  // validation: any
- keywords.put ("const", keyword (ANY));
+ keywords.put ("const", keyword (KeywordType.ANY));
 
  // validation: meta data
- keywords.put ("examples", keyword (ARRAY));
+ keywords.put ("examples", keyword (KeywordType.ARRAY));
 
  return Collections.unmodifiableMap (keywords);
  }
@@ -105,58 +107,125 @@ private static Map<String, Keyword> initDraft4 () {
  Map<String, Keyword> keywords = new HashMap<> ();
 
  // core
- keywords.put ("$ref", keyword (URI_REF));
- keywords.put ("$schema", keyword (URI));
- keywords.put ("id", keyword (URI));
+ keywords.put (ID4, keyword (KeywordType.URI));
+ keywords.put (REF, keyword (KeywordType.URI_REF));
+ keywords.put (SCHEMA, keyword (KeywordType.URI));
+
+ // applicators
+ keywords.put (ALL_OF, keyword (KeywordType.SCHEMA_ARRAY));
+ keywords.put (ANY_OF, keyword (KeywordType.SCHEMA_ARRAY));
+ keywords.put (ONE_OF, keyword (KeywordType.SCHEMA_ARRAY));
+ keywords.put (NOT, keyword (KeywordType.SCHEMA));
+
+ // meta
+ keywords.put (TITLE, keyword (KeywordType.STRING));
+ keywords.put (DESCRIPTION, keyword (KeywordType.STRING));
+ keywords.put (DEFAULT, keyword (KeywordType.ANY));
+
+ // format
+ keywords.put (FORMAT, keyword (KeywordType.STRING));
+
+ // validation: numbers
+ keywords.put (EXCLUSIVE_MAXIMUM, keyword (KeywordType.BOOLEAN));
+ keywords.put (EXCLUSIVE_MINIMUM, keyword (KeywordType.BOOLEAN));
+ keywords.put (MAXIMUM, keyword (KeywordType.INTEGER));
+ keywords.put (MINIMUM, keyword (KeywordType.INTEGER));
+ keywords.put (MULTIPLE_OF, keyword (KeywordType.INTEGER));
+
+ // validation: strings
+ keywords.put (MAX_LENGTH, keyword (KeywordType.NUMBER));
+ keywords.put (MIN_LENGTH, keyword (KeywordType.NUMBER));
+ keywords.put (PATTERN, keyword (KeywordType.STRING));
+
+ // validation: arrays
+ keywords.put (ADDITIONAL_ITEMS, keyword (KeywordType.SCHEMA, KeywordType.BOOLEAN));
+ keywords.put (ITEMS, keyword (KeywordType.SCHEMA, KeywordType.SCHEMA_ARRAY));
+ keywords.put (MAX_ITEMS, keyword (KeywordType.NUMBER));
+ keywords.put (MIN_ITEMS, keyword (KeywordType.NUMBER));
+ keywords.put (UNIQUE_ITEMS, keyword (KeywordType.BOOLEAN));
+
+ // validation: objects
+ keywords.put (ADDITIONAL_PROPERTIES, keyword (KeywordType.SCHEMA));
+ keywords.put (DEPENDENCIES, keyword (KeywordType.SCHEMA, KeywordType.ARRAY));
+ keywords.put (MAX_PROPERTIES, keyword (KeywordType.NUMBER));
+ keywords.put (MIN_PROPERTIES, keyword (KeywordType.NUMBER));
+ keywords.put (PATTERN_PROPERTIES, keyword (KeywordType.SCHEMA_MAP));
+ keywords.put (PROPERTIES, keyword (KeywordType.SCHEMA_MAP));
+ keywords.put (REQUIRED, keyword (KeywordType.ARRAY));
+
+ // validation: any
+ keywords.put (ENUM, keyword (KeywordType.ARRAY));
+ keywords.put (TYPE, keyword (KeywordType.STRING, KeywordType.ARRAY));
+ keywords.put (DEFINITIONS, keyword (KeywordType.SCHEMA_MAP));
+
+ return Collections.unmodifiableMap (keywords);
+ }
+
+ private static Map<String, Keyword> initDraft4Old () {
+ Map<String, Keyword> keywords = new HashMap<> ();
+
+ // core
+ keywords.put ("$ref", keyword (KeywordType.URI_REF));
+ keywords.put ("$schema", keyword (KeywordType.URI));
+ keywords.put ("id", keyword (KeywordType.URI));
 
  // validation: numbers
- keywords.put ("multipleOf", keyword(NUMBER));
- keywords.put ("maximum", keyword(NUMBER));
- keywords.put ("minimum", keyword (NUMBER));
- keywords.put ("exclusiveMaximum", keyword(BOOLEAN));
- keywords.put ("exclusiveMinimum", keyword(BOOLEAN));
+ keywords.put ("multipleOf", keyword(KeywordType.NUMBER));
+ keywords.put ("maximum", keyword(KeywordType.NUMBER));
+ keywords.put ("minimum", keyword (KeywordType.NUMBER));
+ keywords.put ("exclusiveMaximum", keyword(KeywordType.BOOLEAN));
+ keywords.put ("exclusiveMinimum", keyword(KeywordType.BOOLEAN));
 
  // validation: strings
- keywords.put ("maxLength", keyword (INTEGER));
- keywords.put ("minLength", keyword (INTEGER));
- keywords.put ("pattern", keyword (STRING));
+ keywords.put ("maxLength", keyword (KeywordType.INTEGER));
+ keywords.put ("minLength", keyword (KeywordType.INTEGER));
+ keywords.put ("pattern", keyword (KeywordType.STRING));
 
  // validation: arrays
- keywords.put ("additionalItems", keyword (SCHEMA));
- keywords.put ("items", keyword (SCHEMA, SCHEMA_ARRAY));
- keywords.put ("maxItems", keyword (INTEGER));
- keywords.put ("minItems", keyword (INTEGER));
- keywords.put ("uniqueItems", keyword (BOOLEAN));
+ keywords.put ("additionalItems", keyword (KeywordType.SCHEMA));
+ keywords.put ("items", keyword (KeywordType.SCHEMA, KeywordType.SCHEMA_ARRAY));
+ keywords.put ("maxItems", keyword (KeywordType.INTEGER));
+ keywords.put ("minItems", keyword (KeywordType.INTEGER));
+ keywords.put ("uniqueItems", keyword (KeywordType.BOOLEAN));
 
  // validation: objects
- keywords.put ("maxProperties", keyword (INTEGER));
- keywords.put ("minProperties", keyword (INTEGER));
- keywords.put ("required", keyword (ARRAY));
- keywords.put ("additionalProperties", keyword (SCHEMA));
- keywords.put ("properties", keyword (SCHEMA_MAP));
- keywords.put ("patternProperties", keyword (SCHEMA_MAP));
- keywords.put ("dependencies", keyword (SCHEMA, ARRAY));
+ keywords.put ("maxProperties", keyword (KeywordType.INTEGER));
+ keywords.put ("minProperties", keyword (KeywordType.INTEGER));
+ keywords.put ("required", keyword (KeywordType.ARRAY));
+ keywords.put ("additionalProperties", keyword (KeywordType.SCHEMA));
+ keywords.put ("properties", keyword (KeywordType.SCHEMA_MAP));
+ keywords.put ("patternProperties", keyword (KeywordType.SCHEMA_MAP));
+ keywords.put ("dependencies", keyword (KeywordType.SCHEMA, KeywordType.ARRAY));
 
  // validation: any
- keywords.put ("enum", keyword (ARRAY));
- keywords.put ("type", keyword (STRING, ARRAY));
- keywords.put ("allOf", keyword (SCHEMA_ARRAY));
- keywords.put ("anyOf", keyword (SCHEMA_ARRAY));
- keywords.put ("oneOf", keyword (SCHEMA_ARRAY));
- keywords.put ("not", keyword (SCHEMA));
- keywords.put ("definitions", keyword (SCHEMA_MAP));
+ keywords.put ("enum", keyword (KeywordType.ARRAY));
+ keywords.put ("type", keyword (KeywordType.STRING, KeywordType.ARRAY));
+ keywords.put ("allOf", keyword (KeywordType.SCHEMA_ARRAY));
+ keywords.put ("anyOf", keyword (KeywordType.SCHEMA_ARRAY));
+ keywords.put ("oneOf", keyword (KeywordType.SCHEMA_ARRAY));
+ keywords.put ("not", keyword (KeywordType.SCHEMA));
+ keywords.put ("definitions", keyword (KeywordType.SCHEMA_MAP));
 
  // validation: meta data
- keywords.put ("title", keyword (STRING));
- keywords.put ("description", keyword (STRING));
- keywords.put ("default", keyword (ANY));
+ keywords.put ("title", keyword (KeywordType.STRING));
+ keywords.put ("description", keyword (KeywordType.STRING));
+ keywords.put ("default", keyword (KeywordType.ANY));
 
  // validation: format
- keywords.put ("format", keyword (STRING));
+ keywords.put ("format", keyword (KeywordType.STRING));
 
  return Collections.unmodifiableMap (keywords);
  }
 
+
+ private static Keyword stringOrArray () {
+ return keyword (KeywordType.STRING, KeywordType.ARRAY);
+ }
+
+ private static Keyword schemaArray () {
+ return keyword (KeywordType.SCHEMA_ARRAY);
+ }
+
  private static Keyword keyword (KeywordType value, KeywordType... values) {
  return new Keyword (EnumSet.of (value, values));
  }

openapi-parser-validator/src/main/java/io/openapiparser/schema/Vocabulary.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2023 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.schema;
+
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.Map;
+
+public class Vocabulary {
+ private final Map<String, Keyword> keywords;
+
+ public Vocabulary(Map<String, Keyword> keywords) {
+ this.keywords = keywords;
+ }
+
+ public boolean isKeyword (String candidate) {
+ return keywords.containsKey (candidate);
+ }
+
+ public @Nullable Keyword getKeyword (String keyword) {
+ return keywords.get (keyword);
+ }
+
+ public boolean isNavigable (String keyword) {
+ Keyword match = keywords.get (keyword);
+ if (match == null)
+ return false;
+
+ return match.isNavigable ();
+ }
+}