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 fc5922cb2ed CAMEL-18872: camel-core-model - Rest DSL param example not
available in XML and YAML DSL
fc5922cb2ed is described below
commit fc5922cb2edf1ed4089fd67406849fc6481051de
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Jan 10 09:13:31 2023 +0100
CAMEL-18872: camel-core-model - Rest DSL param example not available in XML
and YAML DSL
---
.../resources/org/apache/camel/catalog/models/param.json | 1 +
.../org/apache/camel/catalog/schemas/camel-spring.xsd | 10 +++++++++-
.../generated/resources/org/apache/camel/model/rest/param.json | 1 +
.../main/java/org/apache/camel/model/rest/ParamDefinition.java | 1 +
.../camel/dsl/yaml/deserializers/ModelDeserializers.java | 6 ++++++
.../src/generated/resources/schema/camel-yaml-dsl.json | 6 ++++++
.../src/generated/resources/schema/camelYamlDsl.json | 6 ++++++
7 files changed, 30 insertions(+), 1 deletion(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/param.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/param.json
index dfbf215e6c1..250fff7b5b9 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/param.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/param.json
@@ -21,6 +21,7 @@
"dataType": { "kind": "attribute", "displayName": "Data Type", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "string", "description":
"Sets the parameter data type." },
"dataFormat": { "kind": "attribute", "displayName": "Data Format",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the parameter data format." },
"allowableValues": { "kind": "element", "displayName": "Allowable Values",
"required": false, "type": "array", "javaType":
"java.util.List<org.apache.camel.model.ValueDefinition>", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the parameter list of
allowable values (enum)." },
+ "examples": { "kind": "element", "displayName": "Examples", "required":
false, "type": "array", "javaType":
"java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the parameter examples." },
"description": { "kind": "attribute", "displayName": "Description",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the parameter description." }
}
}
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index 7f805a6f603..2d25e88f247 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -21454,7 +21454,15 @@ Sets the parameter list of allowable values (enum).
</xs:element>
- <xs:element maxOccurs="unbounded" minOccurs="0" name="examples"
nillable="true" type="tns:restPropertyDefinition"/>
+ <xs:element maxOccurs="unbounded" minOccurs="0" name="examples"
type="tns:restPropertyDefinition">
+ <xs:annotation>
+ <xs:documentation xml:lang="en">
+ <![CDATA[
+Sets the parameter examples.
+ ]]>
+ </xs:documentation>
+ </xs:annotation>
+ </xs:element>
</xs:sequence>
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/param.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/param.json
index dfbf215e6c1..250fff7b5b9 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/param.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/param.json
@@ -21,6 +21,7 @@
"dataType": { "kind": "attribute", "displayName": "Data Type", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "string", "description":
"Sets the parameter data type." },
"dataFormat": { "kind": "attribute", "displayName": "Data Format",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the parameter data format." },
"allowableValues": { "kind": "element", "displayName": "Allowable Values",
"required": false, "type": "array", "javaType":
"java.util.List<org.apache.camel.model.ValueDefinition>", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the parameter list of
allowable values (enum)." },
+ "examples": { "kind": "element", "displayName": "Examples", "required":
false, "type": "array", "javaType":
"java.util.List<org.apache.camel.model.rest.RestPropertyDefinition>",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the parameter examples." },
"description": { "kind": "attribute", "displayName": "Description",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the parameter description." }
}
}
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/ParamDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/ParamDefinition.java
index d20dc7eee67..831cc72df99 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/ParamDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/ParamDefinition.java
@@ -71,6 +71,7 @@ public class ParamDefinition {
@XmlElement(name = "value") // name = value due to camel-spring-xml
@DslProperty(name = "allowableValues") // yaml-dsl
private List<ValueDefinition> allowableValues;
+ @XmlElement(name = "examples")
private List<RestPropertyDefinition> examples;
public ParamDefinition() {
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
index 31a2c13743c..5438f7880a9 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
@@ -10026,6 +10026,7 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
@YamlProperty(name = "data-type", type = "string"),
@YamlProperty(name = "default-value", type = "string"),
@YamlProperty(name = "description", type = "string"),
+ @YamlProperty(name = "examples", type =
"array:org.apache.camel.model.rest.RestPropertyDefinition"),
@YamlProperty(name = "name", type = "string", required =
true),
@YamlProperty(name = "required", type = "boolean"),
@YamlProperty(name = "type", type =
"enum:body,formData,header,path,query", required = true)
@@ -10079,6 +10080,11 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
target.setDescription(val);
break;
}
+ case "examples": {
+
java.util.List<org.apache.camel.model.rest.RestPropertyDefinition> val =
asFlatList(node, org.apache.camel.model.rest.RestPropertyDefinition.class);
+ target.setExamples(val);
+ break;
+ }
case "name": {
String val = asText(node);
target.setName(val);
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camel-yaml-dsl.json
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camel-yaml-dsl.json
index 5bd469107cb..a3648e05c0c 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camel-yaml-dsl.json
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camel-yaml-dsl.json
@@ -7394,6 +7394,12 @@
"description" : {
"type" : "string"
},
+ "examples" : {
+ "type" : "array",
+ "items" : {
+ "$ref" :
"#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition"
+ }
+ },
"name" : {
"type" : "string"
},
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
index cd42bca2c86..8cd91c10f42 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
@@ -7295,6 +7295,12 @@
"description" : {
"type" : "string"
},
+ "examples" : {
+ "type" : "array",
+ "items" : {
+ "$ref" :
"#/items/definitions/org.apache.camel.model.rest.RestPropertyDefinition"
+ }
+ },
"name" : {
"type" : "string"
},
