OAS 3.1 - annotations and resolve logic

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPI31.java

@@ -0,0 +1,14 @@
+package io.swagger.v3.oas.annotations;
+
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.METHOD;
+
+@Target({METHOD, ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface OpenAPI31 {}

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/StringToClassMapItem.java

@@ -0,0 +1,18 @@
+package io.swagger.v3.oas.annotations;
+
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.METHOD;
+
+@Target({METHOD, ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface StringToClassMapItem {
+    String key();
+    Class<?> value();
+
+}

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Webhook.java

@@ -0,0 +1,34 @@
+package io.swagger.v3.oas.annotations;
+
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.METHOD;
+
+/**
+ * The annotation may be used to define a method as an OpenAPI Webhook.
+ *
+ * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#oasWebhooks">Webhook (OpenAPI specification)</a>
+ * @see io.swagger.v3.oas.annotations.OpenAPIDefinition
+ **/
+@Target({METHOD, ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@OpenAPI31
+public @interface Webhook {
+    /**
+     * Provides the name related to this webhook.
+     * @return webhook name
+     */
+    String name();
+
+    /**
+     * Provides the operation related to this webhook.
+     * @return webhook operation
+     */
+    Operation operation();
+
+}

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Webhooks.java

@@ -0,0 +1,29 @@
+package io.swagger.v3.oas.annotations;
+
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+
+/**
+ * Container for repeatable {@link Webhook} annotation
+ *
+ * @see Webhook
+ */
+@Target({TYPE, ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@OpenAPI31
+public @interface Webhooks {
+
+    /**
+     * An array of Webhook annotations
+     *
+     * @return the array of the Webhook
+     **/
+    Webhook[] value() default {};
+}

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java

@@ -1,5 +1,6 @@
 package io.swagger.v3.oas.annotations.info;
 
+import io.swagger.v3.oas.annotations.OpenAPI31;
 import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.ElementType;
@@ -12,6 +13,7 @@
  * The annotation may be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#info()} to populate the Info section of the OpenAPI document.
  *
  * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#infoObject">Info (OpenAPI specification)</a>
+ * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#infoObject">Info (OpenAPI specification)</a>
  * @see io.swagger.v3.oas.annotations.OpenAPIDefinition
  **/
 @Target({ElementType.ANNOTATION_TYPE})
@@ -67,4 +69,13 @@
      */
     Extension[] extensions() default {};
 
+    /**
+     * A short API summary.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return API summary
+     **/
+    @OpenAPI31
+    String summary() default "";
+
 }

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java

@@ -1,5 +1,6 @@
 package io.swagger.v3.oas.annotations.info;
 
+import io.swagger.v3.oas.annotations.OpenAPI31;
 import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.Retention;
@@ -9,7 +10,8 @@
 /**
  * The annotation may be used in {@link Info#license()} to define a license for the OpenAPI spec.
  *
- * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#licenseObject">License (OpenAPI specification)</a>
+ * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#licenseObject">License (OpenAPI 3.0 pecification)</a>
+ * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#licenseObject">License (OpenAPI 3.1 specification)</a>
  * @see io.swagger.v3.oas.annotations.OpenAPIDefinition
  * @see Info
  **/
@@ -26,7 +28,7 @@
     /**
      * A URL to the license used for the API. MUST be in the format of a URL.
      *
-     * @return the URL of the license
+     * @return URL to the license
      **/
     String url() default "";
 
@@ -37,4 +39,13 @@
      */
     Extension[] extensions() default {};
 
+    /**
+     * An identifier for a License instance.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return the identifier of the license
+     **/
+    @OpenAPI31
+    String identifier() default "";
+
 }

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java

@@ -1,5 +1,6 @@
 package io.swagger.v3.oas.annotations.media;
 
+import io.swagger.v3.oas.annotations.OpenAPI31;
 import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.Inherited;
@@ -25,13 +26,24 @@
  * coexist</p>
  *
  * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#schemaObject">Schema (OpenAPI specification)</a>
+ * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#schemaObject">Schema (OpenAPI specification)</a>
  * @see Schema
  **/
 @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 @Inherited
 public @interface ArraySchema {
 
+    /**
+     * The schemas of the items in the array
+     *
+     * @since 2.2.12
+     *
+     * @return items
+     */
+
+    Schema items() default @Schema;
+
     /**
      * The schema of the items in the array
      *
@@ -76,4 +88,49 @@
      * @return an optional array of extensions
      */
     Extension[] extensions() default {};
-}
+
+    /**
+     * Specifies contains constrictions expressions.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return contains expression.
+     */
+    @OpenAPI31
+    Schema contains() default @Schema;
+
+    /**
+     * Provides max contains related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return max contains
+     */
+    @OpenAPI31
+    int maxContains() default 0;
+
+    /**
+     * Provides min contains related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return min contains
+     */
+    @OpenAPI31
+    int minContains() default 0;
+
+    /**
+     * Provides unevaluted items to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return unevaluated items
+     */
+    @OpenAPI31
+    Schema unevaluatedItems() default @Schema;
+
+    /**
+     * Provides prefix items to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return prefixItems
+     */
+    @OpenAPI31
+    Schema[] prefixItems() default {};
+}

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java

@@ -1,5 +1,6 @@
 package io.swagger.v3.oas.annotations.media;
 
+import io.swagger.v3.oas.annotations.OpenAPI31;
 import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.ElementType;
@@ -84,4 +85,90 @@
      */
     Extension[] extensions() default {};
 
+    /**
+     * Subschemas to be applied for a given condition.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return list of dependent schemas.
+     */
+    @OpenAPI31
+    DependentSchema[] dependentSchemas() default {};
+
+    /**
+     * Provides the content schema related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return content schema
+     */
+    @OpenAPI31
+    Schema contentSchema() default @Schema();
+
+    /**
+     * Provides property names related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return proeprty names
+     */
+    @OpenAPI31
+    Schema propertyNames() default @Schema();
+
+    /**
+     * Provides the if sub schema related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return if schema
+     */
+    @OpenAPI31
+    Schema _if() default @Schema();
+
+    /**
+     * Provides the then sub schema related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return then schema
+     */
+    @OpenAPI31
+    Schema _then() default @Schema();
+
+    /**
+     * Provides the else sub schema related to this schema
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return else schema
+     */
+    @OpenAPI31
+    Schema _else() default @Schema();
+
+    /**
+     * Set schemas to validate according a given condition.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return not schema to be validated
+     **/
+    Schema not() default @Schema();
+
+    /**
+     * Provides the oneOf sub schemas related to this schema.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return oneOf sub schemas
+     **/
+    Schema[] oneOf() default {};
+
+    /**
+     * Provides the anyOf sub schemas related to this schema.
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return anyOf sub schemas
+     **/
+    Schema[] anyOf() default {};
+
+    /**
+     * Provides the allOf sub schemas related to this schema..
+     *
+     * @since 2.2.12 / OpenAPI 3.1
+     * @return allOf sub schemas
+     **/
+    Schema[] allOf() default {};
+
 }

modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DependentRequired.java

@@ -0,0 +1,44 @@
+package io.swagger.v3.oas.annotations.media;
+
+import io.swagger.v3.oas.annotations.OpenAPI31;
+
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.ElementType.TYPE;
+
+/**
+ * The annotation may be used to define dependent schemas for an Object Schema
+ *
+ * @see Schema
+ *
+ * @since 2.2.12 / OpenAPI 3.1
+ **/
+@Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@Repeatable(DependentRequiredMap.class)
+@OpenAPI31
+public @interface DependentRequired {
+    /**
+     * The name.
+     *
+     * @return the name
+     **/
+    String name() default "";
+
+    /**
+     * The values of the dependent schema.
+     *
+     * @return the schema
+     **/
+    String[] value() default {};
+
+}