From 9e8b16f0f8e30ac57cbd834b8ac29957fe88b42f Mon Sep 17 00:00:00 2001 From: Eyal Date: Sun, 26 Nov 2017 14:44:55 +0200 Subject: [PATCH] fix api doc Change-Id: Ic7f17039e4037cca3a8f9b28aa8ec6faa7224291 --- doc/source/contributor/vitrage-api.rst | 27 +++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/source/contributor/vitrage-api.rst b/doc/source/contributor/vitrage-api.rst index 71da7ba83..8f2e82e36 100755 --- a/doc/source/contributor/vitrage-api.rst +++ b/doc/source/contributor/vitrage-api.rst @@ -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 * 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 ================ :: @@ -161,34 +163,33 @@ Query example 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", - "depth" : 4 + }", + "graph_type" : "tree" } Response Status Code