This is an automated email from the ASF dual-hosted git repository.
acosentino 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 86fbd34 Regen
86fbd34 is described below
commit 86fbd3477186ea11a030a0a37165ea5e66cea0be
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Fri Aug 28 14:31:26 2020 +0200
Regen
---
.../org/apache/camel/catalog/components/jira.json | 4 +++-
.../org/apache/camel/catalog/docs/jira-component.adoc | 17 +++++++++++++++--
docs/components/modules/ROOT/pages/jira-component.adoc | 17 +++++++++++++++--
3 files changed, 33 insertions(+), 5 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/jira.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/jira.json
index d35a9a4..b802834 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/jira.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/jira.json
@@ -35,12 +35,14 @@
"verificationCode": { "kind": "property", "displayName": "Verification
Code", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "secret": true,
"configurationClass": "org.apache.camel.component.jira.JiraConfiguration",
"configurationField": "configuration", "description": "(OAuth only) The
verification code from Jira generated in the first step of the authorization
proccess." }
},
"properties": {
- "type": { "kind": "path", "displayName": "Type", "group": "common",
"label": "", "required": true, "type": "object", "javaType":
"org.apache.camel.component.jira.JiraType", "enum": [ "ADDCOMMENT", "ADDISSUE",
"ATTACH", "DELETEISSUE", "NEWISSUES", "NEWCOMMENTS", "UPDATEISSUE",
"TRANSITIONISSUE", "WATCHERS", "ADDISSUELINK", "ADDWORKLOG", "FETCHISSUE",
"FETCHCOMMENTS" ], "deprecated": false, "deprecationNote": "", "secret": false,
"description": "Operation to perform. Consumers: NewIssu [...]
+ "type": { "kind": "path", "displayName": "Type", "group": "common",
"label": "", "required": true, "type": "object", "javaType":
"org.apache.camel.component.jira.JiraType", "enum": [ "ADDCOMMENT", "ADDISSUE",
"ATTACH", "DELETEISSUE", "NEWISSUES", "NEWCOMMENTS", "WATCHUPDATES",
"UPDATEISSUE", "TRANSITIONISSUE", "WATCHERS", "ADDISSUELINK", "ADDWORKLOG",
"FETCHISSUE", "FETCHCOMMENTS" ], "deprecated": false, "deprecationNote": "",
"secret": false, "description": "Operation to perform. Co [...]
"delay": { "kind": "parameter", "displayName": "Delay", "group": "common",
"label": "", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "secret": false, "defaultValue":
"6000", "configurationClass":
"org.apache.camel.component.jira.JiraConfiguration", "configurationField":
"configuration", "description": "Time in milliseconds to elapse for the next
poll." },
"jiraUrl": { "kind": "parameter", "displayName": "Jira Url", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "secret":
false, "configurationClass":
"org.apache.camel.component.jira.JiraConfiguration", "configurationField":
"configuration", "description": "The Jira server url, example:
http:\/\/my_jira.com:8081" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": 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 message and handled b [...]
"jql": { "kind": "parameter", "displayName": "Jql", "group": "consumer",
"label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description": "JQL
is the query language from JIRA which allows you to retrieve the data you want.
For example jql=project=MyProject Where MyProject is the product key in Jira.
It is important to use the RAW() and set the JQL inside it to prevent camel
parsing it, example: RAW(project [...]
"maxResults": { "kind": "parameter", "displayName": "Max Results",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "secret": false,
"defaultValue": "50", "description": "Max number of issues to search for" },
+ "sendOnlyUpdatedField": { "kind": "parameter", "displayName": "Send Only
Updated Field", "group": "consumer", "label": "consumer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "true", "description": "Indicator for sending only changed
fields in exchange body or issue object. By default consumer sends only changed
fields." },
+ "watchedFields": { "kind": "parameter", "displayName": "Watched Fields",
"group": "consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"defaultValue": "Status,Priority", "description": "Comma separated list of
fields to watch for changes. Status,Priority are the defaults." },
"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, "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 consumer will deal with [...]
"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, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": 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 starting and cause the [...]
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jira-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jira-component.adoc
index 8cb2d44..fd2d3a6 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jira-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jira-component.adoc
@@ -78,6 +78,7 @@ For consumers:
* newIssues: retrieve only new issues after the route is started
* newComments: retrieve only new comments after the route is started
+* watchUpdates: retrieve only updated fields/issues based on provided jql
For producers:
@@ -106,11 +107,11 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *type* | *Required* Operation to perform. Consumers: NewIssues, NewComments.
Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue,
Watchers. See this class javadoc description for more information. The value
can be one of: ADDCOMMENT, ADDISSUE, ATTACH, DELETEISSUE, NEWISSUES,
NEWCOMMENTS, UPDATEISSUE, TRANSITIONISSUE, WATCHERS, ADDISSUELINK, ADDWORKLOG,
FETCHISSUE, FETCHCOMMENTS | | JiraType
+| *type* | *Required* Operation to perform. Consumers: NewIssues, NewComments.
Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue,
Watchers. See this class javadoc description for more information. The value
can be one of: ADDCOMMENT, ADDISSUE, ATTACH, DELETEISSUE, NEWISSUES,
NEWCOMMENTS, WATCHUPDATES, UPDATEISSUE, TRANSITIONISSUE, WATCHERS,
ADDISSUELINK, ADDWORKLOG, FETCHISSUE, FETCHCOMMENTS | | JiraType
|===
-=== Query Parameters (16 parameters):
+=== Query Parameters (18 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -121,6 +122,8 @@ with the following path and query parameters:
| *bridgeErrorHandler* (consumer) | 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 message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
| *jql* (consumer) | JQL is the query language from JIRA which allows you to
retrieve the data you want. For example jql=project=MyProject Where MyProject
is the product key in Jira. It is important to use the RAW() and set the JQL
inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND
resolution = Unresolved) | | String
| *maxResults* (consumer) | Max number of issues to search for | 50 | Integer
+| *sendOnlyUpdatedField* (consumer) | Indicator for sending only changed
fields in exchange body or issue object. By default consumer sends only changed
fields. | true | boolean
+| *watchedFields* (consumer) | Comma separated list of fields to watch for
changes. Status,Priority are the defaults. | Status,Priority | String
| *exceptionHandler* (consumer) | 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 consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
| *lazyStartProducer* (producer) | 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
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
@@ -267,5 +270,15 @@ Required:
* `IssueWatchersAdd`: A list of strings with the usernames to add to the
watcher list.
* `IssueWatchersRemove`: A list of strings with the usernames to remove from
the watcher list.
+== WatchUpdates (consumer)
+* `watchedFields` Comma separated list of fields to watch for changes i.e
`Status,Priority,Assignee,Components` etc.
+* `sendOnlyUpdatedField` By default only changed field is send as the body.
+
+All messages also contain following headers that add additional info about the
change:
+
+* `issueKey`: Key of the updated issue
+* `changed`: name of the updated field (i.e Status)
+* `watchedIssues`: list of all issue keys that are watched in the time of
update
+
include::camel-spring-boot::page$jira-starter.adoc[]
diff --git a/docs/components/modules/ROOT/pages/jira-component.adoc
b/docs/components/modules/ROOT/pages/jira-component.adoc
index d2f9292..689f35b 100644
--- a/docs/components/modules/ROOT/pages/jira-component.adoc
+++ b/docs/components/modules/ROOT/pages/jira-component.adoc
@@ -80,6 +80,7 @@ For consumers:
* newIssues: retrieve only new issues after the route is started
* newComments: retrieve only new comments after the route is started
+* watchUpdates: retrieve only updated fields/issues based on provided jql
For producers:
@@ -108,11 +109,11 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *type* | *Required* Operation to perform. Consumers: NewIssues, NewComments.
Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue,
Watchers. See this class javadoc description for more information. The value
can be one of: ADDCOMMENT, ADDISSUE, ATTACH, DELETEISSUE, NEWISSUES,
NEWCOMMENTS, UPDATEISSUE, TRANSITIONISSUE, WATCHERS, ADDISSUELINK, ADDWORKLOG,
FETCHISSUE, FETCHCOMMENTS | | JiraType
+| *type* | *Required* Operation to perform. Consumers: NewIssues, NewComments.
Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue,
Watchers. See this class javadoc description for more information. The value
can be one of: ADDCOMMENT, ADDISSUE, ATTACH, DELETEISSUE, NEWISSUES,
NEWCOMMENTS, WATCHUPDATES, UPDATEISSUE, TRANSITIONISSUE, WATCHERS,
ADDISSUELINK, ADDWORKLOG, FETCHISSUE, FETCHCOMMENTS | | JiraType
|===
-=== Query Parameters (16 parameters):
+=== Query Parameters (18 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -123,6 +124,8 @@ with the following path and query parameters:
| *bridgeErrorHandler* (consumer) | 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 message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
| *jql* (consumer) | JQL is the query language from JIRA which allows you to
retrieve the data you want. For example jql=project=MyProject Where MyProject
is the product key in Jira. It is important to use the RAW() and set the JQL
inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND
resolution = Unresolved) | | String
| *maxResults* (consumer) | Max number of issues to search for | 50 | Integer
+| *sendOnlyUpdatedField* (consumer) | Indicator for sending only changed
fields in exchange body or issue object. By default consumer sends only changed
fields. | true | boolean
+| *watchedFields* (consumer) | Comma separated list of fields to watch for
changes. Status,Priority are the defaults. | Status,Priority | String
| *exceptionHandler* (consumer) | 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 consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
| *lazyStartProducer* (producer) | 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
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
@@ -269,5 +272,15 @@ Required:
* `IssueWatchersAdd`: A list of strings with the usernames to add to the
watcher list.
* `IssueWatchersRemove`: A list of strings with the usernames to remove from
the watcher list.
+== WatchUpdates (consumer)
+* `watchedFields` Comma separated list of fields to watch for changes i.e
`Status,Priority,Assignee,Components` etc.
+* `sendOnlyUpdatedField` By default only changed field is send as the body.
+
+All messages also contain following headers that add additional info about the
change:
+
+* `issueKey`: Key of the updated issue
+* `changed`: name of the updated field (i.e Status)
+* `watchedIssues`: list of all issue keys that are watched in the time of
update
+
include::camel-spring-boot::page$jira-starter.adoc[]
