From 87a9e693300bb09edf5da5b20740004fb71f7ec9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 30 Aug 2021 13:49:23 +0000 Subject: [PATCH 1/5] [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 eceae501d..e1a17a936 100644 --- a/boat-engine/pom.xml +++ b/boat-engine/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-engine jar diff --git a/boat-maven-plugin/pom.xml b/boat-maven-plugin/pom.xml index b251529bb..8e58c3a22 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.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-maven-plugin diff --git a/boat-quay/boat-quay-lint/pom.xml b/boat-quay/boat-quay-lint/pom.xml index bfb84dd5b..3a086ac9d 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.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-quay-lint jar diff --git a/boat-quay/boat-quay-rules/pom.xml b/boat-quay/boat-quay-rules/pom.xml index d11bd33eb..20a32a253 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.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-quay-rules jar diff --git a/boat-quay/pom.xml b/boat-quay/pom.xml index c4b615abf..3206875d5 100644 --- a/boat-quay/pom.xml +++ b/boat-quay/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.9-SNAPSHOT + 0.14.10-SNAPSHOT diff --git a/boat-scaffold/pom.xml b/boat-scaffold/pom.xml index 848d06b45..81b604f18 100644 --- a/boat-scaffold/pom.xml +++ b/boat-scaffold/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-scaffold @@ -86,7 +86,7 @@ com.backbase.oss boat-trail-resources - 0.14.9-SNAPSHOT + 0.14.10-SNAPSHOT test diff --git a/boat-terminal/pom.xml b/boat-terminal/pom.xml index 1489c1cf6..1a852cb33 100644 --- a/boat-terminal/pom.xml +++ b/boat-terminal/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-terminal diff --git a/boat-trail-resources/pom.xml b/boat-trail-resources/pom.xml index b359f01d3..1ed32dfc6 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.9-SNAPSHOT + 0.14.10-SNAPSHOT boat-trail-resources diff --git a/pom.xml b/pom.xml index 9c705a595..63e781065 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.9-SNAPSHOT + 0.14.10-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 5d7982687..778dbe423 100644 --- a/tests/pom.xml +++ b/tests/pom.xml @@ -5,7 +5,7 @@ com.backbase.oss backbase-openapi-tools - 0.14.9-SNAPSHOT + 0.14.10-SNAPSHOT tests From 3cfb97be9e82c5feb504b79b7a89229a2eb00f6b Mon Sep 17 00:00:00 2001 From: Nicolas Torres Date: Thu, 9 Sep 2021 15:59:38 +0200 Subject: [PATCH 2/5] Fixes some paths with urlencoded parts not being dereferenced --- .../com/backbase/oss/codegen/doc/BoatExampleUtils.java | 4 +++- .../resources/oas-examples/petstore-example-refs.yaml | 8 ++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java b/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java index 40a4b6b25..8dbfbe133 100644 --- a/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java +++ b/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java @@ -14,6 +14,7 @@ import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; +import java.net.URLDecoder; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @@ -129,8 +130,9 @@ private static void resolvePathsExamples( log.warn("Example ref: {} refers to '/paths' but it is not there.", ref); return; } + String[] refParts = Arrays.stream(ref.replace(PATHS_REF_PREFIX, "").split("/")) - .map(s -> s.replace("~1", "/")) + .map(s -> URLDecoder.decode(s.replace("~1", "/").replace("~0", "~"), java.nio.charset.Charset.forName(("UTF-8")))) .toArray(String[]::new); String pathName = refParts[1]; diff --git a/boat-scaffold/src/test/resources/oas-examples/petstore-example-refs.yaml b/boat-scaffold/src/test/resources/oas-examples/petstore-example-refs.yaml index e3f1cbe80..cf14df2f8 100644 --- a/boat-scaffold/src/test/resources/oas-examples/petstore-example-refs.yaml +++ b/boat-scaffold/src/test/resources/oas-examples/petstore-example-refs.yaml @@ -68,6 +68,14 @@ paths: $ref: "#/components/schemas/Error" example: $ref: "#/components/examples/InternalServerError" + '400': + description: InternalServerError + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + example: + $ref: "#/paths/~1pets~1%7BpetId%7D/get/responses/default/content/application~1json/example" default: description: unexpected error content: From 21797f315d3c13599f221a3e53db21aec065c7e6 Mon Sep 17 00:00:00 2001 From: Nicolas Torres Date: Thu, 9 Sep 2021 16:01:28 +0200 Subject: [PATCH 3/5] Adds release note --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 78746f131..32169c5e4 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,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.10 +* *Boat Scaffold* + * Makes sure to URLDecode paths while dereferencing examples +## 0.14.9 +* *Boat Scaffold* + * Resolve references to other path operations' examples -## 0.14.8 +* ## 0.14.8 * *Boat Marina* * Removes flatObjects as they are no longer needed * response.message was wrongfully escaped, escaping in the docs template instead From 015778a2fa4166843096c5dee4e9f1b5132fb2bb Mon Sep 17 00:00:00 2001 From: Nicolas Torres Date: Thu, 9 Sep 2021 16:05:33 +0200 Subject: [PATCH 4/5] Replace with standardCharset --- .../java/com/backbase/oss/codegen/doc/BoatExampleUtils.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java b/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java index 8dbfbe133..0998c5c04 100644 --- a/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java +++ b/boat-scaffold/src/main/java/com/backbase/oss/codegen/doc/BoatExampleUtils.java @@ -15,6 +15,7 @@ import org.apache.commons.lang3.StringUtils; import java.net.URLDecoder; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @@ -132,7 +133,7 @@ private static void resolvePathsExamples( } String[] refParts = Arrays.stream(ref.replace(PATHS_REF_PREFIX, "").split("/")) - .map(s -> URLDecoder.decode(s.replace("~1", "/").replace("~0", "~"), java.nio.charset.Charset.forName(("UTF-8")))) + .map(s -> URLDecoder.decode(s.replace("~1", "/").replace("~0", "~"), StandardCharsets.UTF_8)) .toArray(String[]::new); String pathName = refParts[1]; From 9bf9d6e0e9dcc17a4c6f84e3c944cd618fab7a97 Mon Sep 17 00:00:00 2001 From: Nicolas Torres Date: Thu, 9 Sep 2021 16:13:22 +0200 Subject: [PATCH 5/5] FIx typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32169c5e4..a967307c9 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ BOAT is still under development and subject to change. * *Boat Scaffold* * Resolve references to other path operations' examples -* ## 0.14.8 +## 0.14.8 * *Boat Marina* * Removes flatObjects as they are no longer needed * response.message was wrongfully escaped, escaping in the docs template instead