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 aaff1cc CAMEL-17701: camel-core-model - Add labels to EIP options
aaff1cc is described below
commit aaff1cc1d2153fddfc1545fc925a8259f114151a
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Mar 1 14:56:07 2022 +0100
CAMEL-17701: camel-core-model - Add labels to EIP options
---
.../org/apache/camel/catalog/models/restConfiguration.json | 10 +++++-----
.../org/apache/camel/model/rest/restConfiguration.json | 10 +++++-----
.../apache/camel/model/rest/RestConfigurationDefinition.java | 10 ++++++----
3 files changed, 16 insertions(+), 14 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
index ae4912d..4e4c0d3 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
@@ -12,18 +12,18 @@
"output": false
},
"properties": {
- "component": { "kind": "attribute", "displayName": "Component",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "The
Camel Rest component to use for the REST transport (consumer), such as
netty-http, jetty, servlet, undertow. If no component has been explicit
configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestC [...]
- "apiComponent": { "kind": "attribute", "displayName": "Api Component",
"label": "consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the Camel component to use as the REST API. If no
API Component has been explicit configured, then Camel will lookup if there is
a Camel component responsible for servicing and generating the REST API
documentation, or if a org.apac [...]
- "producerComponent": { "kind": "attribute", "displayName": "Producer
Component", "label": "producer,advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the name of the Camel component to use as
the REST producer" },
+ "component": { "kind": "attribute", "displayName": "Component",
"required": false, "type": "enum", "javaType": "java.lang.String", "enum": [
"platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ],
"deprecated": false, "autowired": false, "secret": false, "description": "The
Camel Rest component to use for the REST transport (consumer), such as
netty-http, jetty, servlet, undertow. If no component has been explicit
configured, then Camel will lookup if there is a Came [...]
+ "apiComponent": { "kind": "attribute", "displayName": "Api Component",
"label": "consumer,advanced", "required": false, "type": "enum", "javaType":
"java.lang.String", "enum": [ "openapi", "swagger" ], "deprecated": false,
"autowired": false, "secret": false, "description": "The name of the Camel
component to use as the REST API. If no API Component has been explicit
configured, then Camel will lookup if there is a Camel component responsible
for servicing and generating the REST API [...]
+ "producerComponent": { "kind": "attribute", "displayName": "Producer
Component", "label": "producer,advanced", "required": false, "type": "enum",
"javaType": "java.lang.String", "enum": [ "vertx-http", "http", "undertow",
"netty-http" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Sets the name of the Camel component to use as the REST
producer" },
"scheme": { "kind": "attribute", "displayName": "Scheme", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The scheme to use for
exposing the REST service. Usually http or https is supported. The default
value is http" },
"host": { "kind": "attribute", "displayName": "Host", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The hostname to use for
exposing the REST service." },
"port": { "kind": "attribute", "displayName": "Port", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The port number to use for
exposing the REST service. Notice if you use servlet component then the port
number configured here does not apply, as the port number in use is the actual
port number the servlet component is using. eg if using Apache Tomcat its the
tomcat http port, if using Apa [...]
- "apiHost": { "kind": "attribute", "displayName": "Api Host", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "To use a specific hostname
for the API documentation (such as swagger or openapi) This can be used to
override the generated host with this configured hostname" },
+ "apiHost": { "kind": "attribute", "displayName": "Api Host", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "To use a specific hostname for the API documentation (such as
swagger or openapi) This can be used to override the generated host with this
configured hostname" },
"useXForwardHeaders": { "kind": "attribute", "displayName": "Use XForward
Headers", "label": "consumer,advanced", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Whether to use X-Forward
headers for Host and related setting. The default value is true." },
"producerApiDoc": { "kind": "attribute", "displayName": "Producer Api
Doc", "label": "producer,advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the location of the api document the REST
producer will use to validate the REST uri and query parameters are valid
accordingly to the api document. The location of the api document is loaded
from classpath by default, but you can use [...]
"contextPath": { "kind": "attribute", "displayName": "Context Path",
"label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Sets a leading context-path the REST services will be using.
This can be used when using components such as camel-servlet where the deployed
web application is deployed using a context-path. Or for components such as
camel-jetty or camel-netty-http that i [...]
"apiContextPath": { "kind": "attribute", "displayName": "Api Context
Path", "label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Sets a leading API context-path the REST API services will be
using. This can be used when using components such as camel-servlet where the
deployed web application is deployed using a context-path." },
- "apiContextRouteId": { "kind": "attribute", "displayName": "Api Context
Route Id", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": true, "autowired": false,
"secret": false, "description": "Sets the route id to use for the route that
services the REST API. The route will by default use an auto assigned route
id." },
+ "apiContextRouteId": { "kind": "attribute", "displayName": "Api Context
Route Id", "label": "consumer,advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": true, "autowired": false,
"secret": false, "description": "Sets the route id to use for the route that
services the REST API. The route will by default use an auto assigned route
id." },
"apiVendorExtension": { "kind": "attribute", "displayName": "Api Vendor
Extension", "label": "consumer,advanced", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Whether vendor
extension is enabled in the Rest APIs. If enabled then Camel will include
additional information as vendor extension (eg keys starting with x-) such as
route ids, class names etc. Not all 3rd [...]
"hostNameResolver": { "kind": "attribute", "displayName": "Host Name
Resolver", "label": "consumer,advanced", "required": false, "type": "enum",
"javaType": "org.apache.camel.model.rest.RestHostNameResolver", "enum": [
"all-local-ip", "local-host-name", "local-ip" ], "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "allLocalIp",
"description": "If no hostname has been explicit configured, then this resolver
is used to compute the hostname the REST service wil [...]
"bindingMode": { "kind": "attribute", "displayName": "Binding Mode",
"required": false, "type": "enum", "javaType":
"org.apache.camel.model.rest.RestBindingMode", "enum": [ "off", "auto", "json",
"xml", "json_xml" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "off", "description": "Sets the binding mode to use. The
default value is off" },
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/restConfiguration.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/restConfiguration.json
index ae4912d..4e4c0d3 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/restConfiguration.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/rest/restConfiguration.json
@@ -12,18 +12,18 @@
"output": false
},
"properties": {
- "component": { "kind": "attribute", "displayName": "Component",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "The
Camel Rest component to use for the REST transport (consumer), such as
netty-http, jetty, servlet, undertow. If no component has been explicit
configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestC [...]
- "apiComponent": { "kind": "attribute", "displayName": "Api Component",
"label": "consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the Camel component to use as the REST API. If no
API Component has been explicit configured, then Camel will lookup if there is
a Camel component responsible for servicing and generating the REST API
documentation, or if a org.apac [...]
- "producerComponent": { "kind": "attribute", "displayName": "Producer
Component", "label": "producer,advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the name of the Camel component to use as
the REST producer" },
+ "component": { "kind": "attribute", "displayName": "Component",
"required": false, "type": "enum", "javaType": "java.lang.String", "enum": [
"platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ],
"deprecated": false, "autowired": false, "secret": false, "description": "The
Camel Rest component to use for the REST transport (consumer), such as
netty-http, jetty, servlet, undertow. If no component has been explicit
configured, then Camel will lookup if there is a Came [...]
+ "apiComponent": { "kind": "attribute", "displayName": "Api Component",
"label": "consumer,advanced", "required": false, "type": "enum", "javaType":
"java.lang.String", "enum": [ "openapi", "swagger" ], "deprecated": false,
"autowired": false, "secret": false, "description": "The name of the Camel
component to use as the REST API. If no API Component has been explicit
configured, then Camel will lookup if there is a Camel component responsible
for servicing and generating the REST API [...]
+ "producerComponent": { "kind": "attribute", "displayName": "Producer
Component", "label": "producer,advanced", "required": false, "type": "enum",
"javaType": "java.lang.String", "enum": [ "vertx-http", "http", "undertow",
"netty-http" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Sets the name of the Camel component to use as the REST
producer" },
"scheme": { "kind": "attribute", "displayName": "Scheme", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The scheme to use for
exposing the REST service. Usually http or https is supported. The default
value is http" },
"host": { "kind": "attribute", "displayName": "Host", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The hostname to use for
exposing the REST service." },
"port": { "kind": "attribute", "displayName": "Port", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The port number to use for
exposing the REST service. Notice if you use servlet component then the port
number configured here does not apply, as the port number in use is the actual
port number the servlet component is using. eg if using Apache Tomcat its the
tomcat http port, if using Apa [...]
- "apiHost": { "kind": "attribute", "displayName": "Api Host", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "To use a specific hostname
for the API documentation (such as swagger or openapi) This can be used to
override the generated host with this configured hostname" },
+ "apiHost": { "kind": "attribute", "displayName": "Api Host", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "To use a specific hostname for the API documentation (such as
swagger or openapi) This can be used to override the generated host with this
configured hostname" },
"useXForwardHeaders": { "kind": "attribute", "displayName": "Use XForward
Headers", "label": "consumer,advanced", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Whether to use X-Forward
headers for Host and related setting. The default value is true." },
"producerApiDoc": { "kind": "attribute", "displayName": "Producer Api
Doc", "label": "producer,advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the location of the api document the REST
producer will use to validate the REST uri and query parameters are valid
accordingly to the api document. The location of the api document is loaded
from classpath by default, but you can use [...]
"contextPath": { "kind": "attribute", "displayName": "Context Path",
"label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Sets a leading context-path the REST services will be using.
This can be used when using components such as camel-servlet where the deployed
web application is deployed using a context-path. Or for components such as
camel-jetty or camel-netty-http that i [...]
"apiContextPath": { "kind": "attribute", "displayName": "Api Context
Path", "label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Sets a leading API context-path the REST API services will be
using. This can be used when using components such as camel-servlet where the
deployed web application is deployed using a context-path." },
- "apiContextRouteId": { "kind": "attribute", "displayName": "Api Context
Route Id", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": true, "autowired": false,
"secret": false, "description": "Sets the route id to use for the route that
services the REST API. The route will by default use an auto assigned route
id." },
+ "apiContextRouteId": { "kind": "attribute", "displayName": "Api Context
Route Id", "label": "consumer,advanced", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": true, "autowired": false,
"secret": false, "description": "Sets the route id to use for the route that
services the REST API. The route will by default use an auto assigned route
id." },
"apiVendorExtension": { "kind": "attribute", "displayName": "Api Vendor
Extension", "label": "consumer,advanced", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Whether vendor
extension is enabled in the Rest APIs. If enabled then Camel will include
additional information as vendor extension (eg keys starting with x-) such as
route ids, class names etc. Not all 3rd [...]
"hostNameResolver": { "kind": "attribute", "displayName": "Host Name
Resolver", "label": "consumer,advanced", "required": false, "type": "enum",
"javaType": "org.apache.camel.model.rest.RestHostNameResolver", "enum": [
"all-local-ip", "local-host-name", "local-ip" ], "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "allLocalIp",
"description": "If no hostname has been explicit configured, then this resolver
is used to compute the hostname the REST service wil [...]
"bindingMode": { "kind": "attribute", "displayName": "Binding Mode",
"required": false, "type": "enum", "javaType":
"org.apache.camel.model.rest.RestBindingMode", "enum": [ "off", "auto", "json",
"xml", "json_xml" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "off", "description": "Sets the binding mode to use. The
default value is off" },
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
index 48de04e..5b762c0 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
@@ -41,12 +41,13 @@ import org.apache.camel.support.CamelContextHelper;
public class RestConfigurationDefinition {
@XmlAttribute
+ @Metadata(enums = "platform-http,servlet,jetty,undertow,netty-http,coap")
private String component;
@XmlAttribute
- @Metadata(label = "consumer,advanced")
+ @Metadata(label = "consumer,advanced", enums = "openapi,swagger")
private String apiComponent;
@XmlAttribute
- @Metadata(label = "producer,advanced")
+ @Metadata(label = "producer,advanced", enums =
"vertx-http,http,undertow,netty-http")
private String producerComponent;
@XmlAttribute
private String scheme;
@@ -55,9 +56,10 @@ public class RestConfigurationDefinition {
@XmlAttribute
private String port;
@XmlAttribute
+ @Metadata(label = "consumer,advanced")
private String apiHost;
@XmlAttribute
- @Metadata(defaultValue = "true", label = "consumer,advanced")
+ @Metadata(label = "consumer,advanced", defaultValue = "true")
private Boolean useXForwardHeaders;
@XmlAttribute
@Metadata(label = "producer,advanced")
@@ -69,7 +71,7 @@ public class RestConfigurationDefinition {
@Metadata(label = "consumer")
private String apiContextPath;
@XmlAttribute
- @Metadata(label = "consumer")
+ @Metadata(label = "consumer,advanced")
@Deprecated
private String apiContextRouteId;
@XmlAttribute
