falcon-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From srik...@apache.org
Subject svn commit: r1624488 [7/7] - in /incubator/falcon: site/ site/0.3-incubating/ site/0.4-incubating/ site/docs/ site/docs/restapi/ trunk/ trunk/general/src/site/twiki/docs/ trunk/general/src/site/twiki/docs/restapi/
Date Fri, 12 Sep 2014 09:43:51 GMT
Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki (added)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki Fri Sep
12 09:43:48 2014
@@ -0,0 +1,89 @@
+---++  GET /api/instance/list/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get list of all instances of a given entity.
+
+---++ Parameters
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * Default is set to now.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default)
and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs. Example:
filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+      * Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.
+      * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+      * Supports ordering by  "status","startTime","endTime","cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   * 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.
+   
+---++ Results
+List of instances of given entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:40:26-07:00",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:40:26-07:00",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T07:00Z"
+        },
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:42:26-07:00",
+            "startTime": "2013-10-21T14:41:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T08:00Z"
+        },
+    ],
+
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki Fri Sep
12 09:43:48 2014
@@ -8,10 +8,23 @@
 Get log of a specific instance of an entity.
 
 ---++ Parameters
-   * :entity-type can either be a feed or a process.
-   * :entity-name is name of the entity.
-   * start is the start time of the instance that you want to refer to
-   * end <optional param> is the end time of the instance that you want to refer to
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * Default is set to now.
+   * colo <optional param> Colo on which the query should be run.
+   * runId <optional param> Run Id.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default)
and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs. Example:
filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+      * Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.
+      * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+      * Supports ordering by "status","startTime","endTime","cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   * 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.
 
 ---++ Results
 Log of specified instance.
@@ -20,7 +33,6 @@ Log of specified instance.
 ---+++ Rest Call
 <verbatim>
 GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
 </verbatim>
 ---+++ Result
 <verbatim>
@@ -48,3 +60,53 @@ Remote-User: rgautam
     "status": "SUCCEEDED"
 }
 </verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "actions": [
+                {
+                    "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log",
+                    "status": "SUCCEEDED",
+                    "action": "pig"
+                }
+            ],
+            "details": "",
+            "endTime": "2013-10-21T14:40:26-07:00",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T07:00Z"
+        },
+        {
+            "actions": [
+                {
+                    "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/001\/pig_SUCCEEDED.log",
+                    "status": "SUCCEEDED",
+                    "action": "pig"
+                }
+            ],
+            "details": "",
+            "endTime": "2013-10-21T14:42:27-07:00",
+            "startTime": "2013-10-21T14:41:57-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/001\/oozie.log",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T08:00Z"
+        }
+    ],
+    "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+
+
+

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki Fri Sep
12 09:43:48 2014
@@ -11,6 +11,7 @@ Rerun a specific instance of an entity.
    * :entity-type can either be a feed or a process.
    * :entity-name is name of the entity.
    * start is the start time of the instance that you want to refer to
+   * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default)
for process.
 
 ---++ Results
 Results of the rerun command.
@@ -19,7 +20,6 @@ Results of the rerun command.
 ---+++ Rest Call
 <verbatim>
 POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
 </verbatim>
 ---+++ Result
 <verbatim>

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki Fri Sep
12 09:43:48 2014
@@ -11,7 +11,7 @@ Resume a specific instance of an entity.
    * :entity-type can either be a feed or a process.
    * :entity-name is name of the entity.
    * start is the start time of the instance that you want to refer to
-
+   * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default)
for process.
 ---++ Results
 Results of the resume command.
 
@@ -19,7 +19,6 @@ Results of the resume command.
 ---+++ Rest Call
 <verbatim>
 POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
 </verbatim>
 ---+++ Result
 <verbatim>

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki Fri Sep
12 09:43:48 2014
@@ -8,8 +8,19 @@
 Get a list of instances currently running for a given entity.
 
 ---++ Parameters
-   * :entity-type can either be a feed or a process.
-   * :entity-name is name of the entity.
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default)
and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs. Example:
filterBy=CLUSTER:primary-cluster
+      * Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER.
+      * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+      * Supports ordering by "status","startTime","endTime","cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   * 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.
+
 
 ---++ Results
 List of instances currently running.
@@ -18,7 +29,6 @@ List of instances currently running.
 ---+++ Rest Call
 <verbatim>
 GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
-Remote-User: rgautam
 </verbatim>
 ---+++ Result
 <verbatim>
@@ -36,3 +46,40 @@ Remote-User: rgautam
     "status": "SUCCEEDED"
 }
 </verbatim>
+
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:40:26-07:00",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T07:00Z"
+        },
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:42:27-07:00",
+            "startTime": "2013-10-21T14:41:57-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T08:00Z"
+        },
+    ],
+
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+
+

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki Fri Sep
12 09:43:48 2014
@@ -8,11 +8,24 @@
 Get status of a specific instance of an entity.
 
 ---++ Parameters
-   * :entity-type can either be a feed or a process.
-   * :entity-name is name of the entity.
-   * start is the start time of the instance that you want to refer to
-   * end <optional param> is the end time of the instance that you want to refer to
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * Default is set to now.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default)
and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs. Example:
filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+      * Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.
+      * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+      * Supports ordering by "status","startTime","endTime","cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   * 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.
 
+   
 ---++ Results
 Status of the specified instance.
 
@@ -20,7 +33,6 @@ Status of the specified instance.
 ---+++ Rest Call
 <verbatim>
 GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
 </verbatim>
 ---+++ Result
 <verbatim>
@@ -41,3 +53,38 @@ Remote-User: rgautam
     "status": "SUCCEEDED"
 }
 </verbatim>
+
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:40:26-07:00",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T07:00Z"
+        },
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:42:26-07:00",
+            "startTime": "2013-10-21T14:41:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T08:00Z"
+        },
+    ],
+
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki Fri Sep
12 09:43:48 2014
@@ -8,10 +8,14 @@
 Get summary of instance/instances of an entity.
 
 ---++ Parameters
-   * :entity-type can either be a feed or a process.
-   * :entity-name is name of the entity.
-   * start is the start time of the instance that you want to refer to
-   * end <optional param> is the end time of the instance that you want to refer to
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * Default is set to now.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default)
and for process is Execution(default).
 
 ---++ Results
 Summary of the instances over the specified time range
@@ -20,7 +24,6 @@ Summary of the instances over the specif
 ---+++ Rest Call
 <verbatim>
 GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
-Remote-User: suhas
 </verbatim>
 ---+++ Result
 <verbatim>
@@ -36,7 +39,7 @@ Remote-User: suhas
                     "entry":
                         {
                             "key":"SUCCEEDED",
-                            "value":"3"
+                            "key2":"value"
                          }
                 }
             }

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki Fri Sep
12 09:43:48 2014
@@ -11,6 +11,7 @@ Suspend a specific instance of an entity
    * :entity-type can either be a feed or a process.
    * :entity-name is name of the entity.
    * start is the start time of the instance that you want to refer to
+   * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default)
for process.
 
 ---++ Results
 Results of the suspend command.
@@ -19,7 +20,6 @@ Results of the suspend command.
 ---+++ Rest Call
 <verbatim>
 POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
 </verbatim>
 ---+++ Result
 <verbatim>

Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki Fri Sep
12 09:43:48 2014
@@ -1,7 +1,32 @@
 ---+ RESTful Resources
+
+---++ Resource List
    * <a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a>
    * <a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a>
    * <a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a>
+   * <a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a>
+
+---++ Authentication
+
+When security is off (Pseudo/Simple), the authenticated user is the username specified in
the user.name query
+parameter. If the user.name parameter is not set, the server may either set the authenticated
user to a default web
+user, if there is any, or return an error response.
+
+When security is on (kerberos), authentication is performed by Kerberos SPNEGO.
+
+Below are examples using the curl command tool.
+
+Authentication when security is off (Pseudo/Simple):
+<verbatim>
+curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..."
+</verbatim>
+
+Authentication using Kerberos SPNEGO when security is on:
+<verbatim>
+curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..."
+</verbatim>
+
+See also: [[../Security.twiki][Security in Falcon]]
 
 ---++ REST Call on Admin Resource
 
@@ -23,17 +48,31 @@
 | DELETE      | [[EntityDelete][api/entities/delete/:entity-type/:entity-name]]         
   | Delete the entity                  |
 | GET         | [[EntityStatus][api/entities/status/:entity-type/:entity-name]]         
   | Get the status of the entity       |
 | GET         | [[EntityDefinition][api/entities/definition/:entity-type/:entity-name]] 
   | Get the definition of the entity   |
-| GET         | [[EntityList][api/entities/list/:entity-type?fields=:fields]]           
   | Get the list of entities           |
+| GET         | [[EntityList][api/entities/list/:entity-type]]                          
   | Get the list of entities           |
+| GET         | [[EntitySummary][api/entities/summary/:entity-type/:cluster]]           
   | Get instance summary of all entities |
 | GET         | [[EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]]
| Get the dependencies of the entity |
 
 ---++ REST Call on Feed and Process Instances
 
-| *Call Type* | *Resource*                                                           | *Description*
               |
-| GET         | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]]  | List
of running instances.   |
-| GET         | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]]]   | Status
of a given instance   |
-| POST        | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]]]       | Kill
a given instance        |
-| POST        | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]]] | Suspend
a running instance   |
-| POST        | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]]]   | Resume
a given instance      |
-| POST        | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]]]     | Rerun
a given instance       |
-| GET         | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]]]       | Get
logs of a given instance |
-
+| *Call Type* | *Resource*                                                              
   | *Description*                |
+| GET         | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]]     
   | List of running instances.   |
+| GET         | [[InstanceList][api/instance/list/:entity-type/:entity-name]]           
   | List of instances   |
+| GET         | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]]       
   | Status of a given instance   |
+| POST        | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]]           
   | Kill a given instance        |
+| POST        | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]]     
   | Suspend a running instance   |
+| POST        | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]]       
   | Resume a given instance      |
+| POST        | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]]         
   | Rerun a given instance       |
+| GET         | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]]           
   | Get logs of a given instance |
+| GET         | [[InstanceSummary][api/instance/summary/:entity-type/:entity-name]]     
   | Return summary of instances for an entity |
+
+---++ REST Call on Lineage Graph
+
+| *Call Type* | *Resource*                                                              
            | *Description*                                                              
  |
+| GET         | [[Graph][api/graphs/lineage/serialize]]                                 
            | dump the graph                                                             
  |
+| GET         | [[AllVertices][api/graphs/lineage/vertices/all]]                        
            | get all vertices                                                           
  |
+| GET         | [[Vertices][api/graphs/lineage/vertices?key=:key&value=:value]]     
                | get all vertices for a key index                                       
      |
+| GET         | [[Vertex][api/graphs/lineage/vertices/:id]]                             
            | get the vertex with the specified id                                       
  |
+| GET         | [[VertexProperties][api/graphs/lineage/vertices/properties/:id?relationships=:true]]
| get the properties of the vertex with the specified id                        |
+| GET         | [[AdjacentVertices][api/graphs/lineage/vertices/:id/:direction]]        
            | get the adjacent vertices or edges of the vertex with the specified direction
|
+| GET         | [[AllEdges][api/graphs/lineage//edges/all]]                             
            | get all edges                                                              
  |
+| GET         | [[Edge][api/graphs/lineage/edges/:id]]                                  
            | get the edge with the specified id                                         
  |

Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki (added)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki Fri Sep 12 09:43:48
2014
@@ -0,0 +1,35 @@
+---++  GET api/graphs/lineage/vertices/:id
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Gets the vertex with specified id.
+
+---++ Parameters
+   * :id is the unique id of the vertex.
+
+---++ Results
+Vertex with the specified id.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/graphs/lineage/vertices/4
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results": [
+        {
+            "timestamp":"2014-04-21T20:55Z",
+            "name":"sampleIngestProcess",
+            "type":"process-instance",
+            "version":"2.0.0",
+            "_id":4,
+            "_type":"vertex"
+        }
+    ]
+}
+</verbatim>

Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki (added)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki Fri
Sep 12 09:43:48 2014
@@ -0,0 +1,33 @@
+---++  GET api/graphs/lineage/vertices/properties/:id?relationships=:true
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Gets the properties of the vertex with specified id.
+
+---++ Parameters
+   * :id is the unique id of the vertex.
+   * :relationships has default value of false. Pass true if relationships should be fetched.
+
+---++ Results
+ Properties associated with the specified vertex.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/graphs/lineage/vertices/properties/40004?relationships=true
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results":
+        {
+            "timestamp":"2014-04-25T22:20Z",
+            "name":"local",
+            "type":"cluster-entity"
+        },
+    "totalSize":3
+}
+</verbatim>

Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki (added)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki Fri Sep 12 09:43:48
2014
@@ -0,0 +1,37 @@
+---++  GET api/graphs/lineage/vertices?key=:key&value=:value
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all vertices for a key index given the specified value.
+
+---++ Parameters
+   * :key is the key to be matched.
+   * :value is the associated value of the key.
+
+---++ Results
+All vertices matching given property key and a value.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/graphs/lineage/vertices?key=name&value=sampleIngestProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results": [
+        {
+            "timestamp":"2014-04-21T20:55Z",
+            "name":"sampleIngestProcess",
+            "type":"process-instance",
+            "version":"2.0.0",
+            "_id":4,
+            "_type":"vertex"
+        }
+    ],
+    "totalSize": 1
+}
+</verbatim>

Modified: incubator/falcon/trunk/pom.xml
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/pom.xml?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/pom.xml (original)
+++ incubator/falcon/trunk/pom.xml Fri Sep 12 09:43:48 2014
@@ -215,6 +215,26 @@
             </roles>
             <organization>Talend</organization>
         </developer>
+        <developer>
+            <id>rostafiychuk</id>
+            <name>Ruslan Ostafiychuk</name>
+            <email>rostafiychuk@apache.org</email>
+            <timezone>+03:00</timezone>
+            <roles>
+                <role>committer</role>
+            </roles>
+            <organization>Hortonworks</organization>
+        </developer>
+        <developer>
+            <id>raghav</id>
+            <name>Raghav Kumar Gautam</name>
+            <email>raghav@apache.org</email>
+            <timezone>-08:00</timezone>
+            <roles>
+                <role>committer</role>
+            </roles>
+            <organization>Hortonworks</organization>
+        </developer>
     </developers>
 
     <modules>



Mime
View raw message