Repository: falcon Updated Branches: refs/heads/master d3ebf0b3d -> dca46a916
FALCON-2036 Update twiki on entity list operation with up-to-date REST API path 1. Mark entity type as optional. 2. Reorganize the order of examples. Author: yzheng-hortonworks <[email protected]> Reviewers: @pallavi-rao,@bvellanki Closes #190 from yzheng-hortonworks/FALCON-2036 Project: http://git-wip-us.apache.org/repos/asf/falcon/repo Commit: http://git-wip-us.apache.org/repos/asf/falcon/commit/dca46a91 Tree: http://git-wip-us.apache.org/repos/asf/falcon/tree/dca46a91 Diff: http://git-wip-us.apache.org/repos/asf/falcon/diff/dca46a91 Branch: refs/heads/master Commit: dca46a916fb5dba84c324d2a456dd1248a6176b5 Parents: d3ebf0b Author: yzheng-hortonworks <[email protected]> Authored: Tue Jun 21 10:24:04 2016 +0530 Committer: Pallavi Rao <[email protected]> Committed: Tue Jun 21 10:24:04 2016 +0530 ---------------------------------------------------------------------- docs/src/site/twiki/restapi/EntityList.twiki | 44 ++++++++++----------- docs/src/site/twiki/restapi/ResourceList.twiki | 2 +- 2 files changed, 23 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/falcon/blob/dca46a91/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 2c2a734..a439dc7 100644 --- a/docs/src/site/twiki/restapi/EntityList.twiki +++ b/docs/src/site/twiki/restapi/EntityList.twiki @@ -1,4 +1,4 @@ ----++ GET /api/entities/list/:entity-type?fields=:fields +---++ GET /api/entities/list/{:entity-type} * <a href="#Description">Description</a> * <a href="#Parameters">Parameters</a> * <a href="#Results">Results</a> @@ -8,7 +8,7 @@ Get list of the entities. ---++ Parameters - * :entity-type Comma-separated entity types. Can be empty. Valid entity types are cluster, feed or process. + * :entity-type <optional param> Comma-separated entity types. Valid entity types are cluster, feed or process. * fields <optional param> Fields of entity that the user wants to view, separated by commas. * Valid options are STATUS, TAGS, PIPELINES, CLUSTERS. * nameseq <optional param> Subsequence of entity name. Not case sensitive. @@ -38,20 +38,28 @@ Total number of results and a list of entities. ---++ Examples ---+++ Rest Call <verbatim> -GET http://localhost:15000/api/entities/list/feed +GET http://localhost:15000/api/entities/list </verbatim> ---+++ Result <verbatim> { - "totalResults":"2â, + "totalResults":"4â, "entity": [ { - "name": "SampleOutput", - "type": "feed" + "name" : "SampleCluster1", + "type" : "cluster" + } + { + "name" : "SampleOutput", + "type" : "feed" }, { - "name": "SampleInput", - "type": "feed" + "name" : "SampleInput", + "type" : "feed" + } + { + "name" : "SampleProcess1", + "type" : "process" } ] } @@ -59,28 +67,20 @@ GET http://localhost:15000/api/entities/list/feed ---+++ Rest Call <verbatim> -GET http://localhost:15000/api/entities/list +GET http://localhost:15000/api/entities/list/feed </verbatim> ---+++ Result <verbatim> { - "totalResults":"4â, + "totalResults":"2â, "entity": [ { - "name" : "SampleCluster1", - "type" : "cluster" - } - { - "name" : "SampleOutput", - "type" : "feed" + "name": "SampleOutput", + "type": "feed" }, { - "name" : "SampleInput", - "type" : "feed" - } - { - "name" : "SampleProcess1", - "type" : "process" + "name": "SampleInput", + "type": "feed" } ] } http://git-wip-us.apache.org/repos/asf/falcon/blob/dca46a91/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 aadd14f..5a4c253 100644 --- a/docs/src/site/twiki/restapi/ResourceList.twiki +++ b/docs/src/site/twiki/restapi/ResourceList.twiki @@ -54,7 +54,7 @@ The current version of the rest api's documentation is also hosted on the Falcon | 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 | [[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 | | GET | [[FeedSLA][api/entities/sla-alert/:entity-type]] | Get pending feed instances which missed sla |
