Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
FALCON-2036 Update twiki on entity list operation with up-to-date RES…
…T API path

1. Mark entity type as optional.
2. Reorganize the order of examples.

Author: yzheng-hortonworks <yzheng@hortonworks.com>

Reviewers: @pallavi-rao,@bvellanki

Closes #190 from yzheng-hortonworks/FALCON-2036

(cherry picked from commit dca46a9)
Signed-off-by: Pallavi Rao <pallavi.rao@inmobi.com>
  • Loading branch information
yzheng-hortonworks authored and Pallavi Rao committed Jun 21, 2016
1 parent b67dd53 commit 81ae46de1c63da80498854bb1eb4a5d10ec806db
Showing 2 changed files with 23 additions and 23 deletions.
@@ -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,49 +38,49 @@ 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"
}
]
}
</verbatim>

---+++ 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"
}
]
}
@@ -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 |

0 comments on commit 81ae46d

Please sign in to comment.