Release

README.md

@@ -19,6 +19,11 @@ The project is very much Work In Progress and will be published on maven central
 # Release Notes
 BOAT is still under development and subject to change.
 
+## 0.14.3
+
+* *Maven Plugin*
+  * Added new goal `boat:transform`; see the description in the [plugin documentation](boat-maven-plugin/README.md#boattransform).
+
 ## 0.14.2
 * *Angular Generator*
   * Added support for Angular version ranges in peer dependencies
@@ -39,6 +44,7 @@ BOAT is still under development and subject to change.
     * Check prefix for paths should contain version.
   * Enabled rules.
     * Use Standard HTTP Status Codes.
+
 ## 0.12.0
 * *General*
   * Improved code quality
@@ -140,13 +146,11 @@ BOAT is still under development and subject to change.
 * ability to resolve references like #/components/schemas/myObject/items or #/components/schemas/myObject/properties/embeddedObject
 * simple fix to avoid npe in StaticHtml2Generation escaping response message.
 
-
 ## 0.5.0
 
 * Add DereferenceComponentsPropertiesTransformer (that does a bit extra)
 * Fix recursive referencing in UnAliasTransformer
 
-
 ## 0.4.0
 * Added bundle skip
 * Changed numbering scheme
@@ -626,6 +630,7 @@ For the `spring` generator, the additional configuration options are:
 | `useClassLevelBeanValidation` | Adds @Validated annotation to API interfaces (Default: false) |
 | `useLombokAnnotations` | Use Lombok annotations to generate properties accessors and `hashCode`/`equals` methods (Default: false) |
 | `addServletRequest` | Adds ServletRequest objects to API method definitions (Default: false) |
+| `addBindingResult` | Adds BindingResult to Api method definitions' request bodies if UseBeanValidation true, for this to be effective you must configure UseBeanValidation, this is not done automatically (Default: false)|
 | `implicitHeaders` | Skip header parameters in the generated API methods using @ApiImplicitParams annotation. (Default: false) |
 | `swaggerDocketConfig` | Generate Spring OpenAPI Docket configuration class. (Default: false) |
 | `apiFirst` | Generate the API from the OAI spec at server compile time (API first approach) (Default: false) |

boat-engine/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.14.2-SNAPSHOT</version>
+        <version>0.14.3-SNAPSHOT</version>
     </parent>
     <artifactId>boat-engine</artifactId>
     <packaging>jar</packaging>

boat-engine/src/main/java/com/backbase/oss/boat/loader/OpenAPILoader.java

@@ -2,9 +2,12 @@
 
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.parser.OpenAPIV3Parser;
+import io.swagger.v3.parser.core.models.AuthorizationValue;
 import io.swagger.v3.parser.core.models.ParseOptions;
 import io.swagger.v3.parser.core.models.SwaggerParseResult;
 import java.io.File;
+import java.util.List;
+
 import lombok.extern.slf4j.Slf4j;
 
 @Slf4j
@@ -55,6 +58,10 @@ public static OpenAPI load(File file, boolean resolveFully, boolean flatten) thr
     }
 
     public static OpenAPI load(String url, boolean resolveFully, boolean flatten) throws OpenAPILoaderException {
+        return load(url, resolveFully, flatten, null);
+    }
+
+    public static OpenAPI load(String url, boolean resolveFully, boolean flatten, List<AuthorizationValue> auth) throws OpenAPILoaderException {
         log.debug("Reading OpenAPI from: {} resolveFully: {}", url, resolveFully);
         OpenAPIV3Parser openAPIParser = new OpenAPIV3Parser();
         ParseOptions parseOptions = new ParseOptions();
@@ -64,7 +71,7 @@ public static OpenAPI load(String url, boolean resolveFully, boolean flatten) th
         parseOptions.setFlattenComposedSchemas(true);
         parseOptions.setResolveCombinators(true);
 
-        SwaggerParseResult swaggerParseResult = openAPIParser.readLocation(url, null, parseOptions);
+        SwaggerParseResult swaggerParseResult = openAPIParser.readLocation(url, auth, parseOptions);
         if (swaggerParseResult.getOpenAPI() == null) {
             log.error("Could not load OpenAPI from : {} \n{}", url, String.join("\t\n", swaggerParseResult.getMessages()));
             throw new OpenAPILoaderException("Could not load open api from :" + url, swaggerParseResult.getMessages());

boat-engine/src/main/java/com/backbase/oss/boat/transformers/VendorExtensionFilter.java → boat-engine/src/main/java/com/backbase/oss/boat/transformers/ExtensionFilter.java

@@ -1,31 +1,51 @@
 package com.backbase.oss.boat.transformers;
 
-import static java.util.Optional.ofNullable;
-import static java.util.Spliterators.spliteratorUnknownSize;
-import static java.util.stream.StreamSupport.stream;
-
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ContainerNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.List;
 import java.util.Map;
 import java.util.Spliterator;
 
 import io.swagger.v3.core.util.Yaml;
 import io.swagger.v3.oas.models.OpenAPI;
+import lombok.Getter;
 import lombok.NonNull;
+import lombok.Setter;
 import lombok.SneakyThrows;
 
+import static java.util.Collections.emptyList;
+import static java.util.Optional.ofNullable;
+import static java.util.Spliterators.spliteratorUnknownSize;
+import static java.util.stream.Collectors.toSet;
+import static java.util.stream.StreamSupport.stream;
+
 @SuppressWarnings("java:S3740")
-public class VendorExtensionFilter implements Transformer {
+@Getter
+@Setter
+public class ExtensionFilter implements Transformer {
+
+    private List<String> remove = emptyList();
 
     @Override
     public @NonNull OpenAPI transform(@NonNull OpenAPI openAPI, @NonNull Map<String, Object> options) {
-        return ofNullable(options.get("remove"))
-            .map(remove -> transform(openAPI, (Collection<String>) remove))
-            .orElse(openAPI);
+        List<String> extensions = new ArrayList<>(remove);
+
+        ofNullable(options.get("remove"))
+            .map(Collection.class::cast)
+            .ifPresent(extensions::addAll);
+
+        extensions.addAll(
+            extensions.stream()
+                .filter(s -> !s.startsWith("x-"))
+                .map(s -> "x-" + s)
+                .collect(toSet()));
+
+        return extensions.isEmpty() ? openAPI : transform(openAPI, extensions);
     }
 
     @SneakyThrows

boat-engine/src/main/java/com/backbase/oss/boat/transformers/SpecVersionTransformer.java → boat-engine/src/main/java/com/backbase/oss/boat/transformers/SetVersion.java

@@ -2,17 +2,24 @@
 
 import java.util.Map;
 
-import static java.util.Optional.*;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
 import lombok.NonNull;
-import lombok.RequiredArgsConstructor;
+import lombok.Setter;
 
-@RequiredArgsConstructor
-public class SpecVersionTransformer implements Transformer {
+import static java.util.Optional.ofNullable;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Getter
+@Setter
+public class SetVersion implements Transformer {
 
     @NonNull
-    private final String version;
+    private String version;
 
     @Override
     public OpenAPI transform(OpenAPI openAPI, Map<String, Object> options) {
@@ -25,6 +32,12 @@ public OpenAPI transform(OpenAPI openAPI, Map<String, Object> options) {
         return openAPI;
     }
 
-}
+    /**
+     * Default setter, used at creation from POM configuration.
+     */
+    public void set(String version) {
+        setVersion(version);
+    }
 
+}
 

boat-engine/src/test/java/com/backbase/oss/boat/transformers/VendorExtensionFilterTests.java → boat-engine/src/test/java/com/backbase/oss/boat/transformers/ExtensionFilterTests.java

@@ -17,11 +17,11 @@
 import org.junit.jupiter.api.Test;
 
 @Slf4j
-class VendorExtensionFilterTests {
+class ExtensionFilterTests {
 
     @Test
     void run() throws Throwable {
-        Transformer trn = new VendorExtensionFilter();
+        Transformer trn = new ExtensionFilter();
 
         OpenAPI api1 = OpenAPILoader.load(new File("src/test/resources/openapi/extension-filter/openapi.yaml"));
         OpenAPI api2 = trn.transform(api1, singletonMap("remove", singleton("x-remove")));