v32: new properties

Author: hauner

README.adoc

@@ -26,11 +26,11 @@ It is usable, it is used as the internal openapi parser/validator by openapi-pro
 
 == openapi-parser & validator
 
-a Java 11 based link:{openapi}[OpenAPI] 3.0.x & 3.1 parser with validation and pluggable document reader & json/yaml converter.
+a Java 11 based link:{openapi}[OpenAPI] 3.2, 3.1, 3.0 parser with validation and pluggable document reader & json/yaml converter.
 
-* parse OpenAPI 3.0.x & 3.1
-* validate OpenAPI 3.0.x & 3.1 (json schema validation, can follow $ref's in the OpenAPI document)
-* separate apis for OpenAPI 3.0 & 3.1
+* parse OpenAPI 3.2, 3.1 & 3.0
+* validate OpenAPI 3.2, 3.1 & 3.0 (json schema validation, can follow $ref's in the OpenAPI document)
+* separate apis for OpenAPI 3.2, 3.1 & 3.0
 * easily get resolved $ref object
 * bundle & write (single file) OpenAPI document
 * minimal dependencies

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

@@ -18,7 +18,11 @@ public interface Keywords {
  String ALLOW_RESERVED = "allowReserved";
  String ANY_OF = "anyOf";
  String ATTRIBUTE = "attribute";
+ String AUTHORIZATION_CODE = "authorizationCode";
+ String AUTHORIZATION_URL = "authorizationUrl";
  String CALLBACKS = "callbacks";
+ String BEARER_FORMAT = "bearerFormat";
+ String CLIENT_CREDENTIALS = "clientCredentials";
  String COMPONENTS = "components";
  String CONST = "const";
  String CONTACT = "contact";
@@ -32,6 +36,8 @@ public interface Keywords {
  String DEPENDENT_REQUIRED = "dependentRequired";
  String DEPRECATED = "deprecated";
  String DESCRIPTION = "description";
+ String DEVICE_AUTHORIZATION = "deviceAuthorization";
+ String DEVICE_AUTHORIZATION_URL = "deviceAuthorizationUrl";
  String DISCRIMINATOR = "discriminator";
  String ENUM = "enum";
  String EMAIL = "email";
@@ -43,11 +49,13 @@ public interface Keywords {
  String EXPLODE = "explode";
  String EXTERNAL_DOCS = "externalDocs";
  String EXTERNAL_VALUE = "externalValue";
+ String FLOWS = "flows";
  String FORMAT = "format";
  String GET = "get";
  String HEAD = "head";
  String HEADERS = "headers";
  String IDENTIFIER = "identifier";
+ String IMPLICIT = "implicit";
  String IN = "in";
  String INFO = "info";
  String ITEM_ENCODING = "itemEncoding";
@@ -75,10 +83,13 @@ public interface Keywords {
  String NODE_TYPE = "nodeType";
  String NOT = "not";
  String NULLABLE = "nullable";
+ String OAUTH2_METADATA_URL = "oauth2MetadataUrl";
  String ONE_OF = "oneOf";
  String OPENAPI = "openapi";
+ String OPENID_CONNECT_URL = "openIdConnectUrl";
  String OPERATION_ID = "operationId";
  String OPTIONS = "options";
+ String PASSWORD = "password";
  String PARAMETERS = "parameters";
  String PARENT = "parent";
  String PATCH = "patch";
@@ -97,22 +108,26 @@ public interface Keywords {
  String QUERY = "query";
  String READ_ONLY = "readOnly";
  String REF = "$ref";
+ String REFRESH_URL = "refreshUrl";
  String REQUEST_BODY = "requestBody";
  String REQUEST_BODIES = "requestBodies";
  String REQUIRED = "required";
  String RESPONSES = "responses";
  String SCHEMA = "schema";
  String SCHEMAS = "schemas";
+ String SCHEME = "scheme";
  String SECURITY = "security";
  String SECURITY_SCHEMES = "securitySchemes";
  String SELF = "$self";
  String SERIALIZED_VALUE = "serializedValue";
  String SERVERS = "servers";
+ String SCOPES = "scopes";
  String STYLE = "style";
  String SUMMARY = "summary";
  String TAGS = "tags";
  String TERMS_OF_SERVICE = "termsOfService";
  String TITLE = "title";
+ String TOKEN_URL = "tokenUrl";
  String TRACE = "trace";
  String TYPE = "type";
  String UNIQUE_ITEMS = "uniqueItems";

openapi-parser/src/main/java/io/openapiparser/model/v31/OAuthFlow.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.v31;
+
+import io.openapiparser.Context;
+import io.openapiparser.Properties;
+import io.openapiparser.support.Required;
+import io.openapiprocessor.jsonschema.schema.Bucket;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.Map;
+
+import static io.openapiparser.Keywords.*;
+
+/**
+ * the <em>OAuth Flow</em> object.
+ *
+ * <p>See specification:
+ * <a href="https://spec.openapis.org/oas/v3.1.1.html#ouath-flow-object">4.29 Oauth Flow Object</a>
+ */
+public class OAuthFlow extends Properties implements Extensions {
+
+ public OAuthFlow(Context context, Bucket bucket) {
+ super(context, bucket);
+ }
+
+ @Required
+ public String getAuthorizationUrl() {
+ return getStringOrThrow(AUTHORIZATION_URL);
+ }
+
+ @Required
+ public String getTokenUrl() {
+ return getStringOrThrow(TOKEN_URL);
+ }
+
+ public @Nullable String getRefreshUrl() {
+ return getStringOrThrow(REFRESH_URL);
+ }
+
+ @Required
+ public Map<String, String> getScopes() {
+ return getMapStringsOrEmpty(SCOPES);
+ }
+
+ @Override
+ public Map<String, @Nullable Object> getExtensions () {
+ return super.getExtensions ();
+ }
+}

openapi-parser/src/main/java/io/openapiparser/model/v31/OAuthFlows.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.v31;
+
+import io.openapiparser.Context;
+import io.openapiparser.Properties;
+import io.openapiparser.model.v32.Extensions;
+import io.openapiparser.model.v32.OAuthFlow;
+import io.openapiprocessor.jsonschema.schema.Bucket;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.Map;
+
+import static io.openapiparser.Keywords.*;
+
+/**
+ * the <em>OAuth Flows</em> object.
+ *
+ * <p>See specification:
+ * <a href="https://spec.openapis.org/oas/v3.1.1.html#oauth-flows-object">4.28 Oauth Flows Object</a>
+ */
+public class OAuthFlows extends Properties implements Extensions {
+
+ public OAuthFlows(Context context, Bucket bucket) {
+ super(context, bucket);
+ }
+
+ public @Nullable OAuthFlow getImplicit() {
+ return getObjectOrNull(IMPLICIT, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getPassword() {
+ return getObjectOrNull(PASSWORD, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getClientCredentials() {
+ return getObjectOrNull(CLIENT_CREDENTIALS, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getAuthorizationCode() {
+ return getObjectOrNull(AUTHORIZATION_CODE, OAuthFlow.class);
+ }
+
+ @Override
+ public Map<String, @Nullable Object> getExtensions () {
+ return super.getExtensions ();
+ }
+}

openapi-parser/src/main/java/io/openapiparser/model/v31/SecurityScheme.java

@@ -7,11 +7,14 @@
 
 import io.openapiparser.Context;
 import io.openapiparser.Properties;
+import io.openapiparser.support.Required;
 import io.openapiprocessor.jsonschema.schema.Bucket;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 import java.util.Map;
 
+import static io.openapiparser.Keywords.*;
+
 /**
  * the <em>Security Scheme</em> object.
  *
@@ -26,6 +29,43 @@ public SecurityScheme (Context context, Bucket bucket) {
  super (context, bucket);
  }
 
+ @Required
+ public String getType () {
+ return getStringOrThrow (TYPE);
+ }
+
+ public @Nullable String getDescription () {
+ return getStringOrNull (DESCRIPTION);
+ }
+
+ @Required
+ public String getName () {
+ return getStringOrThrow (NAME);
+ }
+
+ @Required
+ public String getIn () {
+ return getStringOrThrow (IN);
+ }
+
+ @Required
+ public String getScheme () {
+ return getStringOrThrow (SCHEME);
+ }
+
+ public @Nullable String getBearerFormat () {
+ return getStringOrNull (BEARER_FORMAT);
+ }
+
+ public OAuthFlows getFlows () {
+ return getObjectOrThrow(FLOWS, OAuthFlows.class);
+ }
+
+ @Required
+ public String getOpenIdConnectUrl () {
+ return getStringOrThrow (OPENID_CONNECT_URL);
+ }
+
  @Override
  public Map<String, @Nullable Object> getExtensions () {
  return super.getExtensions ();

openapi-parser/src/main/java/io/openapiparser/model/v32/OAuthFlow.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.v32;
+
+import io.openapiparser.Context;
+import io.openapiparser.Properties;
+import io.openapiparser.support.Required;
+import io.openapiprocessor.jsonschema.schema.Bucket;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.Map;
+
+import static io.openapiparser.Keywords.*;
+
+/**
+ * the <em>OAuth Flow</em> object.
+ *
+ * <p>See specification:
+ * <a href="https://spec.openapis.org/oas/v3.2.0.html#ouath-flow-object">4.29 Oauth Flow Object</a>
+ */
+public class OAuthFlow extends Properties implements Extensions {
+
+ public OAuthFlow(Context context, Bucket bucket) {
+ super(context, bucket);
+ }
+
+ @Required
+ public String getAuthorizationUrl() {
+ return getStringOrThrow(AUTHORIZATION_URL);
+ }
+
+ @Required
+ public String getDeviceAuthorizationUrl() {
+ return getStringOrThrow(DEVICE_AUTHORIZATION_URL);
+ }
+
+ @Required
+ public String getTokenUrl() {
+ return getStringOrThrow(TOKEN_URL);
+ }
+
+ public @Nullable String getRefreshUrl() {
+ return getStringOrThrow(REFRESH_URL);
+ }
+
+ @Required
+ public Map<String, String> getScopes() {
+ return getMapStringsOrEmpty(SCOPES);
+ }
+
+ @Override
+ public Map<String, @Nullable Object> getExtensions () {
+ return super.getExtensions ();
+ }
+}

openapi-parser/src/main/java/io/openapiparser/model/v32/OAuthFlows.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-parser
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiparser.model.v32;
+
+import io.openapiparser.Context;
+import io.openapiparser.Properties;
+import io.openapiprocessor.jsonschema.schema.Bucket;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.Map;
+
+import static io.openapiparser.Keywords.*;
+
+/**
+ * the <em>OAuth Flows</em> object.
+ *
+ * <p>See specification:
+ * <a href="https://spec.openapis.org/oas/v3.2.0.html#oauth-flows-object">4.28 Oauth Flows Object</a>
+ */
+public class OAuthFlows extends Properties implements Extensions {
+
+ public OAuthFlows(Context context, Bucket bucket) {
+ super(context, bucket);
+ }
+
+ public @Nullable OAuthFlow getImplicit() {
+ return getObjectOrNull(IMPLICIT, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getPassword() {
+ return getObjectOrNull(PASSWORD, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getClientCredentials() {
+ return getObjectOrNull(CLIENT_CREDENTIALS, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getAuthorizationCode() {
+ return getObjectOrNull(AUTHORIZATION_CODE, OAuthFlow.class);
+ }
+
+ public @Nullable OAuthFlow getDeviceAuthorization() {
+ return getObjectOrNull(DEVICE_AUTHORIZATION, OAuthFlow.class);
+ }
+
+ @Override
+ public Map<String, @Nullable Object> getExtensions () {
+ return super.getExtensions ();
+ }
+}