Merge pull request #566 from MikeEdgar/issue-565

Bump microprofile-parent to 2.7, remove Java 8 GitHub CI

.github/workflows/build.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [8, 11, 17]
+        java: [11, 17]
     name: build with jdk ${{matrix.java}}
 
     steps:

api/src/main/java/org/eclipse/microprofile/openapi/OASConfig.java

@@ -25,45 +25,45 @@ private OASConfig() {
 
     /**
      * Configuration property to specify the fully qualified name of the OASModelReader implementation.
-     * 
+     *
      * @see org.eclipse.microprofile.openapi.OASModelReader
      */
     public static final String MODEL_READER = "mp.openapi.model.reader";
 
     /**
      * Configuration property to specify the fully qualified name of the OASFilter implementation.
-     * 
+     *
      * @see org.eclipse.microprofile.openapi.OASFilter
      */
     public static final String FILTER = "mp.openapi.filter";
 
     /**
      * Configuration property to disable annotation scanning.
-     * 
+     *
      */
     public static final String SCAN_DISABLE = "mp.openapi.scan.disable";
 
     /**
      * Configuration property to specify the list of packages to scan.
-     * 
+     *
      */
     public static final String SCAN_PACKAGES = "mp.openapi.scan.packages";
 
     /**
      * Configuration property to specify the list of classes to scan.
-     * 
+     *
      */
     public static final String SCAN_CLASSES = "mp.openapi.scan.classes";
 
     /**
      * Configuration property to specify the list of packages to exclude from scans.
-     * 
+     *
      */
     public static final String SCAN_EXCLUDE_PACKAGES = "mp.openapi.scan.exclude.packages";
 
     /**
      * Configuration property to specify the list of classes to exclude from scans.
-     * 
+     *
      */
     public static final String SCAN_EXCLUDE_CLASSES = "mp.openapi.scan.exclude.classes";
 
@@ -74,32 +74,32 @@ private OASConfig() {
 
     /**
      * Configuration property to specify the list of global servers that provide connectivity information.
-     * 
+     *
      */
     public static final String SERVERS = "mp.openapi.servers";
 
     /**
      * Prefix of the configuration property to specify an alternative list of servers to service all operations in a
      * path.
-     * 
+     *
      */
     public static final String SERVERS_PATH_PREFIX = "mp.openapi.servers.path.";
 
     /**
      * Prefix of the configuration property to specify an alternative list of servers to service an operation.
-     * 
+     *
      */
     public static final String SERVERS_OPERATION_PREFIX = "mp.openapi.servers.operation.";
 
     /**
      * Prefix of the configuration property to specify a schema for a specific class, in JSON format.
-     * 
+     *
      */
     public static final String SCHEMA_PREFIX = "mp.openapi.schema.";
 
     /**
      * Recommended prefix for vendor specific configuration properties.
-     * 
+     *
      */
     public static final String EXTENSIONS_PREFIX = "mp.openapi.extensions.";
 

api/src/main/java/org/eclipse/microprofile/openapi/OASFactory.java

@@ -51,12 +51,12 @@
 
 /**
  * This class allows application developers to build new OpenAPI model elements.
- * 
+ *
  * <br>
  * <br>
  * For example, to start a new top-level OpenAPI element with an ExternalDocument inside of it an application developer
  * would write:
- * 
+ *
  * <pre>
  * <code>OASFactory.createObject(OpenAPI.class)
  *          .setExternalDocs(OASFactory.createObject(ExternalDocumentation.class).url("http://myDoc"));</code>
@@ -73,20 +73,20 @@ private OASFactory() {
      * <br>
      * <br>
      * Example:
-     * 
+     *
      * <pre>
      * <code>OASFactory.createObject(Info.class).title("Airlines").description("Airlines APIs").version("1.0.0");
      * </code>
      * </pre>
-     * 
+     *
      * @param <T>
      *            describes the type parameter
      * @param clazz
      *            represents a model which extends the {@link org.eclipse.microprofile.openapi.models.Constructible}
      *            interface
      *
      * @return a new instance of the requested model class
-     * 
+     *
      * @throws NullPointerException
      *             if the specified class is null
      * @throws IllegalArgumentException

api/src/main/java/org/eclipse/microprofile/openapi/OASFilter.java

@@ -31,10 +31,10 @@
 
 /**
  * This interface allows application developers to filter different parts of the OpenAPI model tree.
- * 
+ *
  * A common scenario is to dynamically augment (update or remove) OpenAPI elements based on the environment that the
  * application is currently in.
- * 
+ *
  * The registration of this filter is controlled by setting the key <b>mp.openapi.filter</b> using one of the
  * configuration sources specified in <a href="https://github.com/eclipse/microprofile-config">MicroProfile Config</a>.
  * The value is the fully qualified name of the filter implementation, which needs to be visible to the application's
@@ -46,7 +46,7 @@ public interface OASFilter {
     /**
      * Allows filtering of a particular PathItem. Implementers of this method can choose to update the given PathItem,
      * pass it back as-is, or return null if removing this PathItem.
-     * 
+     *
      * @param pathItem
      *            the current PathItem element
      * @return the PathItem to be used or null
@@ -58,7 +58,7 @@ default PathItem filterPathItem(PathItem pathItem) {
     /**
      * Allows filtering of a particular Operation. Implementers of this method can choose to update the given Operation,
      * pass it back as-is, or return null if removing this Operation.
-     * 
+     *
      * @param operation
      *            the current Operation element
      * @return the Operation to be used or null
@@ -70,7 +70,7 @@ default Operation filterOperation(Operation operation) {
     /**
      * Allows filtering of a particular Parameter. Implementers of this method can choose to update the given Parameter,
      * pass it back as-is, or return null if removing this Parameter.
-     * 
+     *
      * @param parameter
      *            the current Parameter element
      * @return the Parameter to be used or null
@@ -82,7 +82,7 @@ default Parameter filterParameter(Parameter parameter) {
     /**
      * Allows filtering of a particular Header. Implementers of this method can choose to update the given Header, pass
      * it back as-is, or return null if removing this Header.
-     * 
+     *
      * @param header
      *            the current Header element
      * @return the Header to be used or null
@@ -94,7 +94,7 @@ default Header filterHeader(Header header) {
     /**
      * Allows filtering of a particular RequestBody. Implementers of this method can choose to update the given
      * RequestBody, pass it back as-is, or return null if removing this RequestBody.
-     * 
+     *
      * @param requestBody
      *            the current RequestBody element
      * @return the RequestBody to be used or null
@@ -106,7 +106,7 @@ default RequestBody filterRequestBody(RequestBody requestBody) {
     /**
      * Allows filtering of a particular APIResponse. Implementers of this method can choose to update the given
      * APIResponse, pass it back as-is, or return null if removing this APIResponse.
-     * 
+     *
      * @param apiResponse
      *            the current APIResponse element
      * @return the APIResponse to be used or null
@@ -118,7 +118,7 @@ default APIResponse filterAPIResponse(APIResponse apiResponse) {
     /**
      * Allows filtering of a particular Schema. Implementers of this method can choose to update the given Schema, pass
      * it back as-is, or return null if removing this Schema.
-     * 
+     *
      * @param schema
      *            the current Schema element
      * @return the Schema to be used or null
@@ -130,7 +130,7 @@ default Schema filterSchema(Schema schema) {
     /**
      * Allows filtering of a particular SecurityScheme. Implementers of this method can choose to update the given
      * SecurityScheme, pass it back as-is, or return null if removing this SecurityScheme.
-     * 
+     *
      * @param securityScheme
      *            the current SecurityScheme element
      * @return the SecurityScheme to be used or null
@@ -142,7 +142,7 @@ default SecurityScheme filterSecurityScheme(SecurityScheme securityScheme) {
     /**
      * Allows filtering of a particular Server. Implementers of this method can choose to update the given Server, pass
      * it back as-is, or return null if removing this Server.
-     * 
+     *
      * @param server
      *            the current Server element
      * @return the Server to be used or null
@@ -154,7 +154,7 @@ default Server filterServer(Server server) {
     /**
      * Allows filtering of a particular Tag. Implementers of this method can choose to update the given Tag, pass it
      * back as-is, or return null if removing this Tag.
-     * 
+     *
      * @param tag
      *            the current Tag element
      * @return the Tag to be used or null
@@ -166,7 +166,7 @@ default Tag filterTag(Tag tag) {
     /**
      * Allows filtering of a particular Link. Implementers of this method can choose to update the given Link, pass it
      * back as-is, or return null if removing this Link.
-     * 
+     *
      * @param link
      *            the current Link element
      * @return the Link to be used or null
@@ -178,7 +178,7 @@ default Link filterLink(Link link) {
     /**
      * Allows filtering of a particular Callback. Implementers of this method can choose to update the given Callback,
      * pass it back as-is, or return null if removing this Callback.
-     * 
+     *
      * @param callback
      *            the current Callback element
      * @return the Callback to be used or null
@@ -192,7 +192,7 @@ default Callback filterCallback(Callback callback) {
      * or do nothing if no change is required. Note that one cannot remove this element from the model tree, hence the
      * return type of void. This is the last method called for a given filter, therefore it symbolizes the end of
      * processing by the vendor framework.
-     * 
+     *
      * @param openAPI
      *            the current OpenAPI element
      */

api/src/main/java/org/eclipse/microprofile/openapi/OASModelReader.java

@@ -19,7 +19,7 @@
 
 /**
  * This interface allows application developers to programmatically contribute an OpenAPI model tree.
- * 
+ *
  * In this scenario the developer can choose whether to provide the entire OpenAPI model while disabling annotation
  * scanning, or they can provide a starting OpenAPI model to be augmented with the application annotations.
  *
@@ -34,7 +34,7 @@ public interface OASModelReader {
      * This method is called by the vendor's OpenAPI processing framework. It can be a fully complete and valid OpenAPI
      * model tree, or a partial base model tree that will be augmented by either annotations or pre-generated OpenAPI
      * documents.
-     * 
+     *
      * @return the OpenAPI model to be used by the vendor
      */
     OpenAPI buildModel();

api/src/main/java/org/eclipse/microprofile/openapi/annotations/Components.java

@@ -35,7 +35,7 @@
 /**
  * Describes the Components object that holds various reusable objects for different aspects of the OpenAPI
  * Specification (OAS).
- * 
+ *
  * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#componentsObject"> OpenAPI
  *      Specification Components Object</a>
  */
@@ -112,7 +112,7 @@
      * corresponding to the containing annotation.
      *
      * @return array of extensions
-     * 
+     *
      * @since 3.1
      */
     Extension[] extensions() default {};

api/src/main/java/org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.java

@@ -34,7 +34,7 @@
  * When it is applied to a type and one or more of the fields are not empty strings the annotation value is added to the
  * OpenAPI document root. If more than one non-empty annotation is applied to a type in the application or if the
  * externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined.
- * 
+ *
  * @see <a href=
  *      "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#externalDocumentationObject">OpenAPI
  *      Specification External Documentation Object</a>
@@ -46,14 +46,14 @@
 
     /**
      * A short description of the target documentation.
-     * 
+     *
      * @return the documentation description
      **/
     String description() default "";
 
     /**
      * The URL for the target documentation. Value must be in the format of a URL.
-     * 
+     *
      * @return the documentation URL
      **/
     String url() default "";
@@ -63,7 +63,7 @@
      * ExternalDocumentation} model corresponding to the containing annotation.
      *
      * @return array of extensions
-     * 
+     *
      * @since 3.1
      */
     Extension[] extensions() default {};

api/src/main/java/org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.java

@@ -34,7 +34,7 @@
  * OpenAPI
  * <p>
  * This is the root document object of the OpenAPI document. It contains required and optional fields.
- * 
+ *
  * @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object">OpenAPI
  *      Specification OpenAPI Object</a>
  */
@@ -71,7 +71,7 @@
      * <p>
      * Adding a {@code SecurityRequirement} to this array is equivalent to adding a {@code SecurityRequirementsSet}
      * containing a single {@code SecurityRequirement} to {@link #securitySets()}.
-     * 
+     *
      * @return the array of security requirements for this API
      */
     SecurityRequirement[] security() default {};
@@ -82,7 +82,7 @@
      * All of the security requirements within any one of the sets must be satisfied to authorize a request.
      * <p>
      * Including an empty set within this list indicates that the other requirements are optional.
-     * 
+     *
      * @return the array of security requirement sets for this API
      */
     SecurityRequirementsSet[] securitySets() default {};
@@ -109,7 +109,7 @@
      * corresponding to the containing annotation.
      *
      * @return array of extensions
-     * 
+     *
      * @since 3.1
      */
     Extension[] extensions() default {};