Repository: falcon Updated Branches: refs/heads/master 5c142ef16 -> 7421c7756
FALCON-1445 Docfix for api/instance/dependencies endpoint. Contributed by Raghav Kumar Gautam. Project: http://git-wip-us.apache.org/repos/asf/falcon/repo Commit: http://git-wip-us.apache.org/repos/asf/falcon/commit/7421c775 Tree: http://git-wip-us.apache.org/repos/asf/falcon/tree/7421c775 Diff: http://git-wip-us.apache.org/repos/asf/falcon/diff/7421c775 Branch: refs/heads/master Commit: 7421c775679a39e69b704d29f49a0e21c3ff54a3 Parents: 5c142ef Author: Ajay Yadava <[email protected]> Authored: Mon Sep 14 03:10:00 2015 +0530 Committer: Ajay Yadava <[email protected]> Committed: Mon Sep 14 03:10:18 2015 +0530 ---------------------------------------------------------------------- CHANGES.txt | 2 + .../twiki/restapi/InstanceDependencies.twiki | 49 ++++++++++++++++++++ .../site/twiki/restapi/InstanceDependency.twiki | 49 -------------------- docs/src/site/twiki/restapi/ResourceList.twiki | 2 +- 4 files changed, 52 insertions(+), 50 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/falcon/blob/7421c775/CHANGES.txt ---------------------------------------------------------------------- diff --git a/CHANGES.txt b/CHANGES.txt index 771a36b..5f60fb1 100755 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -18,6 +18,8 @@ Trunk (Unreleased) OPTIMIZATIONS BUG FIXES + FALCON-1445 Docfix for api/instance/dependencies endpoint(Raghav Kumar Gautam via Ajay Yadava) + FALCON-1381 The webservice response of Falcon includes a stack trace in case of errors(Narayan Periwal via Ajay Yadava) FALCON-1438 Falcon RestAPI - In case of error falcon responds with FalconWebException::null(Balu Vellanki via Ajay Yadava). http://git-wip-us.apache.org/repos/asf/falcon/blob/7421c775/docs/src/site/twiki/restapi/InstanceDependencies.twiki ---------------------------------------------------------------------- diff --git a/docs/src/site/twiki/restapi/InstanceDependencies.twiki b/docs/src/site/twiki/restapi/InstanceDependencies.twiki new file mode 100644 index 0000000..5641757 --- /dev/null +++ b/docs/src/site/twiki/restapi/InstanceDependencies.twiki @@ -0,0 +1,49 @@ +---++ GET /api/instance/dependencies/: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 dependent instances for a particular instance. + +---++ Parameters + * :entity-type Valid options are feed or process. + * :entity-name Name of the entity + * instanceTime <mandatory param> time of the given instance + * colo <optional param> name of the colo + + +---++ Results +Dependent instances for the specified instance + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/dependencies/feed/myFeed?colo=*&instanceTime=2012-04-03T07:00Z +</verbatim> +---+++ Result +<verbatim> +{ + 'status': 'SUCCEEDED', + 'message': 'default/Success!\n', + 'dependencies': [ + { + 'cluster': 'local', + 'entityName': 'consumer-process', + 'entityType': 'PROCESS', + 'instanceTime': '2014-12-18T00:00Z', + 'tags': 'Input' + }, + { + 'cluster': 'local', + 'entityName': 'producer-process', + 'entityType': 'PROCESS', + 'instanceTime': '2014-12-18T00:00Z', + 'tags': 'Output' + } + ], + 'requestId': 'default/1405883107@qtp-1501726962-6-0c2e690f-546b-47b0-a5ee-0365d4522a31\n' +} +</verbatim> + http://git-wip-us.apache.org/repos/asf/falcon/blob/7421c775/docs/src/site/twiki/restapi/InstanceDependency.twiki ---------------------------------------------------------------------- diff --git a/docs/src/site/twiki/restapi/InstanceDependency.twiki b/docs/src/site/twiki/restapi/InstanceDependency.twiki deleted file mode 100644 index dc452de..0000000 --- a/docs/src/site/twiki/restapi/InstanceDependency.twiki +++ /dev/null @@ -1,49 +0,0 @@ ----++ GET /api/instance/dependency/: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 dependent instances for a particular instance. - ----++ Parameters - * :entity-type Valid options are feed or process. - * :entity-name Name of the entity - * instanceTime <mandatory param> time of the given instance - * colo <optional param> name of the colo - - ----++ Results -Dependent instances for the specified instance - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/instance/dependency/feed/myFeed?colo=*&instanceTime=2012-04-03T07:00Z -</verbatim> ----+++ Result -<verbatim> -{ - 'status': 'SUCCEEDED', - 'message': 'default/Success!\n', - 'dependencies': [ - { - 'cluster': 'local', - 'entityName': 'consumer-process', - 'entityType': 'PROCESS', - 'instanceTime': '2014-12-18T00:00Z', - 'tags': 'Input' - }, - { - 'cluster': 'local', - 'entityName': 'producer-process', - 'entityType': 'PROCESS', - 'instanceTime': '2014-12-18T00:00Z', - 'tags': 'Output' - } - ], - 'requestId': 'default/1405883107@qtp-1501726962-6-0c2e690f-546b-47b0-a5ee-0365d4522a31\n' -} -</verbatim> - http://git-wip-us.apache.org/repos/asf/falcon/blob/7421c775/docs/src/site/twiki/restapi/ResourceList.twiki ---------------------------------------------------------------------- diff --git a/docs/src/site/twiki/restapi/ResourceList.twiki b/docs/src/site/twiki/restapi/ResourceList.twiki index 0094c39..8dc4a49 100644 --- a/docs/src/site/twiki/restapi/ResourceList.twiki +++ b/docs/src/site/twiki/restapi/ResourceList.twiki @@ -68,7 +68,7 @@ See also: [[../Security.twiki][Security in Falcon]] | GET | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]] | Get logs of a given instance | | GET | [[Triage][api/instance/triage/:entity-type/:entity-name]] | Triage an instance to see it's stuck lineage | | GET | [[InstanceSummary][api/instance/summary/:entity-type/:entity-name]] | Return summary of instances for an entity | -| GET | [[InstanceDependency][api/instance/dependency/:entity-type/:entity-name]] | Return dependent instances for a given instance | +| GET | [[InstanceDependency][api/instance/dependencies/:entity-type/:entity-name]] | Return dependent instances for a given instance | ---++ REST Call on Metadata Lineage Resource
