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 dbc0209722a [Rest] Fix typos and align style (#7896)
dbc0209722a is described below
commit dbc0209722a018bad6f6a19ef443a251ac93872b
Author: Andrej Vaňo <[email protected]>
AuthorDate: Mon Jun 27 19:54:28 2022 +0200
[Rest] Fix typos and align style (#7896)
---
.../org/apache/camel/component/rest/rest-api.json | 2 +-
.../org/apache/camel/component/rest/rest.json | 10 +++++-----
.../camel-rest/src/main/docs/rest-component.adoc | 18 +++++++++---------
.../apache/camel/component/rest/RestApiEndpoint.java | 4 ++--
.../org/apache/camel/component/rest/RestComponent.java | 12 ++++++------
.../org/apache/camel/component/rest/RestEndpoint.java | 8 ++++----
6 files changed, 27 insertions(+), 27 deletions(-)
diff --git
a/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest-api.json
b/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest-api.json
index 607d9130529..161a233396d 100644
---
a/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest-api.json
+++
b/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest-api.json
@@ -28,7 +28,7 @@
"properties": {
"path": { "kind": "path", "displayName": "Path", "group": "consumer",
"label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The base path" },
"apiComponentName": { "kind": "parameter", "displayName": "Api Component
Name", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The Camel Rest API component to use for
generating the API of the REST services, such as openapi." },
- "consumerComponentName": { "kind": "parameter", "displayName": "Consumer
Component Name", "group": "consumer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The Camel Rest component to use for
(consumer) the REST transport, such as jetty, servlet, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with [...]
+ "consumerComponentName": { "kind": "parameter", "displayName": "Consumer
Component Name", "group": "consumer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The Camel Rest component to use for the
consumer REST transport, such as jetty, servlet, undertow. If no component has
been explicitly configured, then Camel will lookup if there is a Camel
component that integrates with [...]
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Allows for bridging the consumer to the Camel routing Error
Handler, which mean any exceptions occurred while the consumer is trying to
pickup incoming messages, or the likes, will now [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By default the
con [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Sets the exchange pattern when the consumer creates an
exchange." }
diff --git
a/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest.json
b/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest.json
index c6fa7f239e3..b34e388d7b5 100644
---
a/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest.json
+++
b/components/camel-rest/src/generated/resources/org/apache/camel/component/rest/rest.json
@@ -24,12 +24,12 @@
},
"componentProperties": {
"bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Allows for bridging the
consumer to the Camel routing Error Handler, which mean any exceptions occurred
while the consumer is trying to pickup incoming messages, or the likes, will
now be processed as a me [...]
- "consumerComponentName": { "kind": "property", "displayName": "Consumer
Component Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for (consumer) the REST transport, such as jetty, servlet, undertow. If
no component has been explicit configured, then Camel will lookup if there is a
Camel component that integrate [...]
+ "consumerComponentName": { "kind": "property", "displayName": "Consumer
Component Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for the consumer REST transport, such as jetty, servlet, undertow. If no
component has been explicitly configured, then Camel will lookup if there is a
Camel component that integrate [...]
"apiDoc": { "kind": "property", "displayName": "Api Doc", "group":
"producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The swagger api doc resource to use. The
resource is loaded from classpath by default and must be in JSON format." },
- "componentName": { "kind": "property", "displayName": "Component Name",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": true, "autowired": false,
"secret": false, "description": "The Camel Rest component to use for (producer)
the REST transport, such as http, 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 [...]
+ "componentName": { "kind": "property", "displayName": "Component Name",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": true, "autowired": false,
"secret": false, "description": "The Camel Rest component to use for the
producer REST transport, such as http, undertow. If no component has been
explicitly configured, then Camel will lookup if there is a Camel component
that integrates with the Rest DSL, or if a [...]
"host": { "kind": "property", "displayName": "Host", "group": "producer",
"label": "producer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Host and port of HTTP service to use (override host in swagger
schema)" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Whether the producer
should be started lazy (on the first message). By starting lazy you can use
this to allow CamelContext and routes to startup in situations where a producer
may otherwise fail during star [...]
- "producerComponentName": { "kind": "property", "displayName": "Producer
Component Name", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for (producer) the REST transport, such as http, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with the [...]
+ "producerComponentName": { "kind": "property", "displayName": "Producer
Component Name", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for the producer REST transport, such as http, undertow. If no component
has been explicitly configured, then Camel will lookup if there is a Camel
component that integrates with the [...]
"autowiredEnabled": { "kind": "property", "displayName": "Autowired
Enabled", "group": "advanced", "label": "advanced", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Whether autowiring is
enabled. This is used for automatic autowiring options (the option must be
marked as autowired) by looking up in the registry to find if there is a single
instance of matching type, which t [...]
},
"headers": {
@@ -49,7 +49,7 @@
"outType": { "kind": "parameter", "displayName": "Out Type", "group":
"common", "label": "common", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "To declare the outgoing POJO binding type as a FQN class name"
},
"produces": { "kind": "parameter", "displayName": "Produces", "group":
"common", "label": "common", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Media type such as: 'text\/xml', or 'application\/json' this
REST service returns." },
"routeId": { "kind": "parameter", "displayName": "Route Id", "group":
"common", "label": "common", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the route this REST services creates" },
- "consumerComponentName": { "kind": "parameter", "displayName": "Consumer
Component Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for (consumer) the REST transport, such as jetty, servlet, undertow. If
no component has been explicit configured, then Camel will lookup if there is a
Camel component that integrat [...]
+ "consumerComponentName": { "kind": "parameter", "displayName": "Consumer
Component Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for the consumer REST transport, such as jetty, servlet, undertow. If no
component has been explicitly configured, then Camel will lookup if there is a
Camel component that integrat [...]
"description": { "kind": "parameter", "displayName": "Description",
"group": "consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Human description to document this REST
service" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Allows for bridging the consumer to the Camel routing Error
Handler, which mean any exceptions occurred while the consumer is trying to
pickup incoming messages, or the likes, will now [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By default the
con [...]
@@ -57,7 +57,7 @@
"apiDoc": { "kind": "parameter", "displayName": "Api Doc", "group":
"producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The openapi api doc resource to use. The
resource is loaded from classpath by default and must be in JSON format." },
"bindingMode": { "kind": "parameter", "displayName": "Binding Mode",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.camel.spi.RestConfiguration.RestBindingMode", "enum": [
"auto", "off", "json", "xml", "json_xml" ], "deprecated": false, "autowired":
false, "secret": false, "description": "Configures the binding mode for the
producer. If set to anything other than 'off' the producer will try to convert
the body of the incoming me [...]
"host": { "kind": "parameter", "displayName": "Host", "group": "producer",
"label": "producer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Host and port of HTTP service to use (override host in openapi
schema)" },
- "producerComponentName": { "kind": "parameter", "displayName": "Producer
Component Name", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for (producer) the REST transport, such as http, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with th [...]
+ "producerComponentName": { "kind": "parameter", "displayName": "Producer
Component Name", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The Camel Rest component
to use for the producer REST transport, such as http, undertow. If no component
has been explicitly configured, then Camel will lookup if there is a Camel
component that integrates with th [...]
"queryParameters": { "kind": "parameter", "displayName": "Query
Parameters", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Query parameters for the
HTTP service to call. The query parameters can contain multiple parameters
separated by ampersand such such as foo=123&bar=456." },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether the producer should be started lazy (on the first
message). By starting lazy you can use this to allow CamelContext and routes to
startup in situations where a producer may other [...]
}
diff --git a/components/camel-rest/src/main/docs/rest-component.adoc
b/components/camel-rest/src/main/docs/rest-component.adoc
index d6b9568e3e9..1514910ffed 100644
--- a/components/camel-rest/src/main/docs/rest-component.adoc
+++ b/components/camel-rest/src/main/docs/rest-component.adoc
@@ -154,9 +154,9 @@ from("direct:start")
== Rest producer binding
-The REST producer supports binding using JSon or XML like the rest-dsl does.
+The REST producer supports binding using JSON or XML like the rest-dsl does.
-For example to use jetty with json binding mode turned on you can configure
this in the rest configuration:
+For example to use jetty with JSON binding mode turned on you can configure
this in the rest configuration:
[source,java]
----
@@ -166,7 +166,7 @@ from("direct:start")
.to("rest:post:user");
----
-Then when calling the REST service using rest producer it will automatic bind
any POJOs to json before calling the REST service:
+Then when calling the REST service using REST producer it will automatic bind
any POJOs to JSON before calling the REST service:
[source,java]
----
@@ -177,13 +177,13 @@ Then when calling the REST service using rest producer it
will automatic bind an
template.sendBody("direct:start", user);
----
-In the example above we send a POJO instance `UserPojo` as the message body.
And because we have turned on JSon binding
-in the rest configuration, then the POJO will be marshalled from POJO to JSon
before calling the REST service.
+In the example above we send a POJO instance `UserPojo` as the message body.
And because we have turned on JSON binding
+in the rest configuration, then the POJO will be marshalled from POJO to JSON
before calling the REST service.
-However if you want to also perform binding for the response message (eg what
the REST service send back as response) you
-would need to configure the `outType` option to specify what is the classname
of the POJO to unmarshal from JSon to POJO.
+However if you want to also perform binding for the response message (e.g.
what the REST service sends back as response) you
+would need to configure the `outType` option to specify what is the class name
of the POJO to unmarshal from JSON to POJO.
-For example if the REST service returns a JSon payload that binds to
`com.foo.MyResponsePojo` you can configure this as shown:
+For example if the REST service returns a JSON payload that binds to
`com.foo.MyResponsePojo` you can configure this as shown:
[source,java]
----
@@ -203,7 +203,7 @@ can use the Rest DSL to define those in a nicer RESTful way.
There is a *camel-example-servlet-rest-tomcat* example in the Apache
Camel distribution, that demonstrates how to use the
-Rest DSL with SERVLET as
+Rest DSL with Servlet as
transport that can be deployed on Apache Tomcat, or similar web
containers.
diff --git
a/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
b/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
index a9598e5ecef..c7e0836591f 100644
---
a/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
+++
b/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
@@ -86,8 +86,8 @@ public class RestApiEndpoint extends DefaultEndpoint {
}
/**
- * The Camel Rest component to use for (consumer) the REST transport, such
as jetty, servlet, undertow. If no
- * component has been explicit configured, then Camel will lookup if there
is a Camel component that integrates with
+ * The Camel Rest component to use for the consumer REST transport, such
as jetty, servlet, undertow. If no
+ * component has been explicitly configured, then Camel will lookup if
there is a Camel component that integrates with
* the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is
registered in the registry. If either one is
* found, then that is being used.
*/
diff --git
a/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestComponent.java
b/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestComponent.java
index fb6226ee151..290418ab5fd 100644
---
a/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestComponent.java
+++
b/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestComponent.java
@@ -144,8 +144,8 @@ public class RestComponent extends DefaultComponent {
}
/**
- * The Camel Rest component to use for (consumer) the REST transport, such
as jetty, servlet, undertow. If no
- * component has been explicit configured, then Camel will lookup if there
is a Camel component that integrates with
+ * The Camel Rest component to use for the consumer REST transport, such
as jetty, servlet, undertow. If no
+ * component has been explicitly configured, then Camel will lookup if
there is a Camel component that integrates with
* the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is
registered in the registry. If either one is
* found, then that is being used.
*/
@@ -158,8 +158,8 @@ public class RestComponent extends DefaultComponent {
}
/**
- * The Camel Rest component to use for (producer) the REST transport, such
as http, undertow. If no component has
- * been explicit configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL,
+ * The Camel Rest component to use for the producer REST transport, such
as http, undertow. If no component has
+ * been explicitly configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL,
* or if a org.apache.camel.spi.RestProducerFactory is registered in the
registry. If either one is found, then that
* is being used.
*/
@@ -173,8 +173,8 @@ public class RestComponent extends DefaultComponent {
}
/**
- * The Camel Rest component to use for (producer) the REST transport, such
as http, undertow. If no component has
- * been explicit configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL,
+ * The Camel Rest component to use for the producer REST transport, such
as http, undertow. If no component has
+ * been explicitly configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL,
* or if a org.apache.camel.spi.RestProducerFactory is registered in the
registry. If either one is found, then that
* is being used.
*
diff --git
a/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
b/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
index 5672a9a9730..57afcaf8c41 100644
---
a/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
+++
b/components/camel-rest/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
@@ -177,8 +177,8 @@ public class RestEndpoint extends DefaultEndpoint {
}
/**
- * The Camel Rest component to use for (producer) the REST transport, such
as http, undertow. If no component has
- * been explicit configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL,
+ * The Camel Rest component to use for the producer REST transport, such
as http, undertow. If no component has
+ * been explicitly configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL,
* or if a org.apache.camel.spi.RestProducerFactory is registered in the
registry. If either one is found, then that
* is being used.
*/
@@ -191,8 +191,8 @@ public class RestEndpoint extends DefaultEndpoint {
}
/**
- * The Camel Rest component to use for (consumer) the REST transport, such
as jetty, servlet, undertow. If no
- * component has been explicit configured, then Camel will lookup if there
is a Camel component that integrates with
+ * The Camel Rest component to use for the consumer REST transport, such
as jetty, servlet, undertow. If no
+ * component has been explicitly configured, then Camel will lookup if
there is a Camel component that integrates with
* the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is
registered in the registry. If either one is
* found, then that is being used.
*/
