You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2019/06/15 22:25:22 UTC

[camel] branch master updated: Enhance documentation for twitter search of multiple words https://issues.apache.org/jira/browse/CAMEL-13649

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 3680397  Enhance documentation for twitter search of multiple words https://issues.apache.org/jira/browse/CAMEL-13649
     new cf11bea  Merge pull request #2978 from claudio4j/twitter_search_fix
3680397 is described below

commit 368039731f6d003dfe1a24c720ec6f7d2e74a404
Author: Claudio Miranda <cl...@claudius.com.br>
AuthorDate: Fri Jun 14 16:50:35 2019 -0300

    Enhance documentation for twitter search of multiple words
    https://issues.apache.org/jira/browse/CAMEL-13649
---
 .../camel-twitter/src/main/docs/twitter-search-component.adoc    | 9 +++++++++
 .../camel/component/twitter/search/TwitterSearchEndpoint.java    | 2 +-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/components/camel-twitter/src/main/docs/twitter-search-component.adoc b/components/camel-twitter/src/main/docs/twitter-search-component.adoc
index 0f04f01..bea686d 100644
--- a/components/camel-twitter/src/main/docs/twitter-search-component.adoc
+++ b/components/camel-twitter/src/main/docs/twitter-search-component.adoc
@@ -31,6 +31,15 @@ The Twitter Search component supports 10 options, which are listed below.
 
 ### Endpoint Options
 
+The search keywords query should be specified accordingly to https://developer.twitter.com/en/docs/tweets/search/guides/standard-operators[twitter search operators].
+
+Examples of a search query:
+
+* `foo OR bar`
+* `(orange juice) AND price`
+* `camel -saara`
+
+
 // endpoint options: START
 The Twitter Search endpoint is configured using URI syntax:
 
diff --git a/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/search/TwitterSearchEndpoint.java b/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/search/TwitterSearchEndpoint.java
index 9726792..a172cc5 100644
--- a/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/search/TwitterSearchEndpoint.java
+++ b/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/search/TwitterSearchEndpoint.java
@@ -33,7 +33,7 @@ import org.apache.camel.spi.UriPath;
     label = "api,social")
 public class TwitterSearchEndpoint extends AbstractTwitterEndpoint {
 
-    @UriPath(description = "The search keywords. Multiple values can be separated with comma.")
+    @UriPath(description = "The search query, use the keywords AND, OR, - and () to narrow the search results.")
     @Metadata(required = true)
     private String keywords;