Merge pull request #269 from Backbase/release-0.15.7

Release 0.15.7

Author: ntgussoni

README.md

@@ -18,10 +18,13 @@ 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.15.7
+* *Boat Scaffold*
+  * Makes sure to not autogenerate examples from schema if examples are already present
 ## 0.15.6
 * *Maven Plugin*
   * Add example of use the additional properties like createApiComponent
-* Boat Angular generator 
+* *Boat Angular generator*
   * Generate the `ng-package.json` file for use with the `ng-package` CLI
 ## 0.15.5
 * *Boat Lint*
@@ -41,7 +44,7 @@ BOAT is still under development and subject to change.
   * Made `boat:radio` goal properties w.r.t boat-bay server unique.
 ## 0.15.0
 * *Maven Plugin*
-  * Added new goal `boat:radio`; see the description in the [plugin documentation](boat-maven-plugin/README.md#boatradio).
+  * Added new goal `boat:radio`; see the description in the [plugin **documentation**](boat-maven-plugin/README.md#boatradio).
 ## 0.14.12
 * *Boat Scaffold*
   * References to /examples/foo now are also dereferenced

boat-engine/pom.xml

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

boat-maven-plugin/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
     <artifactId>boat-maven-plugin</artifactId>
 

boat-quay/boat-quay-lint/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>boat-quay</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
 
     <artifactId>boat-quay-lint</artifactId>
@@ -99,4 +99,4 @@
         </plugins>
     </build>
 
-</project>
+</project>

boat-quay/boat-quay-rules/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>boat-quay</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
 
     <artifactId>boat-quay-rules</artifactId>
@@ -172,4 +172,4 @@
         </plugins>
     </build>
 
-</project>
+</project>

boat-quay/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
 
 
@@ -29,4 +29,4 @@
         <module>boat-quay-lint</module>
     </modules>
 
-</project>
+</project>

boat-scaffold/pom.xml

@@ -5,9 +5,9 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
-  
+
     <artifactId>boat-scaffold</artifactId>
 
     <packaging>jar</packaging>
@@ -87,7 +87,7 @@
         <dependency>
             <groupId>com.backbase.oss</groupId>
             <artifactId>boat-trail-resources</artifactId>
-            <version>0.15.6</version>
+            <version>0.15.7-SNAPSHOT</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java

@@ -59,14 +59,21 @@ public static void convertExamples(OpenAPI openAPI, MediaType mediaType, String
     }
 
     private static void processRef(OpenAPI openAPI, String contentType, List<BoatExample> examples, String ref) {
-        if (ref.startsWith("#/components/schemas")) {
-            ref = StringUtils.substringAfterLast(ref, "/");
+        if (!examples.isEmpty()) return;    // No auto-generated example from the schema if examples are already present.
+        if (!ref.startsWith("#/components/schemas"))  return;
 
-            if (openAPI.getComponents().getSchemas() != null && openAPI.getComponents().getSchemas().get(ref) != null && openAPI.getComponents().getSchemas().get(ref).getExample() != null) {
-                Object example = openAPI.getComponents().getSchemas().get(ref).getExample();
-                BoatExample boatExample = new BoatExample("example", contentType, new Example().value(example), isJson(contentType));
-                examples.add(boatExample);
-            }
+        ref = StringUtils.substringAfterLast(ref, "/");
+
+        boolean hasValidRef = openAPI.getComponents().getSchemas() != null && openAPI.getComponents().getSchemas().get(ref) != null;
+
+        if (!hasValidRef) return;
+
+        Schema schema = openAPI.getComponents().getSchemas().get(ref);
+
+        if (schema.getExample() != null) {
+            Object example = schema.getExample();
+            BoatExample boatExample = new BoatExample("example", contentType, new Example().value(example), isJson(contentType));
+            examples.add(boatExample);
         }
     }
 

boat-terminal/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
 
     <artifactId>boat-terminal</artifactId>

boat-trail-resources/pom.xml

@@ -5,9 +5,9 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.15.6</version>
+        <version>0.15.7-SNAPSHOT</version>
     </parent>
-  
+
     <artifactId>boat-trail-resources</artifactId>
 
     <packaging>jar</packaging>