Extensions support

stbischof · Feb 1, 2018 · b08677e · b08677e
1 parent f93d41f
commit b08677e
Show file tree

Hide file tree

Showing 40 changed files with 1,443 additions and 245 deletions.
diff --git a/...wagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java b/...wagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -51,4 +53,11 @@
      **/
     String url() default "";
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/...es/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java b/...es/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java
@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.annotations;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.info.Info;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import io.swagger.v3.oas.annotations.servers.Server;
@@ -73,4 +74,11 @@
      * @return the external documentation for this API.
      */
     ExternalDocumentation externalDocs() default @ExternalDocumentation;
+
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java
@@ -19,6 +19,7 @@
 import io.swagger.v3.oas.annotations.enums.Explode;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.enums.ParameterStyle;
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
@@ -157,4 +158,11 @@
      * @return an example of the parameter
      **/
     String example() default "";
+
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
 }
diff --git a/...s/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java b/...s/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java
@@ -17,6 +17,7 @@
 package io.swagger.v3.oas.annotations.callbacks;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
@@ -59,4 +60,11 @@
      **/
     Operation[] operation() default {};
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.info;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -51,4 +53,11 @@
      **/
     String email() default "";
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.info;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -74,4 +76,11 @@
      **/
     String version() default "";
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.info;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -44,4 +46,11 @@
      **/
     String url() default "";
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java
@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.annotations.links;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.servers.Server;
 
 import java.lang.annotation.ElementType;
@@ -83,4 +84,11 @@
      **/
     Server server() default @Server;
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/...es/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java b/...es/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java
@@ -1,5 +1,7 @@
 package io.swagger.v3.oas.annotations.media;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -55,4 +57,11 @@
      * @return boolean - whether items in an array are unique or repeating
      **/
     boolean uniqueItems() default false;
+
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.media;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -75,4 +77,11 @@
      */
     Encoding[] encoding() default {};
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java
@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.annotations.media;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.headers.Header;
 
 import java.lang.annotation.Inherited;
@@ -81,4 +82,11 @@
      */
     Header[] headers() default {};
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/.../swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java b/.../swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.media;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -60,4 +62,11 @@
      **/
     String externalValue() default "";
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java
@@ -17,6 +17,7 @@
 package io.swagger.v3.oas.annotations.media;
 
 import io.swagger.v3.oas.annotations.ExternalDocumentation;
+import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
@@ -290,4 +291,11 @@
      * An array of the sub types inheriting from this model.
      */
     Class<?>[] subTypes() default {};
+
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
 }
diff --git a/...agger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java b/...agger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java
@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.annotations.parameters;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.media.Content;
 
 import java.lang.annotation.ElementType;
@@ -57,4 +58,11 @@
      **/
     boolean required() default false;
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/...wagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java b/...wagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java
@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.annotations.responses;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
 import io.swagger.v3.oas.annotations.headers.Header;
 import io.swagger.v3.oas.annotations.links.Link;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -77,4 +78,11 @@
      **/
     Content[] content() default {};
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/...agger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponses.java b/...agger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponses.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.responses;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -38,4 +40,11 @@
      **/
     ApiResponse[] value() default {};
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/...s/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/OAuthFlow.java b/...s/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/OAuthFlow.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.security;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -56,4 +58,11 @@
      **/
     OAuthScope[] scopes() default {};
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/.../swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/OAuthFlows.java b/.../swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/OAuthFlows.java
@@ -16,6 +16,8 @@
 
 package io.swagger.v3.oas.annotations.security;
 
+import io.swagger.v3.oas.annotations.extensions.Extension;
+
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -56,4 +58,11 @@
      **/
     OAuthFlow authorizationCode() default @OAuthFlow();
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }
diff --git a/...gger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java b/...gger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java
@@ -18,6 +18,7 @@
 
 import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
 import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
+import io.swagger.v3.oas.annotations.extensions.Extension;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
@@ -95,4 +96,11 @@
      **/
     String openIdConnectUrl() default "";
 
+    /**
+     * The list of optional extensions
+     *
+     * @return an optional array of extensions
+     */
+    Extension[] extensions() default {};
+
 }