From 8630b765c0f7ff0dc60be0f25388a397f1729b5c Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 11 Aug 2021 12:52:29 +0000 Subject: [PATCH 1/4] [version bump] new dev version --- boat-engine/pom.xml | 2 +- boat-maven-plugin/pom.xml | 2 +- boat-quay/boat-quay-lint/pom.xml | 2 +- boat-quay/boat-quay-rules/pom.xml | 2 +- boat-quay/pom.xml | 2 +- boat-scaffold/pom.xml | 4 ++-- boat-terminal/pom.xml | 2 +- boat-trail-resources/pom.xml | 2 +- pom.xml | 2 +- tests/pom.xml | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/boat-engine/pom.xml b/boat-engine/pom.xml index 5e032c153..63120d500 100644 --- a/boat-engine/pom.xml +++ b/boat-engine/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-engine jar diff --git a/boat-maven-plugin/pom.xml b/boat-maven-plugin/pom.xml index b354a51a2..5cb7543d2 100644 --- a/boat-maven-plugin/pom.xml +++ b/boat-maven-plugin/pom.xml @@ -6,7 +6,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-maven-plugin diff --git a/boat-quay/boat-quay-lint/pom.xml b/boat-quay/boat-quay-lint/pom.xml index f88d1f1b2..9e3119346 100644 --- a/boat-quay/boat-quay-lint/pom.xml +++ b/boat-quay/boat-quay-lint/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss boat-quay - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-quay-lint jar diff --git a/boat-quay/boat-quay-rules/pom.xml b/boat-quay/boat-quay-rules/pom.xml index 0da15d652..68210b8f6 100644 --- a/boat-quay/boat-quay-rules/pom.xml +++ b/boat-quay/boat-quay-rules/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss boat-quay - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-quay-rules jar diff --git a/boat-quay/pom.xml b/boat-quay/pom.xml index 03a5035fc..c95713f26 100644 --- a/boat-quay/pom.xml +++ b/boat-quay/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT diff --git a/boat-scaffold/pom.xml b/boat-scaffold/pom.xml index 9bf5c514d..3babc9c5f 100644 --- a/boat-scaffold/pom.xml +++ b/boat-scaffold/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-scaffold @@ -86,7 +86,7 @@ com.backbase.oss boat-trail-resources - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT test diff --git a/boat-terminal/pom.xml b/boat-terminal/pom.xml index bf9c6d90a..a334fdd02 100644 --- a/boat-terminal/pom.xml +++ b/boat-terminal/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-terminal diff --git a/boat-trail-resources/pom.xml b/boat-trail-resources/pom.xml index 957055c3b..c494819e3 100644 --- a/boat-trail-resources/pom.xml +++ b/boat-trail-resources/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT boat-trail-resources diff --git a/pom.xml b/pom.xml index 31513bc12..a5fc22221 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT pom Backbase Open Api Tools will help you converting RAML to OpenAPI plus many more diff --git a/tests/pom.xml b/tests/pom.xml index 9aaea49f2..a0aa00da3 100644 --- a/tests/pom.xml +++ b/tests/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.7-SNAPSHOT + 0.14.8-SNAPSHOT tests From a179a9a5f43ef8e8343ccae3136e93d14fa34b72 Mon Sep 17 00:00:00 2001 From: Nicolas Torres Date: Tue, 17 Aug 2021 11:45:19 +0200 Subject: [PATCH 2/4] No need to collect freeForm objects Stops generating alias for marina --- .../oss/codegen/BoatStaticDocsGenerator.java | 13 ------------- .../oss/codegen/marina/BoatMarinaGenerator.java | 2 +- .../main/templates/boat-marina/api.js.handlebars | 4 ---- .../backbase/oss/codegen/marina/BoatMarinaTest.java | 1 - 4 files changed, 1 insertion(+), 19 deletions(-) diff --git a/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java b/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java index 7584cd0a6..861d7ef73 100644 --- a/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java +++ b/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java @@ -20,7 +20,6 @@ import org.openapitools.codegen.CodegenModel; import org.openapitools.codegen.CodegenParameter; import org.openapitools.codegen.CodegenResponse; -import org.openapitools.codegen.utils.ModelUtils; import java.io.IOException; import java.nio.charset.Charset; @@ -71,14 +70,6 @@ public void preprocessOpenAPI(OpenAPI openAPI) { .collect(Collectors.toList())); } - // We need freeForm objects as models as well, since they are being referenced with $ref - if (openAPI.getComponents().getSchemas() != null) { - additionalProperties.put("freeFormModels", openAPI.getComponents().getSchemas().entrySet().stream() - .filter(freeFormModel -> ModelUtils.isFreeFormObject(freeFormModel.getValue())) - .map(this::mapFreeFormObject) - .collect(Collectors.toList())); - } - if (openAPI.getPaths() != null) // Ensure single tags for operations openAPI.getPaths().forEach((path, pathItem) -> @@ -104,10 +95,6 @@ private BoatExample mapComponentExample( Map.Entry namedExample return new BoatExample(key,"", example , false); } - private Object mapFreeFormObject(Map.Entry freeFormObject) {//NOSONAR - String name = freeFormObject.getKey(); - return fromModel(name, freeFormObject.getValue()); - } private CodegenParameter mapComponentParameter(Set imports, java.util.Map.Entry nameParameter) { Parameter parameter = nameParameter.getValue(); diff --git a/boat-scaffold/src/main/java/com/backbase/oss/codegen/marina/BoatMarinaGenerator.java b/boat-scaffold/src/main/java/com/backbase/oss/codegen/marina/BoatMarinaGenerator.java index 80c280ba2..7f3708e5e 100644 --- a/boat-scaffold/src/main/java/com/backbase/oss/codegen/marina/BoatMarinaGenerator.java +++ b/boat-scaffold/src/main/java/com/backbase/oss/codegen/marina/BoatMarinaGenerator.java @@ -21,7 +21,7 @@ public BoatMarinaGenerator() { embeddedTemplateDir = templateDir = NAME; cliOptions.add(new CliOption(CodegenConstants.GENERATE_ALIAS_AS_MODEL, CodegenConstants.GENERATE_ALIAS_AS_MODEL)); - additionalProperties.put(CodegenConstants.GENERATE_ALIAS_AS_MODEL, true); + additionalProperties.put(CodegenConstants.GENERATE_ALIAS_AS_MODEL, false); additionalProperties.put("appName", "BOAT Marina Documentation"); additionalProperties.put("appDescription", "For a collection of doc(k)s"); additionalProperties.put("infoUrl", "https://backbase.github.io/backbase-openapi-tools/"); diff --git a/boat-scaffold/src/main/templates/boat-marina/api.js.handlebars b/boat-scaffold/src/main/templates/boat-marina/api.js.handlebars index 32c92cd7e..2d86b2fe6 100644 --- a/boat-scaffold/src/main/templates/boat-marina/api.js.handlebars +++ b/boat-scaffold/src/main/templates/boat-marina/api.js.handlebars @@ -47,10 +47,6 @@ const data = { data["parameters"]["{{paramName}}"] = {{{jsonSchema}}}; {{/each}} -{{#each freeFormModels}} - data.models["{{name}}"] = {{{json .}}}; -{{/each}} - {{#each swagger.vendorExtensions.x-shared-errors}} let err = {{{json .}}}; data["errors"][err.errorID] = err; diff --git a/boat-scaffold/src/test/java/com/backbase/oss/codegen/marina/BoatMarinaTest.java b/boat-scaffold/src/test/java/com/backbase/oss/codegen/marina/BoatMarinaTest.java index 682f51b63..0d15d2394 100644 --- a/boat-scaffold/src/test/java/com/backbase/oss/codegen/marina/BoatMarinaTest.java +++ b/boat-scaffold/src/test/java/com/backbase/oss/codegen/marina/BoatMarinaTest.java @@ -44,7 +44,6 @@ void testGenerateDocs() throws IOException { assertTrue(generated.contains("Simple API overview")); assertTrue(generated.contains("appDescription: \"No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\",")); assertTrue(generated.contains("data.examples[\"BadRequestError\"]")); - assertTrue(generated.contains("data.models[\"ParameterMap\"]")); } From db1b1dacdf9c16e9242ec43875a301044257d6e9 Mon Sep 17 00:00:00 2001 From: Nicolas Torres Date: Tue, 17 Aug 2021 11:45:32 +0200 Subject: [PATCH 3/4] response.message is now escaped in the template --- .../com/backbase/oss/codegen/BoatStaticDocsGenerator.java | 2 -- .../com/backbase/oss/codegen/doc/BoatCodegenResponse.java | 7 +++++++ .../src/main/templates/boat-docs/response.mustache | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java b/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java index 861d7ef73..d01dee9c8 100644 --- a/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java +++ b/boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java @@ -165,8 +165,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set imports, S @Override public CodegenResponse fromResponse(String responseCode, ApiResponse response) { CodegenResponse r = super.fromResponse(responseCode, response); - r.message = StringUtils.replace(r.message, "`", "\\`"); - return new BoatCodegenResponse(r, responseCode, response, openAPI); } diff --git a/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatCodegenResponse.java b/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatCodegenResponse.java index a937f0b90..45fd5bf97 100644 --- a/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatCodegenResponse.java +++ b/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatCodegenResponse.java @@ -1,5 +1,6 @@ package com.backbase.oss.codegen.doc; +import com.samskivert.mustache.Mustache; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.responses.ApiResponse; import java.util.ArrayList; @@ -7,6 +8,7 @@ import lombok.EqualsAndHashCode; import lombok.ToString; import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.StringUtils; import org.openapitools.codegen.CodegenResponse; @Slf4j @@ -15,6 +17,11 @@ @SuppressWarnings("java:S2387") public class BoatCodegenResponse extends CodegenResponse { + public static final Mustache.Lambda escapeBackTicks = (fragment, writer) -> { + String text = fragment.execute(); + writer.write(StringUtils.replace(text, "`", "\\`")); + }; + private final List examples = new ArrayList<>(); public boolean hasExamples() { diff --git a/boat-scaffold/src/main/templates/boat-docs/response.mustache b/boat-scaffold/src/main/templates/boat-docs/response.mustache index 394b73e2a..5a198b475 100644 --- a/boat-scaffold/src/main/templates/boat-docs/response.mustache +++ b/boat-scaffold/src/main/templates/boat-docs/response.mustache @@ -105,7 +105,7 @@