openstack/vitrage
Code Issues Proposed changes

Merge "fix api doc"

Browse Source
This commit is contained in:
Zuul 2017-11-28 03:58:14 +00:00 committed by Gerrit Code Review
commit 1ea07a9014
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/contributor/vitrage-api.rst
View File

@ -137,6 +137,8 @@ Consists of a topology request definition which has the following properties:
* query - (string, optional) a json query filter to filter the graph components. defaults to return all the graph * query - (string, optional) a json query filter to filter the graph components. defaults to return all the graph
* all_tenants - (boolean, optional) shows the entities of all the tenants in the graph (in case the user has the permissions). * all_tenants - (boolean, optional) shows the entities of all the tenants in the graph (in case the user has the permissions).
**Note that parameter graph_type=graph with depth parameter requires root parameter**
query expression query expression
================ ================
:: ::
@ -161,34 +163,33 @@ Query example
X-Auth-Token: 2b8882ba2ec44295bf300aecb2caa4f7 X-Auth-Token: 2b8882ba2ec44295bf300aecb2caa4f7
{ {
"query" : "query" :"
{ {
"or": [ \"or\": [
{ {
"==": { \"==\": {
"vitrage_type": "host" \"vitrage_type\": \"nova.host\"
} }
}, },
{ {
"==": { \"==\": {
"vitrage_type": "instance" \"vitrage_type\": \"nova.instance\"
} }
}, },
{ {
"==": { \"==\": {
"vitrage_type": "zone" \"vitrage_type\": \"nova.zone\"
} }
}, },
{ {
"==": { \"==\": {
"vitrage_type": "node" \"vitrage_type\": \"openstack.cluster\"
} }
} }
] ]
}, }",
"graph_type" : "tree", "graph_type" : "tree"
"depth" : 4
} }
Response Status Code Response Status Code