This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push: new 7ba0077 Regen 7ba0077 is described below commit 7ba0077433c29affe9c4e41949b1fc81bb47babb Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Wed Aug 5 07:04:19 2020 +0200 Regen --- .../camel/catalog/components/sjms-batch.json | 2 +- .../camel/catalog/docs/sjms-batch-component.adoc | 2 +- .../modules/ROOT/pages/sjms-batch-component.adoc | 2 +- .../modules/others/pages/swagger-java.adoc | 30 +++++++++++----------- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/sjms-batch.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/sjms-batch.json index a6ee98b..2e26a3b 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/sjms-batch.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/sjms-batch.json @@ -49,7 +49,7 @@ "basicPropertyBinding": { "kind": "parameter", "displayName": "Basic Property Binding", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities" }, "headerFilterStrategy": { "kind": "parameter", "displayName": "Header Filter Strategy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "secret": false, "description": "To use a custom HeaderFilterStrategy to filter header to and from Camel message." }, "jmsKeyFormatStrategy": { "kind": "parameter", "displayName": "Jms Key Format Strategy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy", "deprecated": false, "secret": false, "description": "Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default [...] - "keepAliveDelay": { "kind": "parameter", "displayName": "Keep Alive Delay", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "secret": false, "defaultValue": "-1", "description": "The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an IllegalStateException during message consumption. This delay value [...] + "keepAliveDelay": { "kind": "parameter", "displayName": "Keep Alive Delay", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "secret": false, "defaultValue": "-1", "description": "The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an Exception during message consumption. This delay value allows you [...] "messageCreatedStrategy": { "kind": "parameter", "displayName": "Message Created Strategy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.sjms.jms.MessageCreatedStrategy", "deprecated": false, "secret": false, "description": "To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message." }, "recoveryInterval": { "kind": "parameter", "displayName": "Recovery Interval", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "secret": false, "defaultValue": "5000", "description": "Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds." }, "synchronous": { "kind": "parameter", "displayName": "Synchronous", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "false", "description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported)." }, diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/sjms-batch-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/sjms-batch-component.adoc index 340077a..2516bfa 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/sjms-batch-component.adoc +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/sjms-batch-component.adoc @@ -187,7 +187,7 @@ with the following path and query parameters: | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy | *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache [...] -| *keepAliveDelay* (advanced) | The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an IllegalStateException during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value (default is -1) then the SjmsBatchConsumer will behave as it always has before - that is it will bail out and the route will sh [...] +| *keepAliveDelay* (advanced) | The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an Exception during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value (default is -1) then the SjmsBatchConsumer will behave as it always has before - that is it will bail out and the route will shut down if i [...] | *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy | *recoveryInterval* (advanced) | Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds. | 5000 | int | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean diff --git a/docs/components/modules/ROOT/pages/sjms-batch-component.adoc b/docs/components/modules/ROOT/pages/sjms-batch-component.adoc index 1805fc9..c92b4a3 100644 --- a/docs/components/modules/ROOT/pages/sjms-batch-component.adoc +++ b/docs/components/modules/ROOT/pages/sjms-batch-component.adoc @@ -189,7 +189,7 @@ with the following path and query parameters: | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy | *jmsKeyFormatStrategy* (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache [...] -| *keepAliveDelay* (advanced) | The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an IllegalStateException during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value (default is -1) then the SjmsBatchConsumer will behave as it always has before - that is it will bail out and the route will sh [...] +| *keepAliveDelay* (advanced) | The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an Exception during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value (default is -1) then the SjmsBatchConsumer will behave as it always has before - that is it will bail out and the route will shut down if i [...] | *messageCreatedStrategy* (advanced) | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. | | MessageCreatedStrategy | *recoveryInterval* (advanced) | Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds. | 5000 | int | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean diff --git a/docs/components/modules/others/pages/swagger-java.adoc b/docs/components/modules/others/pages/swagger-java.adoc index 85ea969..6c769f1 100644 --- a/docs/components/modules/others/pages/swagger-java.adoc +++ b/docs/components/modules/others/pages/swagger-java.adoc @@ -75,14 +75,14 @@ The swagger module can be configured using the following options. To configure using a servlet you use the init-param as shown above. When configuring directly in the rest-dsl, you use the appropriate method, such as `enableCORS`, `host,contextPath`, dsl. The options -with `api.xxx` are configured using `apiProperty` dsl. +with `api.xxx` is configured using `apiProperty` dsl. [width="100%",cols="10%,10%,80%",options="header",] |=== |Option |Type |Description |cors |Boolean |Whether to enable CORS. Notice this only enables CORS for the api -browser and not the actual access to the REST services. Is default +browser, and not the actual access to the REST services. Is default false. |swagger.version |String |Swagger spec version. Is default 2.0. @@ -93,12 +93,12 @@ calculate the name as localhost based. |schemes |String |The protocol schemes to use. Multiple values can be separated by comma such as "http,https". The default value is "http". -|base.path |String |*Required*: To set up the base path where the REST services are available. +|base.path |String |*Required*: To setup the base path where the REST services is available. The path is relative (eg do not start with http/https) and camel-swagger-java will calculate the absolute base path at runtime, which will be `protocol://host:port/context-path/base.path` -|api.path |String |To set up the path where the API is available (eg /api-docs). The path is +|api.path |String |To setup the path where the API is available (eg /api-docs). The path is relative (eg do not start with http/https) and camel-swagger-java will calculate the absolute base path at runtime, which will be `protocol://host:port/context-path/api.path` So using relative paths is much easier. See above for an example. @@ -123,13 +123,13 @@ So using relative paths is much easier. See above for an example. |apiContextIdListing |boolean |Whether to allow listing all the CamelContext names in the JVM that has REST services. When enabled then the root path of the api-doc will list -all the contexts. When disabled then no context ids are listed and the +all the contexts. When disabled then no context ids is listed and the root path of the api-doc lists the current CamelContext. Is default false. -|apiContextIdPattern |String |A pattern that allows filtering in which CamelContext names are shown in the +|apiContextIdPattern |String |A pattern that allows to filter which CamelContext names is shown in the context listing. The pattern is using regular expression and * as -a wildcard. It's the same pattern matching as used by +wildcard. Its the same pattern matching as used by Intercept |=== @@ -137,7 +137,7 @@ Intercept *Since Camel 2.22.0* -The Rest DSL now supports declaring Swagger `securityDefinitions` in the generated API documentation. +The Rest DSL now supports declaring Swagger `securityDefinitions` in the generated API document. For example as shown below: [source,java] @@ -151,7 +151,7 @@ rest("/user").tag("dude").description("User rest service") .consumes("application/json").produces("application/json") ---- -Here we have set up two security definitions +Here we have setup two security definitions - OAuth2 - with implicit authorization with the provided url - Api Key - using an api key that comes from HTTP header named _myHeader_ @@ -171,32 +171,32 @@ their key (petstore_auth or api_key). ---- Here the get operation is using the Api Key security and the put operation -is using OAuth security with permitted scopes of reading and writing pets. +is using OAuth security with permitted scopes of read and write pets. == ContextIdListing enabled -When contextIdListing is enabled then it's detecting all the running +When contextIdListing is enabled then its detecting all the running CamelContexts in the same JVM. These contexts are listed in the root path, eg `/api-docs` as a simple list of names in json format. To access the swagger documentation then the context-path must be appended with the Camel context id, such as `api-docs/myCamel`. The -option apiContextIdPattern can be used to filter the names on this list. +option apiContextIdPattern can be used to filter the names in this list. == JSon or Yaml *Since Camel 2.17* The camel-swagger-java module supports both JSon and Yaml out of the -box. You can specify in the request url what you want to be returned by using +box. You can specify in the request url what you want returned by using /swagger.json or /swagger.yaml for either one. If none is specified then the HTTP Accept header is used to detect if json or yaml can be -accepted. If either both are accepted or none was set as accepted then +accepted. If either both is accepted or none was set as accepted then json is returned as the default format. == Examples -In the Apache Camel distribution, we ship +In the Apache Camel distribution we ship the `camel-example-swagger-cdi` and `camel-example-swagger-java` which demonstrates using this Swagger component.