falcon-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sowmya...@apache.org
Subject falcon git commit: FALCON-1252 The parameter "tagkey" should be "tagkeys" in EntityList and FalconCLI twiki. Contributed by Ying Zheng
Date Tue, 02 Jun 2015 23:27:02 GMT
Repository: falcon
Updated Branches:
  refs/heads/master 7532a5864 -> 0a8d0cd3d


FALCON-1252 The parameter "tagkey" should be "tagkeys" in EntityList and FalconCLI twiki.
Contributed by Ying Zheng


Project: http://git-wip-us.apache.org/repos/asf/falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/falcon/commit/0a8d0cd3
Tree: http://git-wip-us.apache.org/repos/asf/falcon/tree/0a8d0cd3
Diff: http://git-wip-us.apache.org/repos/asf/falcon/diff/0a8d0cd3

Branch: refs/heads/master
Commit: 0a8d0cd3da06b1d8f0e5b1494b035b84d41e1237
Parents: 7532a58
Author: Sowmya Ramesh <sramesh@hortonworks.com>
Authored: Tue Jun 2 16:26:55 2015 -0700
Committer: Sowmya Ramesh <sramesh@hortonworks.com>
Committed: Tue Jun 2 16:26:55 2015 -0700

----------------------------------------------------------------------
 CHANGES.txt                                  | 3 +++
 docs/src/site/twiki/FalconCLI.twiki          | 2 +-
 docs/src/site/twiki/restapi/EntityList.twiki | 6 +++---
 3 files changed, 7 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/falcon/blob/0a8d0cd3/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 235f5bf..78cc5e4 100755
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -29,6 +29,9 @@ Trunk (Unreleased)
     (Suhas Vasu)
 
   BUG FIXES
+    FALCON-1252 The parameter "tagkey" should be "tagkeys" in EntityList and FalconCLI twiki
+    (Ying Zheng via Sowmya Ramesh)
+
     FALCON-1244 numResults query param in listInstances is ignored when start and end params
are not specified
     (Balu Vellanki via Sowmya Ramesh)
 

http://git-wip-us.apache.org/repos/asf/falcon/blob/0a8d0cd3/docs/src/site/twiki/FalconCLI.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/FalconCLI.twiki b/docs/src/site/twiki/FalconCLI.twiki
index 3b428f3..e447915 100644
--- a/docs/src/site/twiki/FalconCLI.twiki
+++ b/docs/src/site/twiki/FalconCLI.twiki
@@ -53,7 +53,7 @@ $FALCON_HOME/bin/falcon entity -list
 
 Optional Args : -fields <<field1,field2>>
 -type <<[cluster|feed|process],[cluster|feed|process]>>
--nameseq <<namesubsequence>> -tagkey <<tagkeyword1,tagkeyword2>>
+-nameseq <<namesubsequence>> -tagkeys <<tagkeyword1,tagkeyword2>>
 -filterBy <<field1:value1,field2:value2>> -tags <<tagkey=tagvalue,tagkey=tagvalue>>
 -orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults
10
 

http://git-wip-us.apache.org/repos/asf/falcon/blob/0a8d0cd3/docs/src/site/twiki/restapi/EntityList.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityList.twiki b/docs/src/site/twiki/restapi/EntityList.twiki
index 8957fda..00046e2 100644
--- a/docs/src/site/twiki/restapi/EntityList.twiki
+++ b/docs/src/site/twiki/restapi/EntityList.twiki
@@ -15,7 +15,7 @@ Get list of the entities.
       * The entity name needs to contain all the characters in the subsequence in the same
order.
       * Example 1: "sample1" will match the entity named "SampleFeed1-2".
       * Example 2: "mhs" will match the entity named "New-My-Hourly-Summary".
-   * tagkey <optional param> Keywords in tags, separated by comma. Not case sensitive.
+   * tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive.
       * The returned entities will have tags that match all the tag keywords.
    * filterBy <optional param> Filter results by list of field:value pairs. Example:
filterBy=STATUS:RUNNING,PIPELINES:clickLogs
       * Supported filter fields are NAME, STATUS, PIPELINES, CLUSTER.
@@ -28,7 +28,7 @@ Get list of the entities.
    * offset <optional param> Show results from the offset, used for pagination. Defaults
to 0.
    * numResults <optional param> Number of results to show per request, used for pagination.
Only integers > 0 are valid, Default is 10.
    * Note:
-      * We have two filtering parameters for entity tags: "tags" and "tagkey". "tags" does
the exact match in key=value fashion, while "tagkey" finds all the entities with the given
key as a substring in the tags. This "tagkey" filter is introduced for the user who doesn't
remember the exact tag but some keywords in the tag. It also helps users to save the time
of typing long tags.
+      * We have two filtering parameters for entity tags: "tags" and "tagkeys". "tags" does
the exact match in key=value fashion, while "tagkeys" finds all the entities with the given
key as a substring in the tags. This "tagkeys" filter is introduced for the user who doesn't
remember the exact tag but some keywords in the tag. It also helps users to save the time
of typing long tags.
       * The returned entities will match all the filtering criteria.
 
 ---++ Results
@@ -137,7 +137,7 @@ GET http://localhost:15000/api/entities/list/process?filterBy=STATUS:RUNNING,PIP
 
 ---+++ Rest Call
 <verbatim>
-GET http://localhost:15000/api/entities/list/feed,process?nameseq=samplebill&tagkey=billing,healthcare&numResults=2&offset=1&fields=status,clusters,tags
+GET http://localhost:15000/api/entities/list/feed,process?nameseq=samplebill&tagkeys=billing,healthcare&numResults=2&offset=1&fields=status,clusters,tags
 </verbatim>
 ---+++ Result
 <verbatim>


Mime
View raw message