falcon-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From venkat...@apache.org
Subject svn commit: r1643496 [4/4] - in /incubator/falcon/trunk: ./ general/src/site/ releases/ releases/0.6-incubating/ releases/0.6-incubating/src/ releases/0.6-incubating/src/site/ releases/0.6-incubating/src/site/resources/ releases/0.6-incubating/src/site...
Date Sat, 06 Dec 2014 06:08:33 GMT
Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRerun.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRerun.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRerun.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRerun.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,42 @@
+---++  POST /api/instance/rerun/: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
+Rerun 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 is the end 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.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "startTime": "2013-10-21T15:10:47-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n",
+    "message": "default\/RERUN\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceResume.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceResume.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceResume.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceResume.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,41 @@
+---++  POST /api/instance/resume/: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
+Resume suspended 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(s) that you want to refer to
+   * end is the end time of the instance(s) 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.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "startTime": "2013-10-21T15:19:57-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n",
+    "message": "default\/RESUME\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRunning.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRunning.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRunning.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceRunning.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,85 @@
+---++  GET /api/instance/running/: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 a list of instances currently running for a given entity.
+
+---++ Parameters
+   * :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.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "startTime": "2013-10-21T14:39:28-07:00",
+            "cluster": "primary-cluster",
+            "status": "RUNNING",
+            "instance": "2012-04-03T06:00Z"
+        }
+    ],
+    "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n",
+    "message": "default\/Running Instances\n",
+    "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>
+
+

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceStatus.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceStatus.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceStatus.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceStatus.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,97 @@
+---++  GET /api/instance/status/: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 status of a specific instance of an 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
+Status of the specified instance along with job urls for all actions of user workflow and
non-succeeded actions of the main-workflow.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET https://localhost:15443/api/instance/status/process/WordCount?start=2014-11-04T16:00Z&colo=*
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2014-11-05T16:08:10+05:30",
+            "startTime": "2014-11-05T16:07:29+05:30",
+            "cluster": "local",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000011-141105155430303-oozie-oozi-W",
+            "status": "SUCCEEDED",
+            "instance": "2014-11-04T16:00Z",
+            "actions": [
+                {
+                    "action": "wordcount-mr",
+                    "status": "SUCCEEDED",
+                    "logFile": "http:\/\/localhost:50030\/jobdetails.jsp?jobid=job_201411051553_0005"
+                }
+            ]
+        }
+    ],
+    "requestId": "default\/b9fc3cba-1b46-4d1f-8196-52c795ea3580\n",
+    "message": "default\/STATUS\n",
+    "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>

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSummary.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSummary.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSummary.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSummary.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,48 @@
+---++  GET /api/instance/summary/: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 summary of instance/instances of an 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).
+
+---++ Results
+Summary of the instances over the specified time range
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "status":"SUCCEEDED",
+    "message":"default/SUMMARY\n",
+    "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n",
+    "instancesSummary":
+        {
+            "cluster":"local",
+            "map":
+                {
+                    "entry":
+                        {
+                            "key":"SUCCEEDED",
+                            "key2":"value"
+                         }
+                }
+            }
+        }
+}
+</verbatim>

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSuspend.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSuspend.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSuspend.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/InstanceSuspend.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,43 @@
+---++  POST /api/instance/suspend/: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
+Suspend 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(s) that you want to refer to
+   * end is the end time of the instance(s) 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.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T15:15:01-07:00",
+            "startTime": "2013-10-21T15:14:32-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\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n",
+    "message": "default\/SUSPEND\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataList.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataList.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataList.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataList.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,30 @@
+---++  GET api/metadata/discovery/:type/list
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all dimensions of specified type.
+
+---++ Parameters
+   * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo,
tags, groups, pipelines
+   * cluster <optional query param> Show dimensions related to this cluster.
+
+
+---++ Results
+List of dimensions that match requested type [and cluster].
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results": ["sampleIngestProcess","testProcess","anotherProcess"],
+    "totalSize": 3
+}
+</verbatim>
+

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataRelations.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataRelations.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataRelations.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/MetadataRelations.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,45 @@
+---++  GET api/metadata/discovery/:dimension-type/:dimension-name/relations
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all relations of a specific dimension.
+
+---++ Parameters
+   * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo,
tags, groups, pipelines
+   * :name Name of the dimension.
+
+---++ Results
+Get all relations of a specific dimension.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/discovery/process_entity/sample-process/relations
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "timestamp":"2014-09-09T01:31Z",
+    "userWorkflowEngine":"pig",
+    "name":"sample-process",
+    "type":"PROCESS_ENTITY",
+    "userWorkflowName":"imp-click-join-workflow",
+    "version":"1.0.9",
+    "inVertices":[
+        {"name":"clicks-feed","type":"FEED_ENTITY","label":"input"},
+        {"name":"impression-feed","type":"FEED_ENTITY","label":"input"},
+        {"name":"sample-process\/2014-01-01T01:00Z","type":"PROCESS_INSTANCE","label":"instance-of"}
+    ],
+    "outVertices":[
+        {"name":"Critical","type":"TAGS","label":"classified-as"},
+        {"name":"testPipeline","type":"PIPELINES","label":"pipeline"},
+        {"name":"primary-cluster","type":"CLUSTER_ENTITY","label":"runs-on"},
+        {"name":"imp-click-join2","type":"FEED_ENTITY","label":"output"},
+        {"name":"imp-click-join1","type":"FEED_ENTITY","label":"output"},
+        {"name":"falcon-user","type":"USER","label":"owned-by"}
+    ]
+}
+</verbatim>

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/ResourceList.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/ResourceList.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/ResourceList.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/ResourceList.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,85 @@
+---+ 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>
+   * <a href="#REST_Call_on_Metadata_Resource">REST Call on Metadata 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
+
+| *Call Type* | *Resource*                                     | *Description*          
                    |
+| GET         | [[AdminStack][api/admin/stack]]                | Get stack of the server
                    |
+| GET         | [[AdminVersion][api/admin/version]]            | Get version of the server
                  |
+| GET         | [[AdminConfig][api/admin/config/:config-type]] | Get configuration information
of the server |
+
+---++ REST Call on Entity Resource
+
+| *Call Type* | *Resource*                                                              
   | *Description*                      |
+| POST        | [[EntityValidate][api/entities/validate/:entity-type]]                  
   | Validate the entity                |
+| POST        | [[EntitySubmit][api/entities/submit/:entity-type]]                      
   | Submit the entity                  |
+| POST        | [[EntityUpdate][api/entities/update/:entity-type/:entity-name]]         
   | Update the entity                  |
+| POST        | [[EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]]
   | Submit & Schedule the entity       |
+| POST        | [[EntitySchedule][api/entities/schedule/:entity-type/:entity-name]]     
   | Schedule the entity                |
+| POST        | [[EntitySuspend][api/entities/suspend/:entity-type/:entity-name]]       
   | Suspend the entity                 |
+| POST        | [[EntityResume][api/entities/resume/:entity-type/:entity-name]]         
   | Resume the entity                  |
+| 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]]                          
   | 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         | [[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 Metadata Lineage Resource
+
+| *Call Type* | *Resource*                                                              
              | *Description*                                                            
    |
+| GET         | [[Graph][api/metadata/lineage/serialize]]                               
              | dump the graph                                                           
    |
+| GET         | [[AllVertices][api/metadata/lineage/vertices/all]]                      
              | get all vertices                                                         
    |
+| GET         | [[Vertices][api/metadata/lineage/vertices?key=:key&value=:value]]   
                  | get all vertices for a key index                                     
        |
+| GET         | [[Vertex][api/metadata/lineage/vertices/:id]]                           
              | get the vertex with the specified id                                     
    |
+| GET         | [[VertexProperties][api/metadata/lineage/vertices/properties/:id?relationships=:true]]
| get the properties of the vertex with the specified id                        |
+| GET         | [[AdjacentVertices][api/metadata/lineage/vertices/:id/:direction]]      
              | get the adjacent vertices or edges of the vertex with the specified direction
|
+| GET         | [[AllEdges][api/metadata/lineage/edges/all]]                            
              | get all edges                                                            
    |
+| GET         | [[Edge][api/metadata/lineage/edges/:id]]                                
              | get the edge with the specified id                                       
    |
+
+---++ REST Call on Metadata Discovery Resource
+
+| *Call Type* | *Resource*                                                              
                      | *Description*                                                    
            |
+| GET         | [[MetadataList][api/metadata/discovery/:dimension-type/list]]           
                      | list of dimensions  |
+| GET         | [MetadataRelations][api/metadata/discovery/:dimension-type/:dimension-name/relations]]
        | Return all relations of a dimension |

Added: incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertex.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertex.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertex.twiki (added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertex.twiki Sat
Dec  6 06:08:31 2014
@@ -0,0 +1,35 @@
+---++  GET api/metadata/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/metadata/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/releases/0.6-incubating/src/site/twiki/restapi/VertexProperties.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/VertexProperties.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/VertexProperties.twiki
(added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/VertexProperties.twiki
Sat Dec  6 06:08:31 2014
@@ -0,0 +1,33 @@
+---++  GET api/metadata/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/metadata/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/releases/0.6-incubating/src/site/twiki/restapi/Vertices.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertices.twiki?rev=1643496&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertices.twiki (added)
+++ incubator/falcon/trunk/releases/0.6-incubating/src/site/twiki/restapi/Vertices.twiki Sat
Dec  6 06:08:31 2014
@@ -0,0 +1,37 @@
+---++  GET api/metadata/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/metadata/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/releases/pom.xml
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/pom.xml?rev=1643496&r1=1643495&r2=1643496&view=diff
==============================================================================
--- incubator/falcon/trunk/releases/pom.xml (original)
+++ incubator/falcon/trunk/releases/pom.xml Sat Dec  6 06:08:31 2014
@@ -34,6 +34,7 @@
         <module>0.3-incubating</module>
         <module>0.4-incubating</module>
         <module>0.5-incubating</module>
+        <module>0.6-incubating</module>
     </modules>
 
 </project>



Mime
View raw message