Release 0.14.6

README.md

@@ -19,6 +19,14 @@ 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.6 
+* *Maven Plugin*
+  * Added `boat:ship` mojo to automagically zip specs found in `src/main/resources` and attach it to the project reactor so `mvn install` or `mvn deploy` will also include a zip archive of the project with with `api` classifier
+  * Changed `boat:bundle`  `includes` parameter to an array of patterns to allow recursive patters to discover OpenAPIs 
+* *Boat Scaffold*
+  * Fixed bug in typescript generator where only one of the overloaded function signatures per deprecated endpoint was marked as deprecated.
+
+
 ## 0.14.5
 * *Boat Marina*
   * Added `boat-markers` directory in target to keep track of successful and unsuccessful actions on OpenAPI specs

boat-engine/pom.xml

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

boat-maven-plugin/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.14.5</version>
+        <version>0.14.6-SNAPSHOT</version>
     </parent>
     <artifactId>boat-maven-plugin</artifactId>
 
@@ -27,6 +27,12 @@
         <sonar.jacoco.itReportPath>${project.basedir}/target/jacoco-it.exec</sonar.jacoco.itReportPath>
     </properties>
 
+    <dependencyManagement>
+        <dependencies>
+
+        </dependencies>
+    </dependencyManagement>
+
     <dependencies>
 
         <dependency>
@@ -69,24 +75,25 @@
         <dependency>
             <groupId>org.apache.maven.shared</groupId>
             <artifactId>maven-artifact-transfer</artifactId>
-            <version>0.12.0</version>
+            <version>0.13.1</version>
         </dependency>
 
         <dependency>
             <groupId>org.apache.maven.shared</groupId>
             <artifactId>maven-common-artifact-filters</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.codehaus.plexus</groupId>
+            <artifactId>plexus-archiver</artifactId>
+            <version>4.2.5</version>
+        </dependency>
+
         <dependency>
             <groupId>org.sonatype.plexus</groupId>
             <artifactId>plexus-build-api</artifactId>
             <version>0.0.7</version>
         </dependency>
-        <dependency>
-            <groupId>org.codehaus.plexus</groupId>
-            <artifactId>plexus-io</artifactId>
-            <version>3.2.0</version>
-        </dependency>
 
         <dependency>
             <groupId>org.apache.maven</groupId>
@@ -136,7 +143,6 @@
             <scope>test</scope>
         </dependency>
 
-
     </dependencies>
 
     <build>
@@ -155,8 +161,8 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>11</source>
+                    <target>11</target>
                 </configuration>
             </plugin>
 
@@ -171,7 +177,7 @@
                             <goal>unpack-dependencies</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>${project.build.outputDirectory}</outputDirectory>
+                            <outputDirectory>${project.build.directory}</outputDirectory>
                             <includeArtifactIds>openapi-generator-maven-plugin</includeArtifactIds>
                         </configuration>
                     </execution>

boat-maven-plugin/src/it/example/boat-bundle-ship/pom.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.backbase.oss.boat.example</groupId>
+        <artifactId>example</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>boat-bundle-ship</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+
+    <name>BOAT :: Bundle Ship Example</name>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.backbase.oss</groupId>
+                <artifactId>boat-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>bundle</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>bundle</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>ship</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>ship</goal>
+                        </goals>
+                        <configuration>
+                            <input>${project.build.directory}/openapi</input>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
+

boat-maven-plugin/src/it/example/boat-bundle-ship/src/assembly/build.xml

@@ -0,0 +1,18 @@
+<assembly xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
+          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+    <id>api</id>
+    <formats>
+        <format>zip</format>
+    </formats>
+    <includeBaseDirectory>false</includeBaseDirectory>
+    <fileSets>
+        <fileSet>
+            <directory>src/main/resources/</directory>
+            <outputDirectory>${artifactId}</outputDirectory>
+            <includes>
+                <include>**/**</include>
+            </includes>
+        </fileSet>
+    </fileSets>
+</assembly>

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/examples/user-post-request-2.json

@@ -0,0 +1,4 @@
+{
+  "name": "Robin",
+  "role": "Intern"
+}

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/examples/user-post-request.json

@@ -0,0 +1,4 @@
+{
+  "name": "Alex",
+  "role": "Manager"
+}

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/examples/user-post-response-2.json

@@ -0,0 +1,6 @@
+{
+  "id": "85494da1-2332-4a42-9a1a-a6534be2bce0",
+  "name": "Robin",
+  "role": "Intern",
+  "rank": 2
+}

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/examples/user-post-response.json

@@ -0,0 +1,7 @@
+{
+  "id": "11bd3ca6-5a26-4d97-a3f1-c59df4d6c02f",
+  "name": "Alex",
+  "role": "Manager",
+  "rank": 12,
+  "optional-param": "012"
+}

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/examples/user-post-response.xml

@@ -0,0 +1,7 @@
+<user>
+  <id>11bd3ca6-5a26-4d97-a3f1-c59df4d6c02f</id>
+  <name>Alex</name>
+  <role>Manager</role>
+  <rank>12</rank>
+  <optional-param>012</optional-param>
+</user>

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/lib/examples/bad-request-validation-error.json

@@ -0,0 +1,13 @@
+{
+	"message": "Bad Request",
+	"errors": [
+		{
+			"message": "Value Exceeded. Must be between {min} and {max}.",
+			"key": "common.api.shoe-size",
+			"context": {
+				"max": "50",
+				"min": "1"
+			}
+		}
+	]
+}

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/lib/schema/bad-request-error.yaml

@@ -0,0 +1,13 @@
+title: BadRequestError
+type: object
+properties:
+  message:
+    description: Any further information
+    type: string
+  errors:
+    description: Detailed error information
+    type: array
+    items:
+      $ref: error-item.yaml
+required:
+  - message

boat-maven-plugin/src/it/example/boat-bundle-ship/src/main/resources/bundler-examples-test-api/lib/schema/error-item.yaml

@@ -0,0 +1,16 @@
+title: ErrorItem
+type: object
+properties:
+  message:
+    description: Any further information.
+    type: string
+  key:
+    description: '{capability-name}.api.{api-key-name}. For generated validation
+            errors this is the path in the document the error resolves to. e.g. object
+            name + ''.'' + field'
+    type: string
+  context:
+    description: Context can be anything used to construct localised messages.
+    type: object
+    additionalProperties:
+      type: string