You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2022/05/09 07:22:37 UTC
[camel] branch main updated: CAMEL-18066, CAMEL-18065 (#7568)
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new bdcd1ff27f9 CAMEL-18066, CAMEL-18065 (#7568)
bdcd1ff27f9 is described below
commit bdcd1ff27f9af65a65cb72eb80eaaae79013a1db
Author: Johnathan Ingram <jo...@accenture.com>
AuthorDate: Mon May 9 16:52:30 2022 +0930
CAMEL-18066, CAMEL-18065 (#7568)
* CAMEL-18066: Added discriminator support for oneOf, anyOf, allOf
* CAMEL-18065: Added operation multi-tag support
---
.../apache/camel/openapi/RestModelConverters.java | 19 ++++++++++
.../apache/camel/openapi/RestOpenApiReader.java | 32 ++++++++++-------
.../camel/openapi/RestOpenApiReaderTest.java | 42 ++++++++++++++++++++++
.../apache/camel/openapi/RestOpenApiV3XOfTest.java | 7 ++--
.../org/apache/camel/openapi/model/OneOfForm.java | 10 ++++--
.../camel/openapi/model/OneOfFormWrapper.java | 4 +--
.../org/apache/camel/openapi/model/XOfFormA.java | 2 +-
.../org/apache/camel/openapi/model/XOfFormB.java | 2 +-
8 files changed, 97 insertions(+), 21 deletions(-)
diff --git a/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestModelConverters.java b/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestModelConverters.java
index 6167c630cf6..b19183e9182 100644
--- a/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestModelConverters.java
+++ b/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestModelConverters.java
@@ -28,6 +28,7 @@ import io.apicurio.datamodels.openapi.models.OasSchema;
import io.apicurio.datamodels.openapi.v2.models.Oas20Document;
import io.apicurio.datamodels.openapi.v2.models.Oas20Schema;
import io.apicurio.datamodels.openapi.v2.models.Oas20SchemaDefinition;
+import io.apicurio.datamodels.openapi.v3.models.Oas30Discriminator;
import io.apicurio.datamodels.openapi.v3.models.Oas30Document;
import io.apicurio.datamodels.openapi.v3.models.Oas30Schema.Oas30AnyOfSchema;
import io.apicurio.datamodels.openapi.v3.models.Oas30Schema.Oas30OneOfSchema;
@@ -36,6 +37,7 @@ import io.swagger.v3.core.converter.ModelConverters;
import io.swagger.v3.core.jackson.ModelResolver;
import io.swagger.v3.oas.models.media.ArraySchema;
import io.swagger.v3.oas.models.media.ComposedSchema;
+import io.swagger.v3.oas.models.media.Discriminator;
import io.swagger.v3.oas.models.media.Schema;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -134,7 +136,9 @@ public class RestModelConverters {
Oas30SchemaDefinition modelDefinition = (Oas30SchemaDefinition) model;
// oneOf
+ boolean xOf = false;
if (null != composedSchema.getOneOf()) {
+ xOf = true;
for (Schema oneOfSchema : composedSchema.getOneOf()) {
if (null != oneOfSchema.get$ref()) {
Oas30OneOfSchema oneOfModel = modelDefinition.createOneOfSchema();
@@ -148,6 +152,7 @@ public class RestModelConverters {
// allOf
if (null != composedSchema.getAllOf()) {
+ xOf = true;
for (Schema allOfSchema : composedSchema.getAllOf()) {
if (null != allOfSchema.get$ref()) {
OasSchema allOfModel = modelDefinition.createAllOfSchema();
@@ -161,6 +166,7 @@ public class RestModelConverters {
// anyOf
if (null != composedSchema.getAnyOf()) {
+ xOf = true;
for (Schema anyOfSchema : composedSchema.getAnyOf()) {
if (null != anyOfSchema.get$ref()) {
Oas30AnyOfSchema anyOfModel = modelDefinition.createAnyOfSchema();
@@ -171,6 +177,19 @@ public class RestModelConverters {
}
}
}
+
+ // Discriminator
+ if (xOf && null != composedSchema.getDiscriminator()) {
+ Discriminator discriminator = schema.getDiscriminator();
+ Oas30Discriminator modelDiscriminator = modelDefinition.createDiscriminator();
+ modelDiscriminator.propertyName = discriminator.getPropertyName();
+
+ if (null != discriminator.getMapping()) {
+ discriminator.getMapping().entrySet().stream()
+ .forEach(e -> modelDiscriminator.addMapping(e.getKey(), e.getValue()));
+ }
+ modelDefinition.discriminator = modelDiscriminator;
+ }
}
if (type != null) {
diff --git a/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java b/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java
index 6141edf3807..e89e4ea2179 100644
--- a/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java
+++ b/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java
@@ -196,11 +196,17 @@ public class RestOpenApiReader {
verbs.sort(new VerbOrdering(camelContext));
// we need to group the operations within the same tag, so use the path as default if not configured
- String pathAsTag = getValue(camelContext, rest.getTag() != null ? rest.getTag() : rest.getPath());
+ // Multi tag support for a comma delimeted tag
+ String[] pathAsTags = null != rest.getTag()
+ ? getValue(camelContext, rest.getTag()).split(",")
+ : null != rest.getPath()
+ ? new String[] { getValue(camelContext, rest.getPath()) }
+ : new String[0];
+
if (openApi instanceof Oas20Document) {
- parseOas20(camelContext, (Oas20Document) openApi, rest, pathAsTag);
+ parseOas20(camelContext, (Oas20Document) openApi, rest, pathAsTags);
} else if (openApi instanceof Oas30Document) {
- parseOas30((Oas30Document) openApi, rest, pathAsTag);
+ parseOas30((Oas30Document) openApi, rest, pathAsTags);
}
// gather all types in use
@@ -253,7 +259,7 @@ public class RestOpenApiReader {
appendModels(clazz, openApi);
}
- doParseVerbs(camelContext, openApi, rest, camelContextId, verbs, pathAsTag);
+ doParseVerbs(camelContext, openApi, rest, camelContextId, verbs, pathAsTags);
// setup root security node if necessary
List<SecurityDefinition> securityRequirements = rest.getSecurityRequirements();
@@ -270,12 +276,12 @@ public class RestOpenApiReader {
});
}
- private void parseOas30(Oas30Document openApi, RestDefinition rest, String pathAsTag) {
+ private void parseOas30(Oas30Document openApi, RestDefinition rest, String[] pathAsTags) {
String summary = rest.getDescriptionText();
- if (org.apache.camel.util.ObjectHelper.isNotEmpty(pathAsTag)) {
+ for (String tag : pathAsTags) {
// add rest as tag
- openApi.addTag(pathAsTag, summary);
+ openApi.addTag(tag, summary);
}
// setup security definitions
@@ -382,12 +388,12 @@ public class RestOpenApiReader {
}
}
- private void parseOas20(CamelContext camelContext, Oas20Document openApi, RestDefinition rest, String pathAsTag) {
+ private void parseOas20(CamelContext camelContext, Oas20Document openApi, RestDefinition rest, String[] pathAsTags) {
String summary = getValue(camelContext, rest.getDescriptionText());
- if (org.apache.camel.util.ObjectHelper.isNotEmpty(pathAsTag)) {
+ for (String tag : pathAsTags) {
// add rest as tag
- openApi.addTag(pathAsTag, summary);
+ openApi.addTag(tag, summary);
}
// setup security definitions
@@ -479,7 +485,7 @@ public class RestOpenApiReader {
private void doParseVerbs(
CamelContext camelContext, OasDocument openApi, RestDefinition rest, String camelContextId,
- List<VerbDefinition> verbs, String pathAsTag) {
+ List<VerbDefinition> verbs, String[] pathAsTags) {
String basePath = buildBasePath(camelContext, rest);
@@ -510,12 +516,12 @@ public class RestOpenApiReader {
}
OasOperation op = path.createOperation(method);
- if (org.apache.camel.util.ObjectHelper.isNotEmpty(pathAsTag)) {
+ for (String tag : pathAsTags) {
// group in the same tag
if (op.tags == null) {
op.tags = new ArrayList<>();
}
- op.tags.add(pathAsTag);
+ op.tags.add(tag);
}
// favour ids from verb, rest, route
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderTest.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderTest.java
index 68c2f545443..f18c8cef161 100644
--- a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderTest.java
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderTest.java
@@ -61,6 +61,28 @@ public class RestOpenApiReaderTest extends CamelTestSupport {
.param().name("greeting").type(RestParamType.body)
.dataType("string").description("Message to use as greeting")
.example("application/xml", "<hello>Hi</hello>").endParam().to("log:bye");
+
+ rest("/tag")
+ .get("single")
+ .tag("Organisation")
+ .consumes("application/json")
+ .produces("application/json")
+ .to("log:bye");
+
+ rest("/tag")
+ .get("multiple/a")
+ .tag("Organisation,Group A")
+ .consumes("application/json")
+ .produces("application/json")
+ .to("log:bye");
+
+ rest("/tag")
+ .get("multiple/b")
+ .tag("Organisation,Group B")
+ .consumes("application/json")
+ .produces("application/json")
+ .to("log:bye");
+
}
};
}
@@ -85,6 +107,7 @@ public class RestOpenApiReaderTest extends CamelTestSupport {
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
Object dump = Library.writeNode(openApi);
String json = mapper.writeValueAsString(dump);
+ String flatJson = json.replace("\n", " ").replaceAll("\\s+", " ");
log.info(json);
@@ -102,6 +125,17 @@ public class RestOpenApiReaderTest extends CamelTestSupport {
assertTrue(json.contains("\"error\" : \"-1\""));
assertTrue(json.contains("\"type\" : \"array\""));
+ assertTrue(flatJson.contains(
+ "\"/hello/bye\" : { \"post\" : { \"consumes\" : [ \"application/xml\" ], \"produces\" : [ \"application/xml\" ], \"tags\" : [ \"/hello\" ],"));
+ assertTrue(flatJson.contains(
+ "\"/tag/single\" : { \"get\" : { \"consumes\" : [ \"application/json\" ], \"produces\" : [ \"application/json\" ], \"tags\" : [ \"Organisation\" ],"));
+ assertTrue(flatJson.contains(
+ "\"/tag/multiple/a\" : { \"get\" : { \"consumes\" : [ \"application/json\" ], \"produces\" : [ \"application/json\" ], \"tags\" : [ \"Organisation\", \"Group A\" ],"));
+ assertTrue(flatJson.contains(
+ "\"/tag/multiple/b\" : { \"get\" : { \"consumes\" : [ \"application/json\" ], \"produces\" : [ \"application/json\" ], \"tags\" : [ \"Organisation\", \"Group B\" ],"));
+ assertTrue(flatJson.contains(
+ "\"tags\" : [ { \"name\" : \"Group B\" }, { \"name\" : \"Organisation\" }, { \"name\" : \"Group A\" }, { \"name\" : \"/hello\" } ]"));
+
context.stop();
}
@@ -124,6 +158,7 @@ public class RestOpenApiReaderTest extends CamelTestSupport {
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
Object dump = Library.writeNode(openApi);
String json = mapper.writeValueAsString(dump);
+ String flatJson = json.replace("\n", " ").replaceAll("\\s+", " ");
log.info(json);
@@ -141,6 +176,13 @@ public class RestOpenApiReaderTest extends CamelTestSupport {
assertTrue(json.contains("\"type\" : \"array\""));
assertTrue(json.contains("\"format\" : \"date-time\""));
+ assertTrue(flatJson.contains("\"/hello/bye/{name}\" : { \"get\" : { \"tags\" : [ \"/hello\" ],"));
+ assertTrue(flatJson.contains("\"/tag/single\" : { \"get\" : { \"tags\" : [ \"Organisation\" ],"));
+ assertTrue(flatJson.contains("\"/tag/multiple/a\" : { \"get\" : { \"tags\" : [ \"Organisation\", \"Group A\" ],"));
+ assertTrue(flatJson.contains("\"/tag/multiple/b\" : { \"get\" : { \"tags\" : [ \"Organisation\", \"Group B\" ],"));
+ assertTrue(flatJson.contains(
+ "\"tags\" : [ { \"name\" : \"Group B\" }, { \"name\" : \"Organisation\" }, { \"name\" : \"Group A\" }, { \"name\" : \"/hello\" } ]"));
+
context.stop();
}
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiV3XOfTest.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiV3XOfTest.java
index 9d6dc54cd25..64ef06289fd 100644
--- a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiV3XOfTest.java
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiV3XOfTest.java
@@ -56,7 +56,7 @@ public class RestOpenApiV3XOfTest extends CamelTestSupport {
.consumes("application/json")
.produces("application/json")
- .type(OneOfFormWrapper.class)
+ .type(OneOfFormWrapper.class)
.responseMessage()
.code(200).message("Ok")
.endResponseMessage()
@@ -132,7 +132,10 @@ public class RestOpenApiV3XOfTest extends CamelTestSupport {
assertTrue(json.contains(
"\"OneOfFormWrapper\" : { \"type\" : \"object\", \"properties\" : { \"formType\" : { \"type\" : \"string\" }, \"form\" : { \"$ref\" : \"#/components/schemas/OneOfForm\" } },"));
assertTrue(json.contains(
- "\"OneOfForm\" : { \"oneOf\" : [ { \"$ref\" : \"#/components/schemas/XOfFormA\" }, { \"$ref\" : \"#/components/schemas/XOfFormB\" } ]"));
+ "\"OneOfForm\" : { \"oneOf\" : [ { \"$ref\" : \"#/components/schemas/XOfFormA\" }, { \"$ref\" : \"#/components/schemas/XOfFormB\" } ],"
+ +
+ " \"discriminator\" : { \"propertyName\" : \"code\", \"mapping\" : " +
+ "{ \"a-123\" : \"#/components/schemas/org.apache.camel.openapi.model.XOfFormA\", \"b-456\" : \"#/components/schemas/org.apache.camel.openapi.model.XOfFormB\" } },"));
context.stop();
}
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfForm.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfForm.java
index ec421bcbebe..65f8e0cbbbf 100644
--- a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfForm.java
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfForm.java
@@ -16,9 +16,15 @@
*/
package org.apache.camel.openapi.model;
+import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
import io.swagger.v3.oas.annotations.media.Schema;
-@Schema(oneOf = { XOfFormA.class, XOfFormB.class })
+@Schema(oneOf = { XOfFormA.class, XOfFormB.class },
+ discriminatorProperty = "code",
+ discriminatorMapping = {
+ @DiscriminatorMapping(value = "a-123", schema = XOfFormA.class),
+ @DiscriminatorMapping(value = "b-456", schema = XOfFormB.class) })
public interface OneOfForm {
-
+ // The discriminator explicitly declares which property you can inspect to determine the object type.
+ // The discriminator must apply to the same level of the schema it is declared in (common mistake when using nested objects).
}
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfFormWrapper.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfFormWrapper.java
index 23af57a8611..6ed3b1ee59b 100644
--- a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfFormWrapper.java
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/OneOfFormWrapper.java
@@ -29,8 +29,8 @@ public class OneOfFormWrapper {
@JsonProperty("form")
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
- include = JsonTypeInfo.As.EXTERNAL_PROPERTY,
- property = "system")
+ include = JsonTypeInfo.As.EXISTING_PROPERTY,
+ property = "code")
@JsonSubTypes({
@Type(value = XOfFormA.class, name = "Form A"),
@Type(value = XOfFormB.class, name = "Form B")
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormA.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormA.java
index 3bbd5b889ff..09793eeb023 100644
--- a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormA.java
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormA.java
@@ -17,7 +17,7 @@
package org.apache.camel.openapi.model;
public class XOfFormA implements OneOfForm {
- String code;
+ String code = "a-1234";
String a;
int b;
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormB.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormB.java
index 37afc1c831f..7c05682da81 100644
--- a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormB.java
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/model/XOfFormB.java
@@ -17,7 +17,7 @@
package org.apache.camel.openapi.model;
public class XOfFormB implements OneOfForm {
- String code;
+ String code = "b-456";
int x;
String y;